doomemacs/modules/lang/sh

:lang sh

• Description
  • Maintainers
  • Module flags
  • Packages
  • Hacks
  • Changelog
• Installation
• Usage
• Configuration
• Troubleshooting
• Frequently asked questions
• Appendix

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

• @hlissner

Become a maintainer?

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

  • bashdb: Enables debugging for bash scripts
  • zshdb: Enables debugging for zsh 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?