doomemacs/modules/lang/swift/README.org

#+title:    :lang swift
#+subtitle: We asked for emoji variables?
#+created:  June 15, 2015
#+since:    0.7

* Description :unfold:
This module adds support for the [[https://developer.apple.com/swift/][Swift programming language]] to Doom Emacs.

** Maintainers
*This module needs a maintainer.* [[doom-contrib-maintainer:][Become a maintainer?]]

** Module flags
- +lsp ::
  Enable LSP support for ~swift-mode~. Requires [[doom-module::tools lsp]] and a langserver
  (supports sourcekit).
- +tree-sitter ::
  Leverages tree-sitter for better syntax highlighting and structural text
  editing. Requires [[doom-module::tools tree-sitter]].

** Packages
- [[doom-package:swift-mode]]
- if [[doom-module:+lsp]]
  - [[doom-package:lsp-sourcekit]]
- else
  - [[doom-package:company-sourcekit]] if [[doom-module::completion company]]
  - [[doom-package:flycheck-sourcekit]] if [[doom-module::checkers syntax]]

** Hacks
/No hacks documented for this module./

** TODO Changelog
# This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./

* TODO Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]

** Formatter

Formatting is handled using the [[doom-module::editor format]] module via [[https://github.com/nicklockwood/SwiftFormat#command-line-tool][swiftformat]].

#+begin_quote
🔨 /This module's prerequisites are not documented./ [[doom-contrib-module:][Document them?]]
#+end_quote

* TODO Usage
#+begin_quote
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote

* TODO Configuration
#+begin_quote
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote

* Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]]

* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]

* TODO Appendix
#+begin_quote
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote
docs: use lowercase keywords As per Org's new defaults, which we're adopting elsewhere, so may as well adopt it here. 2022-03-28 15:03:21 +02:00			`#+title: :lang swift`
			`#+subtitle: We asked for emoji variables?`
			`#+created: June 15, 2015`
			`#+since: 0.7`
docs(:lang): update READMEs to new format 2021-10-16 01:28:32 +02:00
			`* Description :unfold:`
			`This module adds support for the [[https://developer.apple.com/swift/][Swift programming language]] to Doom Emacs.`

			`** Maintainers`
			`This module needs a maintainer. [[doom-contrib-maintainer:][Become a maintainer?]]`

			`** Module flags`
			`- +lsp ::`
docs: change link format 2022-09-26 02:19:42 +08:00			`Enable LSP support for ~swift-mode~. Requires [[doom-module::tools lsp]] and a langserver`
docs(:lang): update READMEs to new format 2021-10-16 01:28:32 +02:00			`(supports sourcekit).`
docs(tree-sitter): document +tree-sitter flag in :lang readmes Co-authored-by: Jeetaditya Chatterjee <jeetelongname@gmail.com> 2022-04-09 18:38:04 +03:00			`- +tree-sitter ::`
			`Leverages tree-sitter for better syntax highlighting and structural text`
docs: change link format 2022-09-26 02:19:42 +08:00			`editing. Requires [[doom-module::tools tree-sitter]].`
docs(:lang): update READMEs to new format 2021-10-16 01:28:32 +02:00
			`** Packages`
docs: change link format 2022-09-26 02:19:42 +08:00			`- [[doom-package:swift-mode]]`
			`- if [[doom-module:+lsp]]`
			`- [[doom-package:lsp-sourcekit]]`
docs(:lang): update READMEs to new format 2021-10-16 01:28:32 +02:00			`- else`
docs: change link format 2022-09-26 02:19:42 +08:00			`- [[doom-package:company-sourcekit]] if [[doom-module::completion company]]`
			`- [[doom-package:flycheck-sourcekit]] if [[doom-module::checkers syntax]]`
docs(:lang): update READMEs to new format 2021-10-16 01:28:32 +02:00
			`** Hacks`
			`/No hacks documented for this module./`

			`** TODO Changelog`
			`# This section will be machine generated. Don't edit it by hand.`
			`/This module does not have a changelog yet./`

			`* TODO Installation`
			`[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]`

docs(swift): add formatter docs 2022-11-19 15:21:08 +00:00			`** Formatter`

			`Formatting is handled using the [[doom-module::editor format]] module via [[https://github.com/nicklockwood/SwiftFormat#command-line-tool][swiftformat]].`

docs(:lang): update READMEs to new format 2021-10-16 01:28:32 +02:00			`#+begin_quote`
			`🔨 /This module's prerequisites are not documented./ [[doom-contrib-module:][Document them?]]`
			`#+end_quote`

			`* TODO Usage`
			`#+begin_quote`
			`🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]`
			`#+end_quote`

			`* TODO Configuration`
			`#+begin_quote`
			`🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]`
			`#+end_quote`

			`* Troubleshooting`
			`/There are no known problems with this module./ [[doom-report:][Report one?]]`

			`* Frequently asked questions`
			`/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]`

			`* TODO Appendix`
			`#+begin_quote`
			`🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]`
			`#+end_quote`