docs: change link format
This commit is contained in:
parent
58fb83c98e
commit
5ac2a5258b
160 changed files with 1161 additions and 1152 deletions
|
@ -15,12 +15,12 @@ exists directly in the agda repository, but not in melpa.
|
|||
Use the =agda-mode= executable that comes with your local =agda= install.
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- unless [[doom-module:][+local]]
|
||||
- [[doom-package:][agda-input]]
|
||||
- [[doom-package:][agda2-mode]]
|
||||
- unless [[doom-module:+local]]
|
||||
- [[doom-package:agda-input]]
|
||||
- [[doom-package:agda2-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -14,15 +14,15 @@ you [[https://plaintextaccounting.org/][manage your money in plain text]].
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~beancount-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~beancount-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports [[https://github.com/polarmutex/beancount-language-server][beancount-language-server]]).
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][beancount]]
|
||||
- [[doom-package:beancount]]
|
||||
|
||||
** Hacks
|
||||
- Associates the material =attach_money= icon with =*.beancount= files in the
|
||||
[[doom-package:][all-the-icons]] package.
|
||||
[[doom-package:all-the-icons]] package.
|
||||
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
|
|
|
@ -21,33 +21,33 @@ This module adds support for the C-family of languages: C, C++, and Objective-C.
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~c-mode~, ~c++-mode~, and ~objc-mode~. Requires [[doom-module:][:tools
|
||||
Enable LSP support for ~c-mode~, ~c++-mode~, and ~objc-mode~. Requires [[doom-module::tools
|
||||
lsp]] and a langserver (supports ccls, clangd, and cquery). Replaces irony &
|
||||
rtags.
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][cmake-mode]]
|
||||
- [[doom-package:][company-glsl]]
|
||||
- [[doom-package:][cuda-mode]]
|
||||
- [[doom-package:][demangle-mode]]
|
||||
- [[doom-package:][disaster]]
|
||||
- [[doom-package:][glsl-mode]]
|
||||
- [[doom-package:][modern-cpp-font-lock]]
|
||||
- [[doom-package:][opencl-mode]]
|
||||
- if [[doom-module:][+lsp]]
|
||||
- [[doom-package:][ccls]] if [[doom-module:][:tools lsp -eglot]]
|
||||
- [[doom-package:cmake-mode]]
|
||||
- [[doom-package:company-glsl]]
|
||||
- [[doom-package:cuda-mode]]
|
||||
- [[doom-package:demangle-mode]]
|
||||
- [[doom-package:disaster]]
|
||||
- [[doom-package:glsl-mode]]
|
||||
- [[doom-package:modern-cpp-font-lock]]
|
||||
- [[doom-package:opencl-mode]]
|
||||
- if [[doom-module:+lsp]]
|
||||
- [[doom-package:ccls]] if [[doom-module::tools lsp -eglot]]
|
||||
- else
|
||||
- [[doom-package:][company-irony]]
|
||||
- [[doom-package:][company-irony-c-headers]]
|
||||
- [[doom-package:][flycheck-irony]]
|
||||
- [[doom-package:][helm-rtags]] if [[doom-module:][:completion helm]]
|
||||
- [[doom-package:][irony]]
|
||||
- [[doom-package:][irony-eldoc]]
|
||||
- [[doom-package:][ivy-rtags]] if [[doom-module:][:completion ivy]]
|
||||
- [[doom-package:][rtags]]
|
||||
- [[doom-package:company-irony]]
|
||||
- [[doom-package:company-irony-c-headers]]
|
||||
- [[doom-package:flycheck-irony]]
|
||||
- [[doom-package:helm-rtags]] if [[doom-module::completion helm]]
|
||||
- [[doom-package:irony]]
|
||||
- [[doom-package:irony-eldoc]]
|
||||
- [[doom-package:ivy-rtags]] if [[doom-module::completion ivy]]
|
||||
- [[doom-package:rtags]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
@ -61,8 +61,8 @@ This module adds support for the C-family of languages: C, C++, and Objective-C.
|
|||
|
||||
This module's requirements change depending on how you use it.
|
||||
|
||||
- If [[doom-module:][+lsp]] is enabled, you need one of *clangd v9+* or *ccls*.
|
||||
- If [[doom-module:][+lsp]] is *not* enabled, you need *irony-server* and *rtags*.
|
||||
- If [[doom-module:+lsp]] is enabled, you need one of *clangd v9+* or *ccls*.
|
||||
- If [[doom-module:+lsp]] is *not* enabled, you need *irony-server* and *rtags*.
|
||||
- Other features in this module depend on:
|
||||
- (optional) glslangValidator, for GLSL completion in ~glsl-mode~
|
||||
- (optional) cmake, for code completion in ~cmake-mode~
|
||||
|
@ -146,7 +146,7 @@ rc -J $PROJECT_ROOT # loads PROJECT_ROOT's compile_commands.json
|
|||
4. Run ~$ doom sync~ on the command line and restart Emacs.
|
||||
|
||||
** Eglot-specific bindings
|
||||
When using [[doom-module:][+lsp]] and [[doom-module:][:tools lsp +eglot]], [[doom-package:][lsp-mode]] is replaced with [[doom-package:][eglot]], and an
|
||||
When using [[doom-module:+lsp]] and [[doom-module::tools lsp +eglot]], [[doom-package:lsp-mode]] is replaced with [[doom-package:eglot]], and an
|
||||
additional function to get inheritance type hierarchy is added:
|
||||
| Binding | Description |
|
||||
|----------------------------+------------------------------------------------|
|
||||
|
@ -219,7 +219,7 @@ Additional info:
|
|||
|
||||
** Configure LSP servers
|
||||
Search for your combination of =(LSP client package, LSP server)=. You are using
|
||||
[[doom-package:][lsp-mode]] by default, [[doom-package:][eglot]] if you have [[doom-module:][:tools lsp +eglot]] active in
|
||||
[[doom-package:lsp-mode]] by default, [[doom-package:eglot]] if you have [[doom-module::tools lsp +eglot]] active in
|
||||
=$DOOMDIR/init.el= file.
|
||||
|
||||
*** LSP-mode with clangd
|
||||
|
|
|
@ -18,13 +18,13 @@ This module adds support for the Clojure(Script) language.
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~clojure-mode~ (alongside Cider). Requires [[doom-module:][:tools lsp]]
|
||||
Enable LSP support for ~clojure-mode~ (alongside Cider). Requires [[doom-module::tools lsp]]
|
||||
and a langserver (supports [[https://clojure-lsp.io/][clojure-lsp]]).
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][cider]]
|
||||
- [[doom-package:][clj-refactor]]
|
||||
- [[doom-package:][flycheck-clj-kondo]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:cider]]
|
||||
- [[doom-package:clj-refactor]]
|
||||
- [[doom-package:flycheck-clj-kondo]] if [[doom-module::checkers syntax]]
|
||||
|
||||
** Hacks
|
||||
- Error messages emitted from CIDER are piped into the REPL buffer when it is
|
||||
|
@ -42,7 +42,7 @@ This module requires:
|
|||
- [[https://clojure.org/][clojure]]
|
||||
- [[https://leiningen.org/][leiningen]], for the REPL
|
||||
- [[https://github.com/borkdude/clj-kondo][clj-kondo]], for linting code
|
||||
- [[https://clojure-lsp.github.io/clojure-lsp/][clojure-lsp]], for LSP support (if [[doom-module:][+lsp]])
|
||||
- [[https://clojure-lsp.github.io/clojure-lsp/][clojure-lsp]], for LSP support (if [[doom-module:+lsp]])
|
||||
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
|
|
|
@ -4,7 +4,7 @@
|
|||
#+since: 21.12.0
|
||||
|
||||
* Description :unfold:
|
||||
This module provides support for [[https://lisp-lang.org/][Common Lisp]] and the [[doom-package:][Sly]] development
|
||||
This module provides support for [[https://lisp-lang.org/][Common Lisp]] and the [[doom-package:Sly]] development
|
||||
environment. Common Lisp is not a single language but a specification, with many
|
||||
competing compiler implementations. By default, [[http://www.sbcl.org/][Steel Bank Common Lisp]] (SBCL) is
|
||||
assumed to be installed, but this can be configured.
|
||||
|
@ -21,9 +21,9 @@ to run unmodified for a long time.
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][sly]]
|
||||
- [[doom-package:][sly-macrostep]]
|
||||
- [[doom-package:][sly-repl-ansi-color]]
|
||||
- [[doom-package:sly]]
|
||||
- [[doom-package:sly-macrostep]]
|
||||
- [[doom-package:sly-repl-ansi-color]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
@ -42,7 +42,7 @@ This module requires [[http://www.sbcl.org/][SBCL]].
|
|||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
This module does not integrate with [[doom-module:][:tools lsp]]. Sly (and SLIME before it) is
|
||||
This module does not integrate with [[doom-module::tools lsp]]. Sly (and SLIME before it) is
|
||||
considered the defacto development environment for Common Lisp and provides much
|
||||
of what is normally expected of an LSP, plus tight integration with the REPL and
|
||||
Emacs.
|
||||
|
|
|
@ -16,8 +16,8 @@ This module adds [[https://coq.inria.fr][coq]] support, powered by [[https://pro
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][proof-general]]
|
||||
- [[doom-package:][company-coq]]
|
||||
- [[doom-package:proof-general]]
|
||||
- [[doom-package:company-coq]]
|
||||
|
||||
** Hacks
|
||||
+ Replaces coq-mode abbrevs with yasnippet snippets from doom's snippet library
|
||||
|
|
|
@ -16,11 +16,11 @@ This module has no dedicated maintainers.
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][crystal-mode]]
|
||||
- [[doom-package:][inf-crystal]]
|
||||
- if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:][flycheck-ameba]]
|
||||
- [[doom-package:][flycheck-crystal]]
|
||||
- [[doom-package:crystal-mode]]
|
||||
- [[doom-package:inf-crystal]]
|
||||
- if [[doom-module::checkers syntax]]
|
||||
- [[doom-package:flycheck-ameba]]
|
||||
- [[doom-package:flycheck-crystal]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -14,21 +14,21 @@ LSP).
|
|||
- +dotnet ::
|
||||
Enable Dotnet transient interface with Sharper
|
||||
- +lsp ::
|
||||
Enable LSP support for ~csharp-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~csharp-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports =omnisharp-roslyn=).
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
- +unity ::
|
||||
Enable special support for the [[https://unity.com/][Unity game engine]] (particularly, support for
|
||||
HLSL shaders).
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][csharp-mode]]
|
||||
- [[doom-package:][csproj-mode]]
|
||||
- [[doom-package:][shader-mode]] if [[doom-module:][+unity]]
|
||||
- [[doom-package:][sharper]] if [[doom-module:][+dotnet]]
|
||||
- [[doom-package:][sln-mode]]
|
||||
- [[doom-package:csharp-mode]]
|
||||
- [[doom-package:csproj-mode]]
|
||||
- [[doom-package:shader-mode]] if [[doom-module:+unity]]
|
||||
- [[doom-package:sharper]] if [[doom-module:+dotnet]]
|
||||
- [[doom-package:sln-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
@ -44,7 +44,7 @@ This module requires:
|
|||
- Mono (on UNIX platforms)
|
||||
- .NET SDKs (on Windows)
|
||||
- .NET Core 1.X - 3.X or .NET 5 for cross platform
|
||||
- omnisharp-rosyln (if [[doom-module:][+lsp]])
|
||||
- omnisharp-rosyln (if [[doom-module:+lsp]])
|
||||
|
||||
** TODO MacOS
|
||||
|
||||
|
|
|
@ -21,13 +21,13 @@ This module wraps ~dart-mode~, with [[https://microsoft.github.io/language-serve
|
|||
Enable ~flutter~ integration and some sane defaults for Flutter development
|
||||
along with ~hover~ for desktop development.
|
||||
- +lsp ::
|
||||
Enable LSP support for ~dart-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~dart-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports flutter).
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][dart-mode]]
|
||||
- [[doom-package:][flutter.el]]
|
||||
- [[doom-package:][hover.el]]
|
||||
- [[doom-package:dart-mode]]
|
||||
- [[doom-package:flutter.el]]
|
||||
- [[doom-package:hover.el]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
@ -92,7 +92,7 @@ flutter doctor # for Dependency check and further instructions
|
|||
- Widget guide lines for Flutter.
|
||||
- Closing labels for constructors.
|
||||
- Run tests interactively.
|
||||
- Outline support via [[doom-package:][lsp-treemacs]].
|
||||
- Outline support via [[doom-package:lsp-treemacs]].
|
||||
- Emacs functions for running and debugging Flutter projects.
|
||||
|
||||
* TODO Configuration
|
||||
|
|
|
@ -13,7 +13,7 @@ This module adds Emacs support for CSV and XML files.
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][csv-mode]]
|
||||
- [[doom-package:csv-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -16,7 +16,7 @@ functions + types + imports.
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][dhall-mode]]
|
||||
- [[doom-package:dhall-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -4,7 +4,7 @@
|
|||
#+since: 2.0.3 (#83)
|
||||
|
||||
* Description :unfold:
|
||||
This module provides support for [[https://elixir-lang.org/][Elixir programming language]] via [[doom-package:][alchemist]] or
|
||||
This module provides support for [[https://elixir-lang.org/][Elixir programming language]] via [[doom-package:alchemist]] or
|
||||
[[https://github.com/elixir-lsp/elixir-ls/][elixir-ls]].
|
||||
|
||||
** Maintainers
|
||||
|
@ -12,17 +12,17 @@ This module provides support for [[https://elixir-lang.org/][Elixir programming
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~elixir-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~elixir-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports [[https://github.com/elixir-lsp/elixir-ls/][elixir-ls]]).
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][alchemist]]
|
||||
- [[doom-package:][elixir-mode]]
|
||||
- [[doom-package:][exunit]]
|
||||
- [[doom-package:][flycheck-credo]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:alchemist]]
|
||||
- [[doom-package:elixir-mode]]
|
||||
- [[doom-package:exunit]]
|
||||
- [[doom-package:flycheck-credo]] if [[doom-module::checkers syntax]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
@ -37,7 +37,7 @@ This module provides support for [[https://elixir-lang.org/][Elixir programming
|
|||
This module requires Elixir. Install it via your distribution's package manager
|
||||
or a version management tool such as [[https://github.com/asdf-vm/asdf-elixir][asdf]].
|
||||
|
||||
To add LSP support, install [[https://github.com/JakeBecker/elixir-ls/][elixir-ls]] and enable [[doom-module:][:tools lsp]].
|
||||
To add LSP support, install [[https://github.com/JakeBecker/elixir-ls/][elixir-ls]] and enable [[doom-module::tools lsp]].
|
||||
|
||||
To support linting with [[https://github.com/rrrene/credo][credo]], add ~:checkers syntax~ to ~$DOOMDIR/init.el~.
|
||||
|
||||
|
@ -70,12 +70,12 @@ zypper install elixir
|
|||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
- Code completion ([[doom-module:][:completion company]])
|
||||
- Documentation lookup ([[doom-module:][:tools lookup]])
|
||||
- Code completion ([[doom-module::completion company]])
|
||||
- Documentation lookup ([[doom-module::tools lookup]])
|
||||
- Mix integration
|
||||
- Phoenix support
|
||||
- ~iex~ integration ([[doom-module:][:tools eval]])
|
||||
- Syntax checking ([[doom-module:][:checkers syntax]], using [[doom-package:][flycheck-credo]])
|
||||
- ~iex~ integration ([[doom-module::tools eval]])
|
||||
- Syntax checking ([[doom-module::checkers syntax]], using [[doom-package:flycheck-credo]])
|
||||
|
||||
** exunit-mode
|
||||
The exunit-mode prefix is [[kbd:][<localleader> t]]. Here is some examples:
|
||||
|
|
|
@ -11,15 +11,15 @@ This module adds [[https://elm-lang.org/][Elm]] support to Doom Emacs.
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~elm-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~elm-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports [[https://github.com/elm-tooling/elm-language-server][elm-language-server]]).
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][elm-mode]]
|
||||
- [[doom-package:][flycheck-elm]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:elm-mode]]
|
||||
- [[doom-package:flycheck-elm]] if [[doom-module::checkers syntax]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
@ -35,7 +35,7 @@ This module adds [[https://elm-lang.org/][Elm]] support to Doom Emacs.
|
|||
🔨 /This module's prerequisites are not all documented./ [[doom-contrib-module:][Document them?]]
|
||||
#+end_quote
|
||||
|
||||
- If [[doom-module:][+lsp]] is enabled, [[https://github.com/elm-tooling/elm-language-server][elm-language-server]] is required to be installed and in
|
||||
- If [[doom-module:+lsp]] is enabled, [[https://github.com/elm-tooling/elm-language-server][elm-language-server]] is required to be installed and in
|
||||
your =$PATH=.
|
||||
|
||||
* TODO Usage
|
||||
|
|
|
@ -9,7 +9,7 @@ This module extends support for Emacs Lisp in Doom Emacs.
|
|||
- Macro expansion
|
||||
- Go-to-definitions or references functionality
|
||||
- Syntax highlighting for defined and quoted symbols
|
||||
- Replaces the built-in help with the more powerful [[doom-package:][helpful]]
|
||||
- Replaces the built-in help with the more powerful [[doom-package:helpful]]
|
||||
- Adds function example uses to documentation
|
||||
|
||||
** Maintainers
|
||||
|
@ -21,14 +21,14 @@ This module extends support for Emacs Lisp in Doom Emacs.
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][buttercup]]
|
||||
- [[doom-package:][elisp-def]]
|
||||
- [[doom-package:][elisp-demos]]
|
||||
- [[doom-package:][flycheck-cask]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:][flycheck-package]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:][highlight-quoted]]
|
||||
- [[doom-package:][macrostep]]
|
||||
- [[doom-package:][overseer]]
|
||||
- [[doom-package:buttercup]]
|
||||
- [[doom-package:elisp-def]]
|
||||
- [[doom-package:elisp-demos]]
|
||||
- [[doom-package:flycheck-cask]] if [[doom-module::checkers syntax]]
|
||||
- [[doom-package:flycheck-package]] if [[doom-module::checkers syntax]]
|
||||
- [[doom-package:highlight-quoted]]
|
||||
- [[doom-package:macrostep]]
|
||||
- [[doom-package:overseer]]
|
||||
|
||||
** Hacks
|
||||
- Symbols that are defined in the current session are highlighted with
|
||||
|
|
|
@ -8,20 +8,20 @@ This module provides support [[https://www.erlang.org/][Erlang programming langu
|
|||
[[https://github.com/erlang/sourcer][sourcer]] language server is optional.
|
||||
|
||||
Includes:
|
||||
- Code completion ([[doom-module:][+lsp]], [[doom-module:][:completion company]], & [[doom-module:][:completion ivy]])
|
||||
- Syntax checking ([[doom-module:][:checkers syntax]])
|
||||
- Code completion ([[doom-module:+lsp]], [[doom-module::completion company]], & [[doom-module::completion ivy]])
|
||||
- Syntax checking ([[doom-module::checkers syntax]])
|
||||
|
||||
** Maintainers
|
||||
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~erlang-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~erlang-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports [[https://github.com/erlang/sourcer][sourcer]]).
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][flycheck-rebar3]]
|
||||
- [[doom-package:][ivy-erlang-complete]]
|
||||
- [[doom-package:flycheck-rebar3]]
|
||||
- [[doom-package:ivy-erlang-complete]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -15,15 +15,15 @@ SAS, Julia and Stata.
|
|||
Enable support for ~stan-mode~, including code completion and syntax checking.
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][ess]]
|
||||
- [[doom-package:][ess-R-data-view]]
|
||||
- [[doom-package:][polymode]]
|
||||
- [[doom-package:][poly-R]]
|
||||
- if [[doom-module:][+stan]]
|
||||
- [[doom-package:][company-stan]] if [[doom-module:][:completion company]]
|
||||
- [[doom-package:][eldoc-stan]]
|
||||
- [[doom-package:][flycheck-stan]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:][stan-mode]]
|
||||
- [[doom-package:ess]]
|
||||
- [[doom-package:ess-R-data-view]]
|
||||
- [[doom-package:polymode]]
|
||||
- [[doom-package:poly-R]]
|
||||
- if [[doom-module:+stan]]
|
||||
- [[doom-package:company-stan]] if [[doom-module::completion company]]
|
||||
- [[doom-package:eldoc-stan]]
|
||||
- [[doom-package:flycheck-stan]] if [[doom-module::checkers syntax]]
|
||||
- [[doom-package:stan-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
@ -38,7 +38,7 @@ SAS, Julia and Stata.
|
|||
This module has several optional dependencies:
|
||||
|
||||
- [[https://github.com/jimhester/lintr][lintr]]: for R linting.
|
||||
- [[https://github.com/REditorSupport/languageserver][languageserver]]: for LSP support in an R buffer (with [[doom-module:][+lsp]] flag).
|
||||
- [[https://github.com/REditorSupport/languageserver][languageserver]]: for LSP support in an R buffer (with [[doom-module:+lsp]] flag).
|
||||
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
|
|
|
@ -5,7 +5,7 @@
|
|||
|
||||
* Description :unfold:
|
||||
This module adds support to the [[https://github.com/factor/factor][factor]] programming language and its associated
|
||||
[[doom-package:][fuel]] emacs plugin.
|
||||
[[doom-package:fuel]] emacs plugin.
|
||||
|
||||
** Maintainers
|
||||
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
|
|
@ -20,17 +20,17 @@ Add support to [[https://faust.grame.fr/][Faust language]] inside emacs.
|
|||
shortcuts, etc.)
|
||||
- Automatic keyword completion (if Auto-Complete is installed)
|
||||
- Automatic objets (functions, operators, etc.) template insertion with default
|
||||
sensible values (if [[doom-module:][:editor snippets]] is enabled)
|
||||
sensible values (if [[doom-module::editor snippets]] is enabled)
|
||||
- Modeline indicator of the state of the code
|
||||
|
||||
** Maintainers
|
||||
*This module needs a maintainer.* [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][faustine]]
|
||||
- [[doom-package:faustine]]
|
||||
|
||||
** Hacks
|
||||
- Both ~faust-mode~ and ~faustine-mode~ are hardcoded to use [[doom-package:][auto-complete]],
|
||||
- Both ~faust-mode~ and ~faustine-mode~ are hardcoded to use [[doom-package:auto-complete]],
|
||||
which Doom does not use. Its obnoxious 'You really should install and use
|
||||
auto-complete' warnings have been silenced.
|
||||
|
||||
|
|
|
@ -17,7 +17,7 @@ In particular, this module features:
|
|||
- Auto-formatting via =fprettier=.
|
||||
- Integration with the =fpm= package manager.
|
||||
- LSP support via [[https://github.com/gnikit/fortls][fortls]].
|
||||
- Optional Intel Fortran support via the [[doom-module:][+intel]] flag.
|
||||
- Optional Intel Fortran support via the [[doom-module:+intel]] flag.
|
||||
|
||||
#+begin_quote
|
||||
💬 After a career of writing Fortran on Mainframes and Windows machines, my
|
||||
|
@ -33,7 +33,7 @@ In particular, this module features:
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~fortran-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~fortran-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(fortls).
|
||||
- +intel ::
|
||||
Use the =ifort= compiler by default.
|
||||
|
@ -68,7 +68,7 @@ $ sudo aura -A fortran-fpm fortls
|
|||
#+end_src bash
|
||||
|
||||
** Installing Intel Fortran
|
||||
Activating the [[doom-module:][+intel]] flag won't automatically install Intel Fortan for you.
|
||||
Activating the [[doom-module:+intel]] flag won't automatically install Intel Fortan for you.
|
||||
Here's how to do it on *nix systems.
|
||||
|
||||
You can of course install the entire High-performance Computing kit from Intel,
|
||||
|
|
|
@ -16,12 +16,12 @@ This module adds [[https://fsharp.org/][F#]] support to Doom Emacs.
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~fsharp-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~fsharp-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports [[https://github.com/emacs-lsp/lsp-mode/blob/master/clients/lsp-fsharp.el][lsp-fsharp]].).
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][fsharp-mode]]
|
||||
- [[doom-package:][lsp-fsharp]] if [[doom-package:][+lsp]]
|
||||
- [[doom-package:fsharp-mode]]
|
||||
- [[doom-package:lsp-fsharp]] if [[doom-package:+lsp]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -20,7 +20,7 @@ This module adds [[https://fstar-lang.org/][F*]] support, powered by [[https://g
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][fstar-mode]]
|
||||
- [[doom-package:fstar-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -12,11 +12,11 @@ engine, to Doom Emacs, powered by [[https://github.com/GDQuest/emacs-gdscript-mo
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~gdscript-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~gdscript-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(Godot ~3.2.1~ or newer).
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][gdscript-mode]]
|
||||
- [[doom-package:gdscript-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
@ -47,7 +47,7 @@ pip3 install gdtoolkit
|
|||
|
||||
** LSP support
|
||||
The language server support for GDScript is built into by lsp-mode. As long as
|
||||
you have [[doom-module:][+lsp]] and [[doom-module:][:tools lsp]] enabled, and Godot 3.2.1+ installed, it should work
|
||||
you have [[doom-module:+lsp]] and [[doom-module::tools lsp]] enabled, and Godot 3.2.1+ installed, it should work
|
||||
out of the box.
|
||||
|
||||
Godot's language server is built into the game engine, so you need to open your
|
||||
|
@ -67,7 +67,7 @@ available commands.
|
|||
[[doom-report:][Report an issue?]]
|
||||
|
||||
- The GDScript language server has known issues causing some errors with
|
||||
[[doom-package:][lsp-mode]]. They should be addressed in future releases.
|
||||
[[doom-package:lsp-mode]]. They should be addressed in future releases.
|
||||
|
||||
* Frequently asked questions
|
||||
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
||||
|
|
|
@ -12,7 +12,7 @@ This module adds [[https://golang.org][Go]] support, with optional (but recommen
|
|||
- Eldoc support (~go-eldoc~)
|
||||
- REPL (~gore~)
|
||||
- Syntax-checking (~flycheck~)
|
||||
- Auto-formatting on save (~gofmt~) (requires [[doom-module:][:editor format +onsave]])
|
||||
- Auto-formatting on save (~gofmt~) (requires [[doom-module::editor format +onsave]])
|
||||
- Code navigation & refactoring (~go-guru~)
|
||||
- [[../../editor/file-templates/templates/go-mode][File templates]]
|
||||
- [[https://github.com/hlissner/doom-snippets/tree/master/go-mode][Snippets]]
|
||||
|
@ -24,22 +24,22 @@ This module adds [[https://golang.org][Go]] support, with optional (but recommen
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~go-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~go-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports gopls). Highly recommended, as the non-LSP experience is deprecated
|
||||
(and poor).
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][company-go]] if [[doom-module:][:completion company]] (DEPRECATED)
|
||||
- [[doom-package:][flycheck-golangci-lint]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:][go-eldoc]]
|
||||
- [[doom-package:][go-gen-test]]
|
||||
- [[doom-package:][go-guru]]
|
||||
- [[doom-package:][go-mode]]
|
||||
- [[doom-package:][gorepl-mode]]
|
||||
- [[doom-package:][go-tag]]
|
||||
- [[doom-package:company-go]] if [[doom-module::completion company]] (DEPRECATED)
|
||||
- [[doom-package:flycheck-golangci-lint]] if [[doom-module::checkers syntax]]
|
||||
- [[doom-package:go-eldoc]]
|
||||
- [[doom-package:go-gen-test]]
|
||||
- [[doom-package:go-guru]]
|
||||
- [[doom-package:go-mode]]
|
||||
- [[doom-package:gorepl-mode]]
|
||||
- [[doom-package:go-tag]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -8,14 +8,14 @@ This module adds [[https://www.graphql.org][GraphQL]] support to Doom Emacs.
|
|||
|
||||
It includes:
|
||||
- Code completion
|
||||
- LSP support ([[doom-module:][+lsp]])
|
||||
- LSP support ([[doom-module:+lsp]])
|
||||
- Diagnostics (GraphQL syntax linting/validations) (spec-compliant)
|
||||
- Autocomplete suggestions (spec-compliant)
|
||||
- Hyperlink to fragment definitions and named types (type, input, enum) definitions (spec-compliant)
|
||||
- Outline view support for queries and SDL
|
||||
- Symbols support across the workspace
|
||||
- Local schema viewer
|
||||
- Org-babel exporter (requires [[doom-module:][:lang org]])
|
||||
- Org-babel exporter (requires [[doom-module::lang org]])
|
||||
|
||||
** Maintainers
|
||||
- [[doom-user:][@elken]]
|
||||
|
@ -24,16 +24,16 @@ It includes:
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~graphql-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~graphql-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
([[https://github.com/graphql/graphiql/tree/main/packages/graphql-language-service-cli#readme][graphql-language-service-cli]]).
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][company-graphql]] unless [[doom-module:][+lsp]]
|
||||
- [[doom-package:][graphql-mode]]
|
||||
- [[doom-package:][graphql-doc]]
|
||||
- [[doom-package:company-graphql]] unless [[doom-module:+lsp]]
|
||||
- [[doom-package:graphql-mode]]
|
||||
- [[doom-package:graphql-doc]]
|
||||
|
||||
** Hacks
|
||||
- Added a convenience function [[fn:][+graphql-doc-open-config]] to open schema docs from
|
||||
- Added a convenience function [[fn:+graphql-doc-open-config]] to open schema docs from
|
||||
a [[https://github.com/jimkyndemeyer/graphql-config-examples][.graphqlconfig]] file.
|
||||
|
||||
** TODO Changelog
|
||||
|
|
|
@ -13,12 +13,12 @@ This module adds Haskell support to Doom Emacs.
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~haskell-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~haskell-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports [[https://github.com/haskell/haskell-language-server][haskell-language-server]]).
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][haskell-mode]]
|
||||
- [[doom-package:][lsp-haskell]] if [[doom-module:][+lsp]]
|
||||
- [[doom-package:haskell-mode]]
|
||||
- [[doom-package:lsp-haskell]] if [[doom-module:+lsp]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -13,7 +13,7 @@
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][hy-mode]]
|
||||
- [[doom-package:hy-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -13,7 +13,7 @@ This module adds rudimentary [[https://www.idris-lang.org/][Idris]] support to D
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][idris-mode]]
|
||||
- [[doom-package:idris-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -12,23 +12,23 @@ This module adds [[https://www.java.com][Java]] support to Doom Emacs, including
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~java-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
(supports eclipse.jdt.ls). *Incompatible with [[doom-module:][+meghanada]].*
|
||||
Enable LSP support for ~java-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports eclipse.jdt.ls). *Incompatible with [[doom-module:+meghanada]].*
|
||||
- +meghanada ::
|
||||
Enable [[doom-package:][meghanada-mode]]. *Incompatible with [[doom-module:][+lsp]].*
|
||||
Enable [[doom-package:meghanada-mode]]. *Incompatible with [[doom-module:+lsp]].*
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][android-mode]]
|
||||
- [[doom-package:][groovy-mode]]
|
||||
- [[doom-package:][meghanada]] if [[doom-module:][+meghanada]]
|
||||
- if [[doom-module:][+eclim]]
|
||||
- [[doom-package:][eclim]]
|
||||
- [[doom-package:][company-emacs-eclim]] if [[doom-module:][:completion company]]
|
||||
- if [[doom-module:][+lsp]] and not [[doom-module:][:tools lsp +eglot]]
|
||||
- [[doom-package:][lsp-java]]
|
||||
- [[doom-package:android-mode]]
|
||||
- [[doom-package:groovy-mode]]
|
||||
- [[doom-package:meghanada]] if [[doom-module:+meghanada]]
|
||||
- if [[doom-module:+eclim]]
|
||||
- [[doom-package:eclim]]
|
||||
- [[doom-package:company-emacs-eclim]] if [[doom-module::completion company]]
|
||||
- if [[doom-module:+lsp]] and not [[doom-module::tools lsp +eglot]]
|
||||
- [[doom-package:lsp-java]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
@ -42,7 +42,7 @@ This module adds [[https://www.java.com][Java]] support to Doom Emacs, including
|
|||
|
||||
This module requires:
|
||||
- [[https://www.oracle.com/java/technologies/downloads/][Java SDK]]
|
||||
- The LSP test runner requires [[doom-module:][:tools debugger +lsp]] (requires [[doom-package:][dap-mode]])
|
||||
- The LSP test runner requires [[doom-module::tools debugger +lsp]] (requires [[doom-package:dap-mode]])
|
||||
|
||||
** OpenJDK 11
|
||||
*** Ubuntu
|
||||
|
@ -88,14 +88,14 @@ It is common to need support for multiple Java versions. You can use a generic
|
|||
tool like [[https://github.com/shyiko/jabba][jabba]] to install and manage multiple Java versions on any OS.
|
||||
|
||||
To have a different version of Java per-project, it is recommended you use
|
||||
[[https://github.com/direnv/direnv][direnv]] and [[doom-module:][:tools direnv]]; create a =.envrc= in the root of the project pointing
|
||||
[[https://github.com/direnv/direnv][direnv]] and [[doom-module::tools direnv]]; create a =.envrc= in the root of the project pointing
|
||||
to the Java installation:
|
||||
#+begin_src sh
|
||||
PATH_add ~/.jabba/jdk/adopt@1.11.0-3
|
||||
JAVA_HOME=~/.jabba/jdk/adopt@1.11.0-3
|
||||
#+end_src
|
||||
|
||||
And then run ~$ direnv allow .~ in the project directory. The [[doom-module:][:tools direnv]]
|
||||
And then run ~$ direnv allow .~ in the project directory. The [[doom-module::tools direnv]]
|
||||
module will automatically source this environment before activating LSP servers.
|
||||
|
||||
* TODO Usage
|
||||
|
@ -103,23 +103,23 @@ module will automatically source this environment before activating LSP servers.
|
|||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
** [[doom-module:][+lsp]] features
|
||||
** [[doom-module:+lsp]] features
|
||||
According to [[https://github.com/emacs-lsp/lsp-java]], you get:
|
||||
- As you type reporting of parsing and compilation errors (via [[doom-package:][flycheck]] or
|
||||
[[doom-package:][lsp-ui]])
|
||||
- Code completion ([[doom-package:][company-lsp]] or complete-at-point)
|
||||
- Javadoc hovers ([[doom-package:][lsp-ui]])
|
||||
- Code actions ([[doom-package:][lsp-ui]])
|
||||
- Code outline ([[doom-package:][imenu]])
|
||||
- Code navigation ([[doom-package:][xref]])
|
||||
- Code lens for references/implementations ([[doom-package:][xref]])
|
||||
- As you type reporting of parsing and compilation errors (via [[doom-package:flycheck]] or
|
||||
[[doom-package:lsp-ui]])
|
||||
- Code completion ([[doom-package:company-lsp]] or complete-at-point)
|
||||
- Javadoc hovers ([[doom-package:lsp-ui]])
|
||||
- Code actions ([[doom-package:lsp-ui]])
|
||||
- Code outline ([[doom-package:imenu]])
|
||||
- Code navigation ([[doom-package:xref]])
|
||||
- Code lens for references/implementations ([[doom-package:xref]])
|
||||
- Highlights
|
||||
- Code formatting
|
||||
- Maven pom.xml project support
|
||||
- Limited Gradle support
|
||||
- Visual debugger ([[doom-package:][dap-mode]])
|
||||
- Test runner ([[doom-package:][dap-mode]])
|
||||
- Project explorer integration ([[doom-package:][treemacs]])
|
||||
- Visual debugger ([[doom-package:dap-mode]])
|
||||
- Test runner ([[doom-package:dap-mode]])
|
||||
- Project explorer integration ([[doom-package:treemacs]])
|
||||
- Integration with [[https://start.spring.io/][Spring Initializr]]
|
||||
|
||||
** =+meghanada= features
|
||||
|
@ -129,14 +129,14 @@ According to [[https://github.com/mopemope/meghanada-emacs/]], you get:
|
|||
- No need build tool's plugin
|
||||
- Run build tool task
|
||||
- Compile your project
|
||||
- Syntax check and analyze java source ([[doom-package:][flycheck-meghanada]])
|
||||
- Syntax check and analyze java source ([[doom-package:flycheck-meghanada]])
|
||||
- Support =Generic Types=
|
||||
- Code completion with [[doom-package:][company-mode]] ([[doom-package:][company-meghanada]])
|
||||
- Code completion with [[doom-package:company-mode]] ([[doom-package:company-meghanada]])
|
||||
- Optimize import and sort
|
||||
- Jump declaration
|
||||
- Run [[http://www.junit.org/][JUnit]] test (include test runner)
|
||||
- Diagnostic reporting with [[doom-package:][flycheck]] ([[doom-package:][flycheck-meghanada]])
|
||||
- Show symbol's type info with [[doom-package:][eldoc]]
|
||||
- Diagnostic reporting with [[doom-package:flycheck]] ([[doom-package:flycheck-meghanada]])
|
||||
- Show symbol's type info with [[doom-package:eldoc]]
|
||||
- Search references
|
||||
- Full-featured text search
|
||||
|
||||
|
@ -145,7 +145,7 @@ According to [[https://github.com/mopemope/meghanada-emacs/]], you get:
|
|||
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
** [[doom-module:][+lsp]]
|
||||
** [[doom-module:+lsp]]
|
||||
Install the eclipse server by executing ~M-x lsp-install-server~ and selecting
|
||||
=jdtls=. After that any newly opened =java= files should start the LSP server
|
||||
automatically.
|
||||
|
@ -156,7 +156,7 @@ Note that if you change Java version you may need to remove the LSP server and
|
|||
install it again. You can do this with ~M-x +lsp/uninstall-server~ followed by
|
||||
~M-x lsp-install-server~.
|
||||
|
||||
Enable the [[doom-module:][:tools debugger +lsp]] module to get test runner support.
|
||||
Enable the [[doom-module::tools debugger +lsp]] module to get test runner support.
|
||||
|
||||
* Troubleshooting
|
||||
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
||||
|
|
|
@ -6,13 +6,13 @@
|
|||
* Description :unfold:
|
||||
This module adds [[https://www.javascript.com/][JavaScript]] and [[https://www.typescriptlang.org/][TypeScript]] support to Doom Emacs.
|
||||
|
||||
- Code completion ([[doom-package:][tide]])
|
||||
- REPL support ([[doom-package:][nodejs-repl]])
|
||||
- Refactoring commands ([[doom-package:][js2-refactor]])
|
||||
- Syntax checking ([[doom-package:][flycheck]])
|
||||
- Browser code injection with [[doom-package:][skewer-mode]]
|
||||
- Code completion ([[doom-package:tide]])
|
||||
- REPL support ([[doom-package:nodejs-repl]])
|
||||
- Refactoring commands ([[doom-package:js2-refactor]])
|
||||
- Syntax checking ([[doom-package:flycheck]])
|
||||
- Browser code injection with [[doom-package:skewer-mode]]
|
||||
- Coffeescript & JSX support
|
||||
- Jump-to-definitions and references support ([[doom-package:][xref]])
|
||||
- Jump-to-definitions and references support ([[doom-package:xref]])
|
||||
|
||||
** Maintainers
|
||||
- [[doom-user:][@elken]]
|
||||
|
@ -24,21 +24,21 @@ This module adds [[https://www.javascript.com/][JavaScript]] and [[https://www.t
|
|||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~js2-mode~, ~rjsx-mode~, JS in ~web-mode~, and
|
||||
~typescript-mode~. Requires [[doom-module:][:tools lsp]] and a langserver (supports ts-ls and
|
||||
~typescript-mode~. Requires [[doom-module::tools lsp]] and a langserver (supports ts-ls and
|
||||
deno-ls).
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][js2-refactor]]
|
||||
- [[doom-package:][nodejs-repl]]
|
||||
- [[doom-package:][npm-mode]]
|
||||
- [[doom-package:][rjsx-mode]]
|
||||
- [[doom-package:][skewer-mode]] (DEPRECATED)
|
||||
- [[doom-package:][tide]]
|
||||
- [[doom-package:][typescript-mode]]
|
||||
- [[doom-package:][xref-js2]] if [[doom-module:][:tools lookup]]
|
||||
- [[doom-package:js2-refactor]]
|
||||
- [[doom-package:nodejs-repl]]
|
||||
- [[doom-package:npm-mode]]
|
||||
- [[doom-package:rjsx-mode]]
|
||||
- [[doom-package:skewer-mode]] (DEPRECATED)
|
||||
- [[doom-package:tide]]
|
||||
- [[doom-package:typescript-mode]]
|
||||
- [[doom-package:xref-js2]] if [[doom-module::tools lookup]]
|
||||
|
||||
** TODO Hacks
|
||||
#+begin_quote
|
||||
|
|
|
@ -11,16 +11,16 @@ This module adds [[https://www.json.org/json-en.html][JSON]] support to Doom Ema
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~json-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~json-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports [[https://github.com/vscode-langservers/vscode-json-languageserver][vscode-json-languageserver]]).
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][counsel-jq]] if [[doom-module:][:completion ivy]]
|
||||
- [[doom-package:][json-mode]]
|
||||
- [[doom-package:][json-snatcher]]
|
||||
- [[doom-package:counsel-jq]] if [[doom-module::completion ivy]]
|
||||
- [[doom-package:json-mode]]
|
||||
- [[doom-package:json-snatcher]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -6,31 +6,31 @@
|
|||
* Description :unfold:
|
||||
This module adds support for [[https://julialang.org/][the Julia language]] to Doom Emacs.
|
||||
|
||||
- Syntax highlighting and latex symbols from [[doom-package:][julia-mode]]
|
||||
- REPL integration from [[doom-package:][julia-repl]]
|
||||
- Code completion and syntax checking, requires [[doom-module:][:tools lsp]] and [[doom-module:][+lsp]]
|
||||
- Syntax highlighting and latex symbols from [[doom-package:julia-mode]]
|
||||
- REPL integration from [[doom-package:julia-repl]]
|
||||
- Code completion and syntax checking, requires [[doom-module::tools lsp]] and [[doom-module:+lsp]]
|
||||
|
||||
** Maintainers
|
||||
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~julia-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~julia-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports LanguageServer.jl).
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][julia-mode]]
|
||||
- [[doom-package:][julia-repl]]
|
||||
- if [[doom-package:][+lsp]]
|
||||
- if [[doom-module:][:tools lsp]]
|
||||
- [[doom-package:][lsp-julia]]
|
||||
- [[doom-package:][lsp]]
|
||||
- if [[doom-module:][:tools lsp +eglot]]
|
||||
- [[doom-package:][eglot-jl]]
|
||||
- [[doom-package:][eglot]]
|
||||
- [[doom-package:julia-mode]]
|
||||
- [[doom-package:julia-repl]]
|
||||
- if [[doom-package:+lsp]]
|
||||
- if [[doom-module::tools lsp]]
|
||||
- [[doom-package:lsp-julia]]
|
||||
- [[doom-package:lsp]]
|
||||
- if [[doom-module::tools lsp +eglot]]
|
||||
- [[doom-package:eglot-jl]]
|
||||
- [[doom-package:eglot]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
@ -42,11 +42,11 @@ This module adds support for [[https://julialang.org/][the Julia language]] to D
|
|||
* Installation
|
||||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||
|
||||
This module requires [[https://julialang.org/][Julia]] and an language server if [[doom-module:][+lsp]] is enabled.
|
||||
This module requires [[https://julialang.org/][Julia]] and an language server if [[doom-module:+lsp]] is enabled.
|
||||
|
||||
** Language Server
|
||||
[[doom-module:][+lsp]] requires ~LanguageServer.jl~ and ~SymbolServer.jl~. The [[doom-package:][lsp-julia]] and
|
||||
[[doom-package:][eglot-jl]] packages both come bundled with their own versions of these servers,
|
||||
[[doom-module:+lsp]] requires ~LanguageServer.jl~ and ~SymbolServer.jl~. The [[doom-package:lsp-julia]] and
|
||||
[[doom-package:eglot-jl]] packages both come bundled with their own versions of these servers,
|
||||
which is used by default. If you're happy with that, no further configuration is
|
||||
necessary.
|
||||
|
||||
|
@ -58,17 +58,17 @@ Pkg.add("LanguageServer")
|
|||
Pkg.add("SymbolServer")
|
||||
#+end_src
|
||||
|
||||
Then configure [[doom-package:][lsp-julia]] or [[doom-package:][eglot-jl]] depending on whether you have enabled
|
||||
[[doom-module:][:tools lsp]] or [[doom-module:][:tools lsp +eglot]], respectively:
|
||||
Then configure [[doom-package:lsp-julia]] or [[doom-package:eglot-jl]] depending on whether you have enabled
|
||||
[[doom-module::tools lsp]] or [[doom-module::tools lsp +eglot]], respectively:
|
||||
|
||||
*** =lsp-julia=
|
||||
To instruct [[doom-package:][lsp-julia]] not to use the built-in package:
|
||||
To instruct [[doom-package:lsp-julia]] not to use the built-in package:
|
||||
#+begin_src emacs-lisp
|
||||
;; in $DOOMDIR/config.el
|
||||
(setq lsp-julia-package-dir nil)
|
||||
#+end_src
|
||||
|
||||
To find your installation of ~LanguageServer.jl~, [[doom-package:][lsp-julia]] needs to know the
|
||||
To find your installation of ~LanguageServer.jl~, [[doom-package:lsp-julia]] needs to know the
|
||||
environment in which it is installed. This is set to v1.6 by default as it is
|
||||
the current LTS:
|
||||
#+begin_src emacs-lisp
|
||||
|
@ -78,7 +78,7 @@ the current LTS:
|
|||
#+end_src
|
||||
|
||||
*** =eglot-jl=
|
||||
To find your installation of ~LanguageServer.jl~, [[doom-package:][eglot-jl]] must know the
|
||||
To find your installation of ~LanguageServer.jl~, [[doom-package:eglot-jl]] must know the
|
||||
environment in which it is installed. This is set to v1.6 by default as it is
|
||||
the current LTS:
|
||||
#+begin_src emacs-lisp
|
||||
|
@ -86,7 +86,7 @@ the current LTS:
|
|||
(setq eglot-jl-language-server-project "~/.julia/environments/v1.6")
|
||||
#+end_src
|
||||
|
||||
But to let [[doom-package:][eglot-jl]] use the environment bundled with it, set it to
|
||||
But to let [[doom-package:eglot-jl]] use the environment bundled with it, set it to
|
||||
~eglot-jl-base~ instead:
|
||||
#+begin_src emacs-lisp
|
||||
;; in $DOOMDIR/config.el
|
||||
|
@ -100,8 +100,8 @@ But to let [[doom-package:][eglot-jl]] use the environment bundled with it, set
|
|||
#+end_quote
|
||||
|
||||
** Language Server
|
||||
[[doom-module:][+lsp]] adds code completion, syntax checking, formatting and other [[doom-package:][lsp-mode]] or
|
||||
[[doom-package:][eglot]] features. It requires ~LanguageServer.jl~, the installation of which is
|
||||
[[doom-module:+lsp]] adds code completion, syntax checking, formatting and other [[doom-package:lsp-mode]] or
|
||||
[[doom-package:eglot]] features. It requires ~LanguageServer.jl~, the installation of which is
|
||||
described above.
|
||||
|
||||
* TODO Configuration
|
||||
|
@ -110,7 +110,7 @@ described above.
|
|||
#+end_quote
|
||||
|
||||
** Change the default environment for the Julia language server
|
||||
[[doom-package:][lsp-julia]] requires a variable be set for the Julia environment. This is set to
|
||||
[[doom-package:lsp-julia]] requires a variable be set for the Julia environment. This is set to
|
||||
v1.6 by default as it is the current LTS:
|
||||
#+begin_src emacs-lisp
|
||||
;; in $DOOMDIR/config.el
|
||||
|
|
|
@ -11,12 +11,12 @@ This module adds [[https://kotlinlang.org/][Kotlin]] support to Doom Emacs.
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~kotlin-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~kotlin-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports [[https://github.com/emacs-lsp/lsp-mode][kotlin-language-server]]).
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][flycheck-kotlin]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:][kotlin-mode]]
|
||||
- [[doom-package:flycheck-kotlin]] if [[doom-module::checkers syntax]]
|
||||
- [[doom-package:kotlin-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -8,11 +8,11 @@ Provide a helping hand when working with LaTeX documents.
|
|||
|
||||
- Sane defaults
|
||||
- Fontification of many popular commands
|
||||
- Pretty indentation of wrapped lines using the [[doom-package:][adaptive-wrap]] package
|
||||
- Spell checking with [[doom-package:][flycheck]]
|
||||
- Change PDF viewer to Okular or [[doom-package:][latex-preview-pane]]
|
||||
- Pretty indentation of wrapped lines using the [[doom-package:adaptive-wrap]] package
|
||||
- Spell checking with [[doom-package:flycheck]]
|
||||
- Change PDF viewer to Okular or [[doom-package:latex-preview-pane]]
|
||||
- Bibtex editor
|
||||
- Autocompletion using [[doom-package:][company-mode]]
|
||||
- Autocompletion using [[doom-package:company-mode]]
|
||||
- Compile your =.tex= code only once using LatexMk
|
||||
|
||||
** Maintainers
|
||||
|
@ -23,27 +23,27 @@ Provide a helping hand when working with LaTeX documents.
|
|||
|
||||
** Module flags
|
||||
- +cdlatex ::
|
||||
Enable [[doom-package:][cdlatex]] for fast math insertion.
|
||||
Enable [[doom-package:cdlatex]] for fast math insertion.
|
||||
- +fold ::
|
||||
Use TeX-fold (from [[doom-package:][auctex]]) to fold LaTeX macros to unicode, and make folding
|
||||
Use TeX-fold (from [[doom-package:auctex]]) to fold LaTeX macros to unicode, and make folding
|
||||
hook-based and less manual.
|
||||
- +latexmk ::
|
||||
Use LatexMk instead of LaTeX to compile documents.
|
||||
- +lsp ::
|
||||
Enable LSP support in latex buffers. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support in latex buffers. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports digestif and TexLab).
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][adaptive-wrap]]
|
||||
- [[doom-package:][auctex]]
|
||||
- [[doom-package:][auctex-latexmk]] if [[doom-module:][+latexmk]]
|
||||
- [[doom-package:][cdlatex]] if [[doom-module:][+cdlatex]]
|
||||
- [[doom-package:][evil-tex]] if [[doom-module:][:editor evil +everywhere]]
|
||||
- [[doom-package:][latex-preview-pane]]
|
||||
- if [[doom-module:][:completion company]]
|
||||
- [[doom-package:][company-auctex]]
|
||||
- [[doom-package:][company-math]]
|
||||
- [[doom-package:][company-reftex]]
|
||||
- [[doom-package:adaptive-wrap]]
|
||||
- [[doom-package:auctex]]
|
||||
- [[doom-package:auctex-latexmk]] if [[doom-module:+latexmk]]
|
||||
- [[doom-package:cdlatex]] if [[doom-module:+cdlatex]]
|
||||
- [[doom-package:evil-tex]] if [[doom-module::editor evil +everywhere]]
|
||||
- [[doom-package:latex-preview-pane]]
|
||||
- if [[doom-module::completion company]]
|
||||
- [[doom-package:company-auctex]]
|
||||
- [[doom-package:company-math]]
|
||||
- [[doom-package:company-reftex]]
|
||||
|
||||
** TODO Hacks
|
||||
#+begin_quote
|
||||
|
@ -115,7 +115,7 @@ This module provides integration for four supported pdf viewers. They are
|
|||
+ Sumatra PDF
|
||||
+ Zathura
|
||||
+ Okular
|
||||
+ pdf-tools (requires [[doom-module:][:tools pdf]] module)
|
||||
+ pdf-tools (requires [[doom-module::tools pdf]] module)
|
||||
|
||||
They are searched for in this order. See ~+latex-viewers~ to change the order,
|
||||
or remove tools from the search altogether. If you want to exclusively use one
|
||||
|
@ -130,8 +130,8 @@ is used as a fallback. You can use this exclusively by setting ~+latex-viewers~
|
|||
to ~nil~.
|
||||
|
||||
** Using cdlatex's snippets despite having yasnippet
|
||||
[[doom-package:][cdlatex]] has a snippet insertion capability which is disabled in favor of
|
||||
[[doom-package:][yasnippet]] when using [[doom-module:][:editor snippets]]. If you still wanna use it, simply rebind
|
||||
[[doom-package:cdlatex]] has a snippet insertion capability which is disabled in favor of
|
||||
[[doom-package:yasnippet]] when using [[doom-module::editor snippets]]. If you still wanna use it, simply rebind
|
||||
the [[kbd:][TAB]] key for cdlatex, which takes care of snippet-related stuff:
|
||||
#+begin_src emacs-lisp
|
||||
;; in $DOOMDIR/config.el
|
||||
|
|
|
@ -13,8 +13,8 @@ This module adds support for the [[https://leanprover.github.io/about/][Lean pro
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][lean-mode]]
|
||||
- [[doom-package:][company-lean]] if [[doom-module:][:completion company]]
|
||||
- [[doom-package:lean-mode]]
|
||||
- [[doom-package:company-lean]] if [[doom-module::completion company]]
|
||||
|
||||
** TODO Hacks
|
||||
#+begin_quote
|
||||
|
|
|
@ -29,9 +29,9 @@ This modules enables the following features:
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][evil-ledger]] if [[doom-module:][:editor evil +everywhere]]
|
||||
- [[doom-package:][flycheck-ledger]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:][ledger-mode]]
|
||||
- [[doom-package:evil-ledger]] if [[doom-module::editor evil +everywhere]]
|
||||
- [[doom-package:flycheck-ledger]] if [[doom-module::checkers syntax]]
|
||||
- [[doom-package:ledger-mode]]
|
||||
|
||||
** Hacks
|
||||
- This module sets ~ledger-clear-whole-transactions~ to ~t~ (default value is
|
||||
|
|
|
@ -20,18 +20,18 @@ This module adds Lua support to Doom Emacs.
|
|||
- +fennel ::
|
||||
Enable support for the Fennel language.
|
||||
- +lsp ::
|
||||
Enable LSP support for ~lua-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~lua-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports EmmyLua, lua-language-server, and lua-lsp).
|
||||
- +moonscript ::
|
||||
Enable support for the Moonscript language.
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][company-lua]] if [[doom-module:][:completion company]]
|
||||
- [[doom-package:][fennel-mode]] if [[doom-module:][+fennel]]
|
||||
- [[doom-package:][lua-mode]]
|
||||
- if [[doom-module:][+moonscript]]
|
||||
- [[doom-package:][flycheck-moonscript]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:][moonscript-mode]]
|
||||
- [[doom-package:company-lua]] if [[doom-module::completion company]]
|
||||
- [[doom-package:fennel-mode]] if [[doom-module:+fennel]]
|
||||
- [[doom-package:lua-mode]]
|
||||
- if [[doom-module:+moonscript]]
|
||||
- [[doom-package:flycheck-moonscript]] if [[doom-module::checkers syntax]]
|
||||
- [[doom-package:moonscript-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
@ -48,8 +48,8 @@ fennel and moonscript transpilers. An LSP server is also required for LSP
|
|||
support.
|
||||
|
||||
** Language Server Protocol servers
|
||||
LSP server support depends on which flavor of the [[doom-module:][:tools lsp]] module you have
|
||||
installed ([[doom-package:][eglot]] or [[doom-package:][lsp-mode]]).
|
||||
LSP server support depends on which flavor of the [[doom-module::tools lsp]] module you have
|
||||
installed ([[doom-package:eglot]] or [[doom-package:lsp-mode]]).
|
||||
|
||||
*** LSP-mode
|
||||
Three servers are supported, ordered from highest to lowest priority:
|
||||
|
@ -81,7 +81,7 @@ Eglot currently only supports one of the above servers out of the box:
|
|||
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
- lua-lsp-dir :: This must be set when using [[doom-module:][+lsp]] and using [[https://github.com/sumneko/lua-language-server][lua-language-server]].
|
||||
- lua-lsp-dir :: This must be set when using [[doom-module:+lsp]] and using [[https://github.com/sumneko/lua-language-server][lua-language-server]].
|
||||
This controls where the repository has been cloned and built to finish the
|
||||
configuration of the server.
|
||||
|
||||
|
|
|
@ -35,14 +35,14 @@ for Markdown's syntax is the format of plain text email. -- John Gruber
|
|||
previews of your markdown (or org) files.
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][edit-indirect]]
|
||||
- [[doom-package:][evil-markdown]] if [[doom-module:][:editor evil +everywhere]]
|
||||
- [[doom-package:][grip-mode]] if [[doom-module:][+grip]]
|
||||
- [[doom-package:][markdown-mode]]
|
||||
- [[doom-package:][markdown-toc]]
|
||||
- [[doom-package:edit-indirect]]
|
||||
- [[doom-package:evil-markdown]] if [[doom-module::editor evil +everywhere]]
|
||||
- [[doom-package:grip-mode]] if [[doom-module:+grip]]
|
||||
- [[doom-package:markdown-mode]]
|
||||
- [[doom-package:markdown-toc]]
|
||||
|
||||
** Hacks
|
||||
- [[doom-package:][flyspell]] has been configured not to spell check in code blocks, links, HTML
|
||||
- [[doom-package:flyspell]] has been configured not to spell check in code blocks, links, HTML
|
||||
tags or references.
|
||||
|
||||
** TODO Changelog
|
||||
|
@ -53,7 +53,7 @@ for Markdown's syntax is the format of plain text email. -- John Gruber
|
|||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||
|
||||
This module requires:
|
||||
- A linter (requires [[doom-module:][:checkers syntax]])
|
||||
- A linter (requires [[doom-module::checkers syntax]])
|
||||
- A markdown compiler, for previewing Markdown
|
||||
|
||||
** Linters
|
||||
|
@ -124,7 +124,7 @@ installed through your OS's package manager:
|
|||
~markdown-preview~ is bound to [[kbd:][<localleader> p]]. This will open a preview of your
|
||||
compiled markdown document in your browser.
|
||||
|
||||
Alternatively, you can use ~grip-mode~ through [[doom-module:][+grip]].
|
||||
Alternatively, you can use ~grip-mode~ through [[doom-module:+grip]].
|
||||
|
||||
* Configuration
|
||||
#+begin_quote
|
||||
|
|
|
@ -6,9 +6,9 @@
|
|||
* Description :unfold:
|
||||
This module adds [[https://nim-lang.org][Nim]] support to Doom Emacs.
|
||||
|
||||
- Code completion ([[doom-package:][nimsuggest]] + [[doom-package:][company]])
|
||||
- Syntax checking ([[doom-package:][nimsuggest]] + [[doom-package:][flycheck]])
|
||||
- Org babel support ([[doom-package:][ob-nim]])
|
||||
- Code completion ([[doom-package:nimsuggest]] + [[doom-package:company]])
|
||||
- Syntax checking ([[doom-package:nimsuggest]] + [[doom-package:flycheck]])
|
||||
- Org babel support ([[doom-package:ob-nim]])
|
||||
|
||||
** Maintainers
|
||||
*This module needs a maintainer.* [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
@ -17,13 +17,13 @@ This module adds [[https://nim-lang.org][Nim]] support to Doom Emacs.
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][flycheck-nim]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:][nim-mode]]
|
||||
- [[doom-package:flycheck-nim]] if [[doom-module::checkers syntax]]
|
||||
- [[doom-package:nim-mode]]
|
||||
|
||||
** Hacks
|
||||
- [[doom-package:][nimsuggest]] was modified to strip invalid characters from its temp file paths
|
||||
- [[doom-package:nimsuggest]] was modified to strip invalid characters from its temp file paths
|
||||
(which would break nimsuggest on Windows systems).
|
||||
- [[doom-package:][nim-mode]] was modified to fail gracefully if =nimsuggest= (the executable)
|
||||
- [[doom-package:nim-mode]] was modified to fail gracefully if =nimsuggest= (the executable)
|
||||
isn't available.
|
||||
|
||||
** TODO Changelog
|
||||
|
|
|
@ -9,7 +9,7 @@ for managing [[https://nixos.org/][Nix(OS)]].
|
|||
|
||||
Includes:
|
||||
- Syntax highlighting
|
||||
- Completion through [[doom-package:][company]] and/or [[doom-package:][helm]]
|
||||
- Completion through [[doom-package:company]] and/or [[doom-package:helm]]
|
||||
- Nix option lookup
|
||||
- Formatting (~nixfmt~)
|
||||
|
||||
|
@ -21,13 +21,13 @@ Includes:
|
|||
** Module flags
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][company-nixos-options]] if [[doom-module:][:completion company]]
|
||||
- [[doom-package:][helm-nixos-options]] if [[doom-module:][:completion helm]]
|
||||
- [[doom-package:][nix-mode]]
|
||||
- [[doom-package:][nix-update]]
|
||||
- [[doom-package:company-nixos-options]] if [[doom-module::completion company]]
|
||||
- [[doom-package:helm-nixos-options]] if [[doom-module::completion helm]]
|
||||
- [[doom-package:nix-mode]]
|
||||
- [[doom-package:nix-update]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
@ -42,7 +42,7 @@ Includes:
|
|||
This module requires:
|
||||
- [[https://nixos.org/guides/install-nix.html][The Nix package manager]], for a variety of its features (besides syntax
|
||||
highlighting).
|
||||
- =nixfmt=, for automatic formatting (requires [[doom-module:][:editor format]]).
|
||||
- =nixfmt=, for automatic formatting (requires [[doom-module::editor format]]).
|
||||
|
||||
- *MacOS:* TODO
|
||||
- *Arch Linux:* TODO
|
||||
|
|
|
@ -4,45 +4,45 @@
|
|||
#+since: 2.0.4 (#128)
|
||||
|
||||
* Description :unfold:
|
||||
This module adds [[https://ocaml.org/][OCaml]] support to Doom Emacs, powered by [[doom-package:][tuareg-mode]].
|
||||
This module adds [[https://ocaml.org/][OCaml]] support to Doom Emacs, powered by [[doom-package:tuareg-mode]].
|
||||
|
||||
- Code completion, documentation look-up, code navigation and refactoring
|
||||
([[doom-package:][merlin]])
|
||||
- Type, documentation and function argument display on idle ([[doom-package:][merlin-eldoc]])
|
||||
- REPL ([[doom-package:][utop]])
|
||||
- Syntax-checking ([[doom-package:][merlin]] with [[doom-package:][flycheck-ocaml]])
|
||||
- Auto-indentation ([[doom-package:][ocp-indent]])
|
||||
- Code formatting ([[doom-package:][ocamlformat]])
|
||||
- Dune file format ([[doom-package:][dune]])
|
||||
([[doom-package:merlin]])
|
||||
- Type, documentation and function argument display on idle ([[doom-package:merlin-eldoc]])
|
||||
- REPL ([[doom-package:utop]])
|
||||
- Syntax-checking ([[doom-package:merlin]] with [[doom-package:flycheck-ocaml]])
|
||||
- Auto-indentation ([[doom-package:ocp-indent]])
|
||||
- Code formatting ([[doom-package:ocamlformat]])
|
||||
- Dune file format ([[doom-package:dune]])
|
||||
|
||||
** Maintainers
|
||||
*This module needs a maintainer.* [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~tuareg-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~tuareg-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports [[https://github.com/freebroccolo/ocaml-language-server][ocaml-language-server]]).
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][dune]]
|
||||
- [[doom-package:][ocamlformat]] if [[doom-module:][:editor format]]
|
||||
- [[doom-package:][ocp-indent]]
|
||||
- [[doom-package:][tuareg]]
|
||||
- [[doom-package:][utop]] if [[doom-module:][:tools eval]]
|
||||
- unless [[doom-module:][+lsp]]
|
||||
- [[doom-package:][flycheck-ocaml]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:][merlin]]
|
||||
- [[doom-package:][merlin-company]]
|
||||
- [[doom-package:][merlin-eldoc]]
|
||||
- [[doom-package:dune]]
|
||||
- [[doom-package:ocamlformat]] if [[doom-module::editor format]]
|
||||
- [[doom-package:ocp-indent]]
|
||||
- [[doom-package:tuareg]]
|
||||
- [[doom-package:utop]] if [[doom-module::tools eval]]
|
||||
- unless [[doom-module:+lsp]]
|
||||
- [[doom-package:flycheck-ocaml]] if [[doom-module::checkers syntax]]
|
||||
- [[doom-package:merlin]]
|
||||
- [[doom-package:merlin-company]]
|
||||
- [[doom-package:merlin-eldoc]]
|
||||
|
||||
** Hacks
|
||||
- ~set-ligatures!~ is called with the full tuareg prettify symbol list, this can
|
||||
cause columns to change as certain keywords are shortened (e.g. =fun= becomes
|
||||
\lambda).
|
||||
- ~tuareg-opam-update-env~ is called the first time [[doom-package:][tuareg]] is loaded
|
||||
- ~tuareg-opam-update-env~ is called the first time [[doom-package:tuareg]] is loaded
|
||||
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
|
@ -86,16 +86,16 @@ This module requires the following packages available through [[http://opam.ocam
|
|||
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
- If [[doom-module:][:completion company]] is enabled then autocomplete is provided by [[doom-package:][merlin]]
|
||||
- When [[doom-module:][:checkers syntax]] is enabled then [[doom-package:][flycheck-ocaml]] is activated to do
|
||||
on-the-fly syntax/type checking via [[doom-package:][merlin]], otherwise this is only done when
|
||||
- If [[doom-module::completion company]] is enabled then autocomplete is provided by [[doom-package:merlin]]
|
||||
- When [[doom-module::checkers syntax]] is enabled then [[doom-package:flycheck-ocaml]] is activated to do
|
||||
on-the-fly syntax/type checking via [[doom-package:merlin]], otherwise this is only done when
|
||||
the file is saved.
|
||||
- Spell checking is activated in comments if [[doom-module:][:checkers spell]] is active
|
||||
- A REPL is provided if [[doom-package:][utop]] is installed and [[doom-module:][:tools eval]] is active
|
||||
- If [[doom-module:][:editor format]] is enabled, the =ocamlformat= executable is available and
|
||||
- Spell checking is activated in comments if [[doom-module::checkers spell]] is active
|
||||
- A REPL is provided if [[doom-package:utop]] is installed and [[doom-module::tools eval]] is active
|
||||
- If [[doom-module::editor format]] is enabled, the =ocamlformat= executable is available and
|
||||
there is an =.ocamlformat= file present then ~format-all-buffer~ is bound to
|
||||
=ocamlformat=, otherwise to =ocp-indent=
|
||||
- If [[doom-module:][:editor multiple-cursors]] is enabled then identifiers can be refactored with
|
||||
- If [[doom-module::editor multiple-cursors]] is enabled then identifiers can be refactored with
|
||||
[[kbd:][v R]] and multiple cursors (this correctly matches identifier occurrences
|
||||
according to scope, it is not purely a textual match)
|
||||
|
||||
|
|
|
@ -18,7 +18,7 @@ intuitive out of the box:
|
|||
- A configuration for using org-mode for slide-show presentations or exporting
|
||||
org files to reveal.js slideshows.
|
||||
- Drag-and-drop support for images (with inline preview) and media files (drops
|
||||
a file icon and a short link) (requires [[doom-module:][+dragndrop]] flag).
|
||||
a file icon and a short link) (requires [[doom-module:+dragndrop]] flag).
|
||||
- Integration with pandoc, ipython, jupyter, reveal.js, beamer, and others
|
||||
(requires flags).
|
||||
- Export-to-clipboard functionality, for copying text into formatted html,
|
||||
|
@ -58,12 +58,12 @@ https://www.mfoot.com/blog/2015/11/22/literate-emacs-configuration-with-org-mode
|
|||
- +ipython ::
|
||||
(**DEPRECATED**) Enable ipython integration for babel.
|
||||
- +journal ::
|
||||
Enable [[doom-package:][org-journal]] integration.
|
||||
Enable [[doom-package:org-journal]] integration.
|
||||
- +jupyter ::
|
||||
Enable Jupyter integration for babel.
|
||||
- +noter ::
|
||||
Enable [[doom-package:][org-noter]] integration. Keeps notes in sync with a document. Requires
|
||||
[[doom-module:][:tools pdf]], [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Document-View.html][DocView]], or [[https://github.com/wasamasa/nov.el][nov.el]] to be enabled.
|
||||
Enable [[doom-package:org-noter]] integration. Keeps notes in sync with a document. Requires
|
||||
[[doom-module::tools pdf]], [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Document-View.html][DocView]], or [[https://github.com/wasamasa/nov.el][nov.el]] to be enabled.
|
||||
- +pandoc ::
|
||||
Enable pandoc integration into the Org exporter.
|
||||
- +passwords ::
|
||||
|
@ -79,10 +79,10 @@ https://www.mfoot.com/blog/2015/11/22/literate-emacs-configuration-with-org-mode
|
|||
too slow, it'd be wise to disable this flag.
|
||||
- +roam ::
|
||||
Enable integration with [[https://github.com/org-roam/org-roam-v1][org-roam v1]]. This requires ~sqlite3~ to be installed
|
||||
on your system. /Incompatible with [[doom-module:][+roam2]]./
|
||||
on your system. /Incompatible with [[doom-module:+roam2]]./
|
||||
- +roam2 ::
|
||||
Enable integration with [[https://github.com/org-roam/org-roam][org-roam v2]]. This requires ~sqlite3~ to be installed
|
||||
on your system. /Incompatible with [[doom-module:][+roam]]./
|
||||
on your system. /Incompatible with [[doom-module:+roam]]./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][evil-org]] if [[doom-package:][:editor evil]]
|
||||
|
@ -128,16 +128,16 @@ https://www.mfoot.com/blog/2015/11/22/literate-emacs-configuration-with-org-mode
|
|||
** Hacks
|
||||
- Adds support for a ~:sync~ parameter for org src blocks. This overrides
|
||||
~:async~.
|
||||
- Gracefully degrades ~:async~ babel blocks to ~:sync~ when [[doom-package:][ob-async]] would cause
|
||||
errors or issues (such as with a ~:session~ parameter, which [[doom-package:][ob-async]] does not
|
||||
- Gracefully degrades ~:async~ babel blocks to ~:sync~ when [[doom-package:ob-async]] would cause
|
||||
errors or issues (such as with a ~:session~ parameter, which [[doom-package:ob-async]] does not
|
||||
support, or when exporting org documents).
|
||||
- The window is recentered when following links.
|
||||
- The breadcrumbs displayed in eldoc when hovering over an org headline has been
|
||||
reworked to strip out link syntax and normalize font-size disparities.
|
||||
- If [[doom-module:][:ui workspaces]] is enabled, persp-mode won't register org agenda buffers
|
||||
- If [[doom-module::ui workspaces]] is enabled, persp-mode won't register org agenda buffers
|
||||
that are temporarily opened in the background.
|
||||
- Temporary org agenda files aren't added to recentf.
|
||||
- =file:= links are highlighted with the ~error~ face if they are broken.
|
||||
- =file:= links are highlighted with the [[face:error]] face if they are broken.
|
||||
- TAB was changed to toggle only the visibility state of the current subtree,
|
||||
rather than cycle through it recursively. This can be reversed with:
|
||||
|
||||
|
@ -146,19 +146,19 @@ https://www.mfoot.com/blog/2015/11/22/literate-emacs-configuration-with-org-mode
|
|||
(remove-hook 'org-tab-first-hook #'+org-cycle-only-current-subtree-h))
|
||||
#+end_src
|
||||
- (Evil users) Nearby tables are formatted when exiting insert or replace mode
|
||||
(see ~+org-enable-auto-reformat-tables-h~).
|
||||
(see [[fn:+org-enable-auto-reformat-tables-h]]).
|
||||
- Statistics cookies are updated when saving the buffer of exiting insert mode
|
||||
(see ~+org-enable-auto-update-cookies-h~).
|
||||
- Org-protocol has been lazy loaded (see ~+org-init-protocol-lazy-loader-h~);
|
||||
loaded when the server receives a request for an org-protocol:// url.
|
||||
(see [[fn:+org-enable-auto-update-cookies-h]]).
|
||||
- Org-protocol has been lazy loaded (see [[fn:+org-init-protocol-lazy-loader-h]]);
|
||||
loaded when the server receives a request for an =org-protocol://= url.
|
||||
- Babel and babel plugins are now lazy loaded (see
|
||||
~+org-init-babel-lazy-loader-h~); loaded when a src block is executed. No need
|
||||
to use ~org-babel-do-load-languages~ in your config, just install your babel
|
||||
[[fn:+org-init-babel-lazy-loader-h]]); loaded when a src block is executed. No need
|
||||
to use [[fn:org-babel-do-load-languages]] in your config, just install your babel
|
||||
packages to extend language support (and ensure its ~org-babel-execute:*~
|
||||
function is autoloaded).
|
||||
- If a variable is used as a file path in ~org-capture-template~, it will be
|
||||
resolved relative to ~org-directory~, instead of ~default-directory~ (see
|
||||
~+org-capture-expand-variable-file-a~).
|
||||
- If a variable is used as a file path in [[var:org-capture-template]], it will be
|
||||
resolved relative to [[var:org-directory]], instead of [[var:default-directory]] (see
|
||||
[[fn:+org--capture-expand-variable-file-a]]).
|
||||
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
|
@ -169,14 +169,14 @@ https://www.mfoot.com/blog/2015/11/22/literate-emacs-configuration-with-org-mode
|
|||
|
||||
This module has no hard requirements, but these soft requirements are needed to
|
||||
use Org's more esoteric features:
|
||||
- For inline LaTeX previews, ~latex~ and ~dvipng~ is needed.
|
||||
- To render GNUPlot images (with [[doom-module:][+gnuplot]] flag) the ~gnuplot~ program is needed.
|
||||
- For inline LaTeX previews, [[doom-executable:latex]] and [[doom-executable:dvipng]] is needed.
|
||||
- To render GNUPlot images (with [[doom-module:+gnuplot]] flag) the [[doom-executable:gnuplot]] program is needed.
|
||||
- To execute babel code blocks, you need whatever dependencies those languages
|
||||
need. It is recommended you enable the associated [[doom-module:][:lang]] module and ensure its
|
||||
dependencies are met, e.g. install the =ruby= executable for ruby support. To
|
||||
use ~jupyter kernels~ you need the [[doom-module:][+jupyter]] flag, the associated kernel as
|
||||
well as the ~jupyter~ program.
|
||||
- [[doom-package:][org-roam]] (with [[doom-module:][+roam]] or [[doom-module:][+roam2]] flag) requires =sqlite3= to be installed.
|
||||
need. It is recommended you enable the associated [[doom-module::lang]] module and ensure its
|
||||
dependencies are met, e.g. install the [[doom-executable:ruby]] executable for ruby support. To
|
||||
use ~jupyter kernels~ you need the [[doom-module:+jupyter]] flag, the associated kernel as
|
||||
well as the [[doom-executable:jupyter]] program.
|
||||
- [[doom-package:org-roam]] (with [[doom-module:+roam]] or [[doom-module:+roam2]] flag) requires [[doom-executable:sqlite3]] to be installed.
|
||||
|
||||
** MacOS
|
||||
#+begin_src sh
|
||||
|
@ -246,7 +246,7 @@ For =evil-mode= users, an overview of org-mode keybindings is provided [[https:/
|
|||
#+end_quote
|
||||
|
||||
** Changing ~org-directory~
|
||||
~org-directory~ must be set /before/ [[doom-package:][org]] has loaded:
|
||||
~org-directory~ must be set /before/ [[doom-package:org]] has loaded:
|
||||
#+begin_src emacs-lisp
|
||||
;; in $DOOMDIR/config.el
|
||||
(setq org-directory "~/new/org/location/")
|
||||
|
@ -263,9 +263,9 @@ For =evil-mode= users, an overview of org-mode keybindings is provided [[https:/
|
|||
|
||||
** =org-roam=
|
||||
*** Should I go with =+roam= (v1) or =+roam2= (v2)?
|
||||
Long story short: if you're new to [[doom-package:][org-roam]] and haven't used it, then you should
|
||||
go with [[doom-module:][+roam2]]; if you already have an ~org-roam-directory~ with the v1 files in
|
||||
it, then you can keep use [[doom-module:][+roam]] for a time being.
|
||||
Long story short: if you're new to [[doom-package:org-roam]] and haven't used it, then you should
|
||||
go with [[doom-module:+roam2]]; if you already have an ~org-roam-directory~ with the v1 files in
|
||||
it, then you can keep use [[doom-module:+roam]] for a time being.
|
||||
|
||||
V1 isn't actively maintained anymore and is now basically EOL. This means that
|
||||
the feature disparity between the both will continue to grow, while its existing
|
||||
|
@ -289,7 +289,7 @@ appear during the migration process. Because of that, *don't forget to backup*
|
|||
your ~org-roam-directory~ before attempting to migrate.
|
||||
|
||||
In order to migrate from v1 to v2 using Doom follow the next steps:
|
||||
1. Enable [[doom-module:][+roam2]] flag (and disable [[doom-module:][+roam]] if it was previously enabled) in your
|
||||
1. Enable [[doom-module:+roam2]] flag (and disable [[doom-module:+roam]] if it was previously enabled) in your
|
||||
=init.el=.
|
||||
2. Ensure your ~org-roam-directory~ points to a directory with your v1 files.
|
||||
3. Run ~$ doom sync -u~ in your shell.
|
||||
|
|
|
@ -31,24 +31,24 @@ This module adds support for PHP 5.3+ (including PHP7) to Doom Emacs.
|
|||
- +hack ::
|
||||
Add support for the [[https://hacklang.org/][Hack dialect of PHP]] by Facebook.
|
||||
- +lsp ::
|
||||
Enable LSP support for ~php-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~php-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports [[https://phpactor.readthedocs.io/en/develop/usage/standalone.html][phpactor]] and intelephense).
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][async]]
|
||||
- [[doom-package:][hack-mode]] if [[doom-module:][+hack]]
|
||||
- [[doom-package:][php-boris]]
|
||||
- [[doom-package:][php-cs-fixer]] if [[doom-package:][:editor format]]
|
||||
- [[doom-package:][php-extras]]
|
||||
- [[doom-package:][php-mode]]
|
||||
- [[doom-package:][php-refactor-mode]]
|
||||
- [[doom-package:][phpunit]]
|
||||
- if [[doom-module:][+lsp]]
|
||||
- [[doom-package:][phpactor]]
|
||||
- [[doom-package:][company-phpactor]]
|
||||
- [[doom-package:async]]
|
||||
- [[doom-package:hack-mode]] if [[doom-module:+hack]]
|
||||
- [[doom-package:php-boris]]
|
||||
- [[doom-package:php-cs-fixer]] if [[doom-package::editor format]]
|
||||
- [[doom-package:php-extras]]
|
||||
- [[doom-package:php-mode]]
|
||||
- [[doom-package:php-refactor-mode]]
|
||||
- [[doom-package:phpunit]]
|
||||
- if [[doom-module:+lsp]]
|
||||
- [[doom-package:phpactor]]
|
||||
- [[doom-package:company-phpactor]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
@ -62,7 +62,7 @@ This module adds support for PHP 5.3+ (including PHP7) to Doom Emacs.
|
|||
|
||||
This module requires ~php~ (5.3+) and ~composer~.
|
||||
|
||||
If [[doom-module:][+lsp]] is enabled, you'll also need one of these LSP servers:
|
||||
If [[doom-module:+lsp]] is enabled, you'll also need one of these LSP servers:
|
||||
- Phpactor requires ~php~ 7.3+.
|
||||
- Intelephense requires ~node~ and ~npm~.
|
||||
|
||||
|
|
|
@ -14,8 +14,8 @@ from plain text.
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][plantuml-mode]]
|
||||
- [[doom-package:][flycheck-plantuml]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:plantuml-mode]]
|
||||
- [[doom-package:flycheck-plantuml]] if [[doom-module::checkers syntax]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -11,13 +11,13 @@ This module adds [[https://www.purescript.org/][Purescript]] support to Doom Ema
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~purescript-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~purescript-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports [[https://github.com/nwolverson/purescript-language-server][purescript-language-server]]).
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][psci]]
|
||||
- [[doom-package:][psc-ide]]
|
||||
- [[doom-package:][purescript-mode]]
|
||||
- [[doom-package:psci]]
|
||||
- [[doom-package:psc-ide]]
|
||||
- [[doom-package:purescript-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -6,10 +6,10 @@
|
|||
* Description :unfold:
|
||||
This module adds [[https://www.python.org/][Python]] support to Doom Emacs.
|
||||
|
||||
- Syntax checking ([[doom-package:][flycheck]])
|
||||
- Syntax checking ([[doom-package:flycheck]])
|
||||
- Snippets
|
||||
- Run tests ([[doom-package:][nose]], [[doom-package:][pytest]])
|
||||
- Auto-format (with ~black~, requires [[doom-module:][:editor format]])
|
||||
- Run tests ([[doom-package:nose]], [[doom-package:pytest]])
|
||||
- Auto-format (with ~black~, requires [[doom-module::editor format]])
|
||||
- LSP integration (=mspyls=, =pyls=, or =pyright=)
|
||||
|
||||
** Maintainers
|
||||
|
@ -23,7 +23,7 @@ This module adds [[https://www.python.org/][Python]] support to Doom Emacs.
|
|||
- +cython ::
|
||||
Enable support for Cython files support.
|
||||
- +lsp ::
|
||||
Enable LSP support for ~python-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~python-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports mspyls, pyls, and pyright).
|
||||
- +poetry ::
|
||||
Enable Python packaging, dependency management, and virtual environment
|
||||
|
@ -31,33 +31,33 @@ This module adds [[https://www.python.org/][Python]] support to Doom Emacs.
|
|||
- +pyenv ::
|
||||
Enable Python virtual environment support via [[https://github.com/pyenv/pyenv][pyenv]]
|
||||
- +pyright ::
|
||||
Use the pyright LSP server instead of mspyls or pyls (requires [[doom-module:][+lsp]]).
|
||||
Use the pyright LSP server instead of mspyls or pyls (requires [[doom-module:+lsp]]).
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][anaconda-mode]]
|
||||
- [[doom-package:][conda]]
|
||||
- [[doom-package:][nose]]
|
||||
- [[doom-package:][pipenv]]
|
||||
- [[doom-package:][pip-requirements]]
|
||||
- [[doom-package:][poetry]] if [[doom-module:][+poetry]]
|
||||
- [[doom-package:][pyenv]]
|
||||
- [[doom-package:][pyimport]]
|
||||
- [[doom-package:][py-isort]]
|
||||
- [[doom-package:][python-pytest]]
|
||||
- if [[doom-module:][+cython]]
|
||||
- [[doom-package:][cython-mode]]
|
||||
- [[doom-package:][flycheck-cython]] if [[doom-module:][:checkers syntax]]
|
||||
- if [[doom-module:][+lsp]]
|
||||
- if [[doom-module:][+pyright]]
|
||||
- [[doom-package:][lsp-pyright]]
|
||||
- [[doom-package:anaconda-mode]]
|
||||
- [[doom-package:conda]]
|
||||
- [[doom-package:nose]]
|
||||
- [[doom-package:pipenv]]
|
||||
- [[doom-package:pip-requirements]]
|
||||
- [[doom-package:poetry]] if [[doom-module:+poetry]]
|
||||
- [[doom-package:pyenv]]
|
||||
- [[doom-package:pyimport]]
|
||||
- [[doom-package:py-isort]]
|
||||
- [[doom-package:python-pytest]]
|
||||
- if [[doom-module:+cython]]
|
||||
- [[doom-package:cython-mode]]
|
||||
- [[doom-package:flycheck-cython]] if [[doom-module::checkers syntax]]
|
||||
- if [[doom-module:+lsp]]
|
||||
- if [[doom-module:+pyright]]
|
||||
- [[doom-package:lsp-pyright]]
|
||||
- else
|
||||
- [[doom-package:][lsp-python-ms]]
|
||||
- [[doom-package:lsp-python-ms]]
|
||||
|
||||
** Hacks
|
||||
- [[doom-package:][anaconda-mode]] is configured to activate when [[doom-package:][lsp-mode]] (or [[doom-package:][eglot]]) don't -- or
|
||||
- [[doom-package:anaconda-mode]] is configured to activate when [[doom-package:lsp-mode]] (or [[doom-package:eglot]]) don't -- or
|
||||
fail to.
|
||||
|
||||
** TODO Changelog
|
||||
|
@ -71,9 +71,9 @@ This module has no hard requirements, but softly depends on:
|
|||
- For this module's supported test runners:
|
||||
- ~$ pip install pytest~
|
||||
- ~$ pip install nose~
|
||||
- The [[doom-module:][:editor format]] module uses Black for python files: ~$ pip install black~
|
||||
- [[doom-package:][pyimport]] requires Python's module ~pyflakes~: ~$ pip install pyflakes~
|
||||
- [[doom-package:][py-isort]] requires [[https://github.com/timothycrosley/isort][isort]] to be installed: ~pip install isort~
|
||||
- The [[doom-module::editor format]] module uses Black for python files: ~$ pip install black~
|
||||
- [[doom-package:pyimport]] requires Python's module ~pyflakes~: ~$ pip install pyflakes~
|
||||
- [[doom-package:py-isort]] requires [[https://github.com/timothycrosley/isort][isort]] to be installed: ~pip install isort~
|
||||
- Python virtual environments install instructions at:
|
||||
- [[https://github.com/pyenv/pyenv][pyenv]]
|
||||
- [[https://conda.io/en/latest/][Conda]]
|
||||
|
@ -82,9 +82,9 @@ This module has no hard requirements, but softly depends on:
|
|||
- ~cython~ requires [[https://cython.org/][Cython]]
|
||||
|
||||
** Language Server Protocol Support
|
||||
For LSP support the [[doom-module:][:tools lsp]] module must be enabled, along with this module's
|
||||
[[doom-module:][+lsp]] flag. By default, it supports [[doom-package:][mspyls]] and [[doom-package:][pyls]], in that order. With the
|
||||
[[doom-module:][+pyright]] flag, it will try Pyright first.
|
||||
For LSP support the [[doom-module::tools lsp]] module must be enabled, along with this module's
|
||||
[[doom-module:+lsp]] flag. By default, it supports [[doom-package:mspyls]] and [[doom-package:pyls]], in that order. With the
|
||||
[[doom-module:+pyright]] flag, it will try Pyright first.
|
||||
|
||||
Each of these servers must be installed on your system via your OS package
|
||||
manager or manually:
|
||||
|
@ -101,7 +101,7 @@ manager or manually:
|
|||
This module supports LSP. It requires installation of [[https://pypi.org/project/python-language-server/][Python Language Server]],
|
||||
[[https://github.com/Microsoft/python-language-server][Microsoft Language Server]], or [[https://github.com/microsoft/pyright][pyright]], see [[Language Server Protocol Support][LSP Support]].
|
||||
|
||||
To enable support for auto-formatting with black enable [[doom-module:][:editor format]].
|
||||
To enable support for auto-formatting with black enable [[doom-module::editor format]].
|
||||
|
||||
** Keybindings
|
||||
| Binding | Description |
|
||||
|
|
|
@ -16,8 +16,8 @@ This module provides language functionality for [[https://qt.io][Qt]] specific f
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][qml-mode]]
|
||||
- [[doom-package:][qt-pro-mode]]
|
||||
- [[doom-package:qml-mode]]
|
||||
- [[doom-package:qt-pro-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -11,14 +11,14 @@ This module adds support for the [[https://www.racket-lang.org/][Racket programm
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable support for ~racket-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable support for ~racket-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports [[https://github.com/jeapostrophe/racket-langserver][racket-langserver]]).
|
||||
- +xp ::
|
||||
Enable the explore mode (~racket-xp-mode~), which "analyzes expanded code to
|
||||
explain and explore."
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][racket-mode]]
|
||||
- [[doom-package:racket-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -13,8 +13,8 @@ This module adds support for the [[https://www.raku.org/][Raku programming langu
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][raku-mode]]
|
||||
- [[doom-package:][flycheck-raku]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:raku-mode]]
|
||||
- [[doom-package:flycheck-raku]] if [[doom-module::checkers syntax]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -29,15 +29,15 @@ This module turns Emacs into a [[https://en.wikipedia.org/wiki/Representational_
|
|||
*Requires the =jq= command line utility.*
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][company-restclient]] if [[doom-module:][:completion company]]
|
||||
- [[doom-package:][restclient]]
|
||||
- if [[doom-module:][+jq]]
|
||||
- [[doom-package:][restclient-jq]]
|
||||
- [[doom-package:][jq-mode]]
|
||||
- [[doom-package:company-restclient]] if [[doom-module::completion company]]
|
||||
- [[doom-package:restclient]]
|
||||
- if [[doom-module:+jq]]
|
||||
- [[doom-package:restclient-jq]]
|
||||
- [[doom-package:jq-mode]]
|
||||
|
||||
** Hacks
|
||||
- Adds imenu support to ~restclient-mode~.
|
||||
- [[doom-package:][restclient]] has been modified not to silently reject self-signed or invalid
|
||||
- [[doom-package:restclient]] has been modified not to silently reject self-signed or invalid
|
||||
certificates.
|
||||
|
||||
** TODO Changelog
|
||||
|
|
|
@ -13,7 +13,7 @@ This module adds [[https://docutils.sourceforge.io/rst.html][ReStructured Text]]
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][sphinx-mode]]
|
||||
- [[doom-package:sphinx-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -6,11 +6,11 @@
|
|||
* Description :unfold:
|
||||
This module add Ruby and optional Ruby on Rails support to Emacs.
|
||||
|
||||
- Code completion ([[doom-package:][robe]])
|
||||
- Syntax checking ([[doom-package:][flycheck]])
|
||||
- Jump-to-definitions ([[doom-package:][robe]])
|
||||
- Code completion ([[doom-package:robe]])
|
||||
- Syntax checking ([[doom-package:flycheck]])
|
||||
- Jump-to-definitions ([[doom-package:robe]])
|
||||
- Bundler
|
||||
- Rubocop integration ([[doom-package:][flycheck]])
|
||||
- Rubocop integration ([[doom-package:flycheck]])
|
||||
|
||||
** Maintainers
|
||||
- [[doom-user:][@hlissner]]
|
||||
|
@ -21,7 +21,7 @@ This module add Ruby and optional Ruby on Rails support to Emacs.
|
|||
- +chruby ::
|
||||
Enable chruby integration.
|
||||
- +lsp ::
|
||||
Enable LSP support for ~ruby-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~ruby-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports solargraph).
|
||||
- +rails ::
|
||||
Enable rails navigational commands, plus server+console integration.
|
||||
|
@ -31,23 +31,23 @@ This module add Ruby and optional Ruby on Rails support to Emacs.
|
|||
Enable RVM (Ruby Version Manager) integration.
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][bundler]]
|
||||
- [[doom-package:][chruby]] if [[doom-module:][+chruby]]
|
||||
- [[doom-package:][company-inf-ruby]] if :completion company
|
||||
- [[doom-package:][inf-ruby]]
|
||||
- [[doom-package:][minitest]]
|
||||
- [[doom-package:][rake]]
|
||||
- [[doom-package:][rbenv]] if [[doom-module:][+rbenv]]
|
||||
- [[doom-package:][robe]]
|
||||
- [[doom-package:][rspec-mode]]
|
||||
- [[doom-package:][rubocop]]
|
||||
- [[doom-package:][rvm]] if [[doom-module:][+rvm]]
|
||||
- if [[doom-module:][+rails]]
|
||||
- [[doom-package:][inflections]]
|
||||
- [[doom-package:][projectile-rails]]
|
||||
- [[doom-package:bundler]]
|
||||
- [[doom-package:chruby]] if [[doom-module:+chruby]]
|
||||
- [[doom-package:company-inf-ruby]] if :completion company
|
||||
- [[doom-package:inf-ruby]]
|
||||
- [[doom-package:minitest]]
|
||||
- [[doom-package:rake]]
|
||||
- [[doom-package:rbenv]] if [[doom-module:+rbenv]]
|
||||
- [[doom-package:robe]]
|
||||
- [[doom-package:rspec-mode]]
|
||||
- [[doom-package:rubocop]]
|
||||
- [[doom-package:rvm]] if [[doom-module:+rvm]]
|
||||
- if [[doom-module:+rails]]
|
||||
- [[doom-package:inflections]]
|
||||
- [[doom-package:projectile-rails]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -7,9 +7,9 @@
|
|||
This module adds support for the Rust language and integration for its tools,
|
||||
e.g. ~cargo~.
|
||||
|
||||
- Code completion ([[doom-package:][racer]] or an LSP server)
|
||||
- Syntax checking ([[doom-package:][flycheck]])
|
||||
- LSP support (for rust-analyzer and rls) ([[doom-package:][rustic]])
|
||||
- Code completion ([[doom-package:racer]] or an LSP server)
|
||||
- Syntax checking ([[doom-package:flycheck]])
|
||||
- LSP support (for rust-analyzer and rls) ([[doom-package:rustic]])
|
||||
- Snippets
|
||||
|
||||
** Maintainers
|
||||
|
@ -19,15 +19,15 @@ e.g. ~cargo~.
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~rustic-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~rustic-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports [[https://rust-analyzer.github.io/][rust-analyzer]] and rls).
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][rustic]]
|
||||
- [[doom-package:rustic]]
|
||||
|
||||
** Hacks
|
||||
- rustic has been modified /not/ to automatically install lsp-mode or eglot if
|
||||
they're missing. Doom expects you to have enabled the [[doom-module:][:tools lsp]] module
|
||||
they're missing. Doom expects you to have enabled the [[doom-module::tools lsp]] module
|
||||
yourself.
|
||||
|
||||
** TODO Changelog
|
||||
|
@ -49,9 +49,9 @@ rustup update --no-self-update
|
|||
#+end_src
|
||||
|
||||
** Other Requirements
|
||||
- If [[doom-module:][:editor format]] is enabled, you'll need =rustfmt=: ~$ rustup component add
|
||||
- If [[doom-module::editor format]] is enabled, you'll need =rustfmt=: ~$ rustup component add
|
||||
rustfmt-preview~.
|
||||
- Users with [[doom-module:][+lsp]] enabled will need [[https://rust-analyzer.github.io/][rust-analyzer]] (rls is supported, but
|
||||
- Users with [[doom-module:+lsp]] enabled will need [[https://rust-analyzer.github.io/][rust-analyzer]] (rls is supported, but
|
||||
[[https://blog.rust-lang.org/2022/07/01/RLS-deprecation.html][deprecated]]).
|
||||
- Using the following commands requires:
|
||||
- ~cargo-process-check~: ~$ cargo install cargo-check~
|
||||
|
@ -67,11 +67,11 @@ This module supports LSP integration. For it to work you'll need:
|
|||
|
||||
1. To install [[https://github.com/rust-analyzer/rust-analyzer][rust-analyzer]] through your OS package manager ([[https://github.com/rust-lang/rls][RLS]] is supported
|
||||
too, but it is [[https://blog.rust-lang.org/2022/07/01/RLS-deprecation.html][deprecated]]).
|
||||
2. To enable the [[doom-module:][:tools lsp]] module.
|
||||
3. To enable the [[doom-module:][+lsp]] flag on this module.
|
||||
2. To enable the [[doom-module::tools lsp]] module.
|
||||
3. To enable the [[doom-module:+lsp]] flag on this module.
|
||||
|
||||
** Format on save
|
||||
Enable [[doom-module:][:editor format +onsave]] to get formatting on save with =rustfmt=. No
|
||||
Enable [[doom-module::editor format +onsave]] to get formatting on save with =rustfmt=. No
|
||||
additional configuration is necessary.
|
||||
|
||||
** Keybinds
|
||||
|
@ -95,7 +95,7 @@ additional configuration is necessary.
|
|||
#+end_quote
|
||||
|
||||
** Enabling eglot support for Rust
|
||||
Doom's [[doom-module:][:tools lsp]] module has an [[doom-module:][+eglot]] flag. Enable it and this module will use
|
||||
Doom's [[doom-module::tools lsp]] module has an [[doom-module:+eglot]] flag. Enable it and this module will use
|
||||
eglot instead.
|
||||
|
||||
* Troubleshooting
|
||||
|
@ -104,7 +104,7 @@ eglot instead.
|
|||
** error[E0670]: `async fn` is not permitted in the 2015 edition
|
||||
You may be seeing this error, despite having ~edition = "2018"~ in your
|
||||
=Cargo.toml=. This error actually originates from ~rustfmt~, which the LSP
|
||||
server tries to invoke on save (if you have ~rustic-format-trigger~ or [[doom-module:][:editor
|
||||
server tries to invoke on save (if you have ~rustic-format-trigger~ or [[doom-module::editor
|
||||
format]] enabled).
|
||||
|
||||
To fix this your project needs a =rustfmt.toml= with ~edition = "2018"~ in it.
|
||||
|
|
|
@ -26,16 +26,16 @@ Through the power of [[https://scalameta.org/metals/docs/editors/overview.html][
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~scala-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~scala-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports metals).
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][sbt-mode]]
|
||||
- [[doom-package:][scala-mode]]
|
||||
- [[doom-package:][lsp-metals]] if [[doom-module:][+lsp]]
|
||||
- [[doom-package:sbt-mode]]
|
||||
- [[doom-package:scala-mode]]
|
||||
- [[doom-package:lsp-metals]] if [[doom-module:+lsp]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -22,18 +22,18 @@ This module provides support for the Scheme family of Lisp languages, powered by
|
|||
- +racket ::
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][flycheck-guile]] if [[doom-module:][+guile]] and [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:][geiser]]
|
||||
- [[doom-package:][geiser-chez]] if [[doom-module:][+chez]]
|
||||
- [[doom-package:][geiser-chibi]] if [[doom-module:][+chibi]]
|
||||
- [[doom-package:][geiser-chicken]] if [[doom-module:][+chicken]]
|
||||
- [[doom-package:][geiser-gambit]] if [[doom-module:][+gambit]]
|
||||
- [[doom-package:][geiser-gauche]] if [[doom-module:][+gauche]]
|
||||
- [[doom-package:][geiser-guile]] if [[doom-module:][+guile]]
|
||||
- [[doom-package:][geiser-kawa]] if [[doom-module:][+kawa]]
|
||||
- [[doom-package:][geiser-mit]] if [[doom-module:][+mit]]
|
||||
- [[doom-package:][geiser-racket]] if [[doom-module:][+racket]]
|
||||
- [[doom-package:][macrostep-geiser]]
|
||||
- [[doom-package:flycheck-guile]] if [[doom-module:+guile]] and [[doom-module::checkers syntax]]
|
||||
- [[doom-package:geiser]]
|
||||
- [[doom-package:geiser-chez]] if [[doom-module:+chez]]
|
||||
- [[doom-package:geiser-chibi]] if [[doom-module:+chibi]]
|
||||
- [[doom-package:geiser-chicken]] if [[doom-module:+chicken]]
|
||||
- [[doom-package:geiser-gambit]] if [[doom-module:+gambit]]
|
||||
- [[doom-package:geiser-gauche]] if [[doom-module:+gauche]]
|
||||
- [[doom-package:geiser-guile]] if [[doom-module:+guile]]
|
||||
- [[doom-package:geiser-kawa]] if [[doom-module:+kawa]]
|
||||
- [[doom-package:geiser-mit]] if [[doom-module:+mit]]
|
||||
- [[doom-package:geiser-racket]] if [[doom-module:+racket]]
|
||||
- [[doom-package:macrostep-geiser]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
@ -53,7 +53,7 @@ associated Schemes, namely:
|
|||
- [[https://synthcode.com/scheme/chibi][Chibi Scheme]] 0.7.3 or better
|
||||
- [[https://www.scheme.com][Chez Scheme]] 9.4 or better
|
||||
|
||||
Their executables must be present in your =$PATH= for [[doom-package:][geiser]] to work properly.
|
||||
Their executables must be present in your =$PATH= for [[doom-package:geiser]] to work properly.
|
||||
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
|
|
|
@ -7,8 +7,8 @@
|
|||
This module adds support for shell scripting languages (including Powershell and
|
||||
Fish script) to Doom Emacs.
|
||||
|
||||
- Code completion ([[doom-package:][company-shell]])
|
||||
- Syntax Checking ([[doom-package:][flycheck]])
|
||||
- Code completion ([[doom-package:company-shell]])
|
||||
- Syntax Checking ([[doom-package:flycheck]])
|
||||
|
||||
** Maintainers
|
||||
- [[doom-user:][@hlissner]]
|
||||
|
@ -19,18 +19,18 @@ Fish script) to Doom Emacs.
|
|||
- +fish ::
|
||||
Add syntax highlighting for fish script files.
|
||||
- +lsp ::
|
||||
Enable LSP support for ~sh-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~sh-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports bash-language-server).
|
||||
- +powershell ::
|
||||
Add syntax highlighting for Powershell script files (=.ps1= and =.psm1=).
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][company-shell]] if [[doom-module:][:completion company]]
|
||||
- [[doom-package:][fish-mode]] if [[doom-module:][+fish]]
|
||||
- [[doom-package:][powershell-mode]] if [[doom-module:][+powershell]]
|
||||
- [[doom-package:company-shell]] if [[doom-module::completion company]]
|
||||
- [[doom-package:fish-mode]] if [[doom-module:+fish]]
|
||||
- [[doom-package:powershell-mode]] if [[doom-module:+powershell]]
|
||||
|
||||
** Hacks
|
||||
- Interpolated variables are fontified.
|
||||
|
@ -45,8 +45,8 @@ Fish script) to Doom Emacs.
|
|||
This module has several optional dependencies:
|
||||
|
||||
- [[https://github.com/koalaman/shellcheck][shellcheck]]: Enables advanced shell script linting.
|
||||
- [[https://github.com/mads-hartmann/bash-language-server][bash-language-server]]: Enables LSP support (with [[doom-module:][+lsp]] flag).
|
||||
- With the [[doom-module:][:tools debugger]] module
|
||||
- [[https://github.com/mads-hartmann/bash-language-server][bash-language-server]]: Enables LSP support (with [[doom-module:+lsp]] flag).
|
||||
- With the [[doom-module::tools debugger]] module
|
||||
- [[http://bashdb.sourceforge.net/][bashdb]]: Enables debugging for bash scripts
|
||||
- [[https://github.com/rocky/zshdb][zshdb]]: Enables debugging for zsh scripts
|
||||
|
||||
|
|
|
@ -13,8 +13,8 @@ THis module adds [[https://smlfamily.github.io/][SML (Standard ML) programming l
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][company-mlton]] if [[doom-module:][:completion company]]
|
||||
- [[doom-package:][sml-mode]]
|
||||
- [[doom-package:company-mlton]] if [[doom-module::completion company]]
|
||||
- [[doom-package:sml-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -6,8 +6,8 @@
|
|||
* Description :unfold:
|
||||
This module adds [[https://github.com/ethereum/solidity][Solidity]] support to Doom Emacs.
|
||||
|
||||
- Syntax-checking ([[doom-package:][flycheck]])
|
||||
- Code completion ([[doom-package:][company-solidity]])
|
||||
- Syntax-checking ([[doom-package:flycheck]])
|
||||
- Code completion ([[doom-package:company-solidity]])
|
||||
- Gas estimation (~C-c C-g~)
|
||||
|
||||
** Maintainers
|
||||
|
@ -17,9 +17,9 @@ This module adds [[https://github.com/ethereum/solidity][Solidity]] support to D
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][company-solidity]] if [[doom-module:][:completion company]]
|
||||
- [[doom-package:][solidity-flycheck]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:][solidity-mode]]
|
||||
- [[doom-package:company-solidity]] if [[doom-module::completion company]]
|
||||
- [[doom-package:solidity-flycheck]] if [[doom-module::checkers syntax]]
|
||||
- [[doom-package:solidity-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -11,19 +11,19 @@ This module adds support for the [[https://developer.apple.com/swift/][Swift pro
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~swift-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
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]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][swift-mode]]
|
||||
- if [[doom-module:][+lsp]]
|
||||
- [[doom-package:][lsp-sourcekit]]
|
||||
- [[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]]
|
||||
- [[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./
|
||||
|
|
|
@ -13,8 +13,8 @@
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][company-lua]] if [[doom-module:][:completion company]]
|
||||
- [[doom-package:][terra-mode]]
|
||||
- [[doom-package:company-lua]] if [[doom-module::completion company]]
|
||||
- [[doom-package:terra-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -15,26 +15,26 @@ ReactJS, Wordpress, Jekyll, Phaser, AngularJS, Djano, and more.
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~web-mode~ and ~css-mode~. Requires [[doom-module:][:tools lsp]] and a
|
||||
Enable LSP support for ~web-mode~ and ~css-mode~. Requires [[doom-module::tools lsp]] and a
|
||||
langserver.
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][company-web]] if [[doom-module:][:completion company]]
|
||||
- [[doom-package:][counsel-css]] if [[doom-module:][:completion ivy]]
|
||||
- [[doom-package:][emmet-mode]]
|
||||
- [[doom-package:][haml-mode]]
|
||||
- [[doom-package:][helm-css-scss]] if [[doom-module:][:completion helm]]
|
||||
- [[doom-package:][less-css-mode]]
|
||||
- [[doom-package:][pug-mode]]
|
||||
- [[doom-package:][rainbow-mode]]
|
||||
- [[doom-package:][sass-mode]]
|
||||
- [[doom-package:][slim-mode]]
|
||||
- [[doom-package:][stylus-mode]]
|
||||
- [[doom-package:][sws-mode]]
|
||||
- [[doom-package:][web-mode]]
|
||||
- [[doom-package:company-web]] if [[doom-module::completion company]]
|
||||
- [[doom-package:counsel-css]] if [[doom-module::completion ivy]]
|
||||
- [[doom-package:emmet-mode]]
|
||||
- [[doom-package:haml-mode]]
|
||||
- [[doom-package:helm-css-scss]] if [[doom-module::completion helm]]
|
||||
- [[doom-package:less-css-mode]]
|
||||
- [[doom-package:pug-mode]]
|
||||
- [[doom-package:rainbow-mode]]
|
||||
- [[doom-package:sass-mode]]
|
||||
- [[doom-package:slim-mode]]
|
||||
- [[doom-package:stylus-mode]]
|
||||
- [[doom-package:sws-mode]]
|
||||
- [[doom-package:web-mode]]
|
||||
|
||||
** TODO Hacks
|
||||
#+begin_quote
|
||||
|
|
|
@ -11,11 +11,11 @@ This module provides support for the [[https://yaml.org/][YAML file format]] to
|
|||
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable LSP support for ~yaml-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
Enable LSP support for ~yaml-mode~. Requires [[doom-module::tools lsp]] and a langserver
|
||||
(supports [[https://github.com/redhat-developer/yaml-language-server][yaml-language-server]]).
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][yaml-mode]]
|
||||
- [[doom-package:yaml-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
@ -8,7 +8,7 @@ This module adds [[https://ziglang.org/][Zig]] support, with optional (but recom
|
|||
[[https://github.com/zigtools/zls][zls]].
|
||||
|
||||
- Syntax highlighting
|
||||
- Syntax-checking ([[doom-package:][flycheck]])
|
||||
- Syntax-checking ([[doom-package:flycheck]])
|
||||
- Code completion and LSP integration (~zls~)
|
||||
|
||||
** Maintainers
|
||||
|
@ -22,10 +22,10 @@ This module adds [[https://ziglang.org/][Zig]] support, with optional (but recom
|
|||
this.
|
||||
- +tree-sitter ::
|
||||
Leverages tree-sitter for better syntax highlighting and structural text
|
||||
editing. Requires [[doom-module:][:tools tree-sitter]].
|
||||
editing. Requires [[doom-module::tools tree-sitter]].
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][zig-mode]]
|
||||
- [[doom-package:zig-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
@ -52,8 +52,8 @@ systems are available for download from [[https://ziglang.org/download/]] or fro
|
|||
This module supports LSP integration. For it to work you'll need:
|
||||
|
||||
1. zls installed,
|
||||
2. The [[doom-module:][:tools lsp]] module enabled. Only [[doom-package:][lsp-mode]] is supported for now,
|
||||
3. The [[doom-module:][+lsp]] flag on this module enabled.
|
||||
2. The [[doom-module::tools lsp]] module enabled. Only [[doom-package:lsp-mode]] is supported for now,
|
||||
3. The [[doom-module:+lsp]] flag on this module enabled.
|
||||
|
||||
** Keybinds
|
||||
| Binding | Description |
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue