These optional dotfiles indicate the root of a module or module group (:lang), and will later contain module metadata. They will also serve as an alternative to packages.el and doctor.el, and will aide the parts of the v3.0 module API concerned with resolving the current module from a path (`doom-module-from-path`), which currently rely too heavily on parsing path strings. For now, however, they're simply placeholders. |
||
---|---|---|
.. | ||
.doommodule | ||
autoload.el | ||
config.el | ||
doctor.el | ||
packages.el | ||
README.org |
:lang sh
Description unfold
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)
Maintainers
Module flags
- +fish
- Add syntax highlighting for fish script files.
- +lsp
-
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.
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
Hacks
- Interpolated variables are fontified.
TODO Changelog
This module does not have a changelog yet.
Installation
Enable this module in your doom!
block.
This module has several optional dependencies:
- shellcheck: Enables advanced shell script linting.
- bash-language-server: Enables LSP support (with doom-module:+lsp flag).
-
With the doom-module::tools debugger module
-
With the doom-module::editor format module
- shfmt: Enables formatting for {posix,ba,mk}sh scripts
TODO Usage
This module has no usage documentation yet. Write some?
TODO Configuration
This module has no configuration documentation yet. Write some?
Troubleshooting
There are no known problems with this module. Report one?
Frequently asked questions
This module has no FAQs yet. Ask one?
TODO Appendix
This module has no appendix yet. Write one?