mirror of https://github.com/doomemacs/doomemacs synced 2025-08-01 12:17:25 -05:00

Files

Henrik Lissner 1f8bf7accb merge: rewrite-docs

I've omitted docs/*.org from this merge, as there is still work left to
do there, but I am pushing the module docs early so folks can benefit
from the new docs sooner.

2022-08-03 03:27:50 +02:00

autoload.el

lang/sh: use (wo)man for docs lookup handler

2021-02-23 20:32:34 -05:00

config.el

refactor(:lang): move tree-sitter init

2022-07-25 17:34:44 +02:00

doctor.el

docs(sh): add doctor check for shfmt

2022-07-23 16:32:16 +02:00

packages.el

bump: :lang

2022-03-31 21:09:38 +02:00

README.org

fix(docs): set mode in file-local vars

2022-08-03 02:46:33 +02:00

README.org

: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 (company-shell)
Syntax Checking (flycheck)

Maintainers

@hlissner

Become a maintainer?

Module flags

+fish: Add syntax highlighting for fish script files.
+lsp: Enable LSP support for sh-mode. Requires :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 :tools tree-sitter.

Packages

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 +lsp flag).
With the :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?