Skip to content

Latest commit

 

History

History
49 lines (36 loc) · 9.83 KB

README.md

File metadata and controls

49 lines (36 loc) · 9.83 KB

coc-sh

SH language server extension using bash-language-server for coc.nvim.

Install

In your vim/neovim, run command:

:CocInstall coc-sh

Features

See bash-language-server

Configuration options

Key Description Default
sh.enable true
sh.commandPath
bashIde.backgroundAnalysisMaxFiles Maximum number of files to analyze in the background. Set to 0 to disable background analysis. 500
bashIde.enableSourceErrorDiagnostics Enable diagnostics for source errors. Ignored if includeAllWorkspaceSymbols is true.
bashIde.explainshellEndpoint Configure explainshell server endpoint in order to get hover documentation on flags and options.
bashIde.globPattern Glob pattern for finding and parsing shell script files in the workspace. Used by the background analysis features across files. `**/*@(.sh
bashIde.includeAllWorkspaceSymbols Controls how symbols (e.g. variables and functions) are included and used for completion, documentation, and renaming. If false (default and recommended), then we only include symbols from sourced files (i.e. using non dynamic statements like 'source file.sh' or '. file.sh' or following ShellCheck directives). If true, then all symbols from the workspace are included.
bashIde.logLevel Controls the log level of the language server. info
bashIde.shellcheckPath Controls the executable used for ShellCheck linting information. An empty string will disable linting. shellcheck
bashIde.shellcheckArguments Additional ShellCheck arguments. Note that we already add the following arguments: --shell, --format, --external-sources.
bashIde.shfmt.path Controls the executable used for Shfmt formatting. An empty string will disable formatting. shfmt
bashIde.shfmt.ignoreEditorconfig Ignore shfmt config options in .editorconfig (always use language server config)
bashIde.shfmt.languageDialect Language dialect to use when parsing (bash/posix/mksh/bats). auto
bashIde.shfmt.binaryNextLine Allow boolean operators (like && and
bashIde.shfmt.caseIndent Indent patterns in case statements.
bashIde.shfmt.funcNextLine Place function opening braces on a separate line.
bashIde.shfmt.keepPadding (Deprecated) Keep column alignment padding.
bashIde.shfmt.simplifyCode Simplify code before formatting.
bashIde.shfmt.spaceRedirects Follow redirection operators with a space.

Trigger completion in coc-settings.json to get complete list.

Development

  1. Run npm run build or npm run build:watch
  2. Link extension: npm run link / npm run unlink

License

MIT © Josa Gesell