spacemacs/layers/+lang/swift/README.org

#+TITLE: Swift layer

#+TAGS: general|layer|multi-paradigm|programming

[[file:img/swift.png]]

* Table of Contents                     :TOC_5_gh:noexport:
- [[#description][Description]]
  - [[#features][Features:]]
- [[#install][Install]]
- [[#usage-information][Usage information]]
- [[#key-bindings][Key bindings]]
  - [[#swift-mode][swift-mode]]
  - [[#swift-repl-mode][swift-repl-mode]]

* Description
This layer adds support for Apple's Swift programming language, used as a
general purpose scripting language.

** Features:
- Syntax highlighting with [[https://github.com/swift-emacs/swift-mode][swift-mode]]
- Indentation
- Code navigation using =imenu= (built-in)
- Automatic syntax checking with =flycheck= (available with the
 =syntax-checking= layer)

* Install
First check that you are able to run this from the command line:

On OS X:

#+BEGIN_SRC sh
  xcrun swift
#+END_SRC

Then to use this configuration layer, add it to your =~/.spacemacs=. You will
need to add =swift= to the existing =dotspacemacs-configuration-layers= list in
this file.

* Usage information
Unless configured by the user, the REPL will be invoked using the command =xcrun
swift=.
You can launch the REPL using the key binding ~SPC m s s~ (or ~C-c C-z~).
The universal prefix ~SPC u~ (~C-u~) may be used to modify command invocation.

* Key bindings
** swift-mode

| Key bindings | Description            |
|--------------+------------------------|
| ~SPC m s s~  | swift-mode-run-repl    |
| ~SPC m s b~  | swift-mode-send-buffer |
| ~SPC m s r~  | swift-mode-send-region |

Notes:
1. =swift-mode-run-repl= will run or switch to an existing REPL.
2. To edit the command invocation, prefix with ~SPC u~ (or ~C-u~).
3. Emacs key bindings in use are the those set by the package.

** swift-repl-mode

| Key bindings | Description                 |
|--------------+-----------------------------|
| ~SPC m s s~  | swift-repl-mode-switch-back |
Update layer REAMDE title for swift and elfeed 2015-12-04 04:51:31 +00:00			`#+TITLE: Swift layer`
Swift support initial import 2015-10-19 11:17:24 +00:00
layers: lang: new structure: general: add pure, multi-paradigm (&js) 2019-05-07 08:53:56 +00:00			`#+TAGS: general\|layer\|multi-paradigm\|programming`
Add placeholder tags 2019-05-05 17:26:40 +00:00
Swift support initial import 2015-10-19 11:17:24 +00:00			`[[file:img/swift.png]]`

Switch to the new layers generator 2019-05-07 20:05:06 +00:00			`* Table of Contents :TOC_5_gh:noexport:`
update docs to the new toc-org format 2017-05-22 14:16:12 +00:00			`- [[#description][Description]]`
Fix documentation issues with ruby, rails, and swift layers See #9476 2017-08-31 16:25:47 +00:00			`- [[#features][Features:]]`
update docs to the new toc-org format 2017-05-22 14:16:12 +00:00			`- [[#install][Install]]`
			`- [[#usage-information][Usage information]]`
			`- [[#key-bindings][Key bindings]]`
			`- [[#swift-mode][swift-mode]]`
			`- [[#swift-repl-mode][swift-repl-mode]]`
Swift support initial import 2015-10-19 11:17:24 +00:00
			`* Description`
documentation formatting: Sun May 26 20:58:52 UTC 2019 2019-05-26 20:58:52 +00:00			`This layer adds support for Apple's Swift programming language, used as a`
Swift support initial import 2015-10-19 11:17:24 +00:00			`general purpose scripting language.`

Fix documentation issues with ruby, rails, and swift layers See #9476 2017-08-31 16:25:47 +00:00			`** Features:`
Reformat documentation 2018-09-19 03:54:47 +00:00			`- Syntax highlighting with [[https://github.com/swift-emacs/swift-mode][swift-mode]]`
			`- Indentation`
			`- Code navigation using =imenu= (built-in)`
			`- Automatic syntax checking with =flycheck= (available with the`
			`=syntax-checking= layer)`
Swift support initial import 2015-10-19 11:17:24 +00:00
			`* Install`
Update install layer section in REAMDE.org files 2016-01-06 05:21:55 +00:00			`First check that you are able to run this from the command line:`
Swift support initial import 2015-10-19 11:17:24 +00:00
			`On OS X:`
Reformat docs 2018-07-10 10:57:25 +00:00
Swift support initial import 2015-10-19 11:17:24 +00:00			`#+BEGIN_SRC sh`
Format documenation files with doc-fmt tool 2016-04-13 03:31:38 +00:00			`xcrun swift`
Swift support initial import 2015-10-19 11:17:24 +00:00			`#+END_SRC`

Update install layer section in REAMDE.org files 2016-01-06 05:21:55 +00:00			`Then to use this configuration layer, add it to your =~/.spacemacs=. You will`
			`need to add =swift= to the existing =dotspacemacs-configuration-layers= list in`
			`this file.`

Swift support initial import 2015-10-19 11:17:24 +00:00			`* Usage information`
Use proper markup for code in readmes By convention, code markup (`~`) is reserved for keybindings in Org-based documentation in Spacemacs. Verbatim markup (`=`) is reserved for code and other code-like things. So change several readmes to reflect this convention. Use verbatim markup for things like (non-exhaustive list): - Emacs Lisp functions, modes, buffers, etc. - Environment variables - Directory paths - Code in general 2016-11-22 20:53:50 +00:00			`Unless configured by the user, the REPL will be invoked using the command =xcrun`
			`swift=.`
documentation fixes: Tue Oct 23 14:18:21 UTC 2018 2018-10-23 14:18:21 +00:00			`You can launch the REPL using the key binding ~SPC m s s~ (or ~C-c C-z~).`
Swift support initial import 2015-10-19 11:17:24 +00:00			`The universal prefix ~SPC u~ (~C-u~) may be used to modify command invocation.`

			`* Key bindings`
			`** swift-mode`

swift: various fixes Remove Emacs column in README tables Update README headers Use post-init function instead of layer-usedp Clean stand-alone closing parentheses Replace deprecated evil-leader/set-key-for-mode 2015-12-04 04:43:49 +00:00			`\| Key bindings \| Description \|`
			`\|--------------+------------------------\|`
			`\| ~SPC m s s~ \| swift-mode-run-repl \|`
			`\| ~SPC m s b~ \| swift-mode-send-buffer \|`
			`\| ~SPC m s r~ \| swift-mode-send-region \|`
Swift support initial import 2015-10-19 11:17:24 +00:00
Format documenation files with doc-fmt tool 2016-04-13 03:31:38 +00:00			`Notes:`
Use proper markup for code in readmes By convention, code markup (`~`) is reserved for keybindings in Org-based documentation in Spacemacs. Verbatim markup (`=`) is reserved for code and other code-like things. So change several readmes to reflect this convention. Use verbatim markup for things like (non-exhaustive list): - Emacs Lisp functions, modes, buffers, etc. - Environment variables - Directory paths - Code in general 2016-11-22 20:53:50 +00:00			`1. =swift-mode-run-repl= will run or switch to an existing REPL.`
Swift support initial import 2015-10-19 11:17:24 +00:00			`2. To edit the command invocation, prefix with ~SPC u~ (or ~C-u~).`
			`3. Emacs key bindings in use are the those set by the package.`

			`** swift-repl-mode`

swift: various fixes Remove Emacs column in README tables Update README headers Use post-init function instead of layer-usedp Clean stand-alone closing parentheses Replace deprecated evil-leader/set-key-for-mode 2015-12-04 04:43:49 +00:00			`\| Key bindings \| Description \|`
			`\|--------------+-----------------------------\|`
			`\| ~SPC m s s~ \| swift-repl-mode-switch-back \|`