{"categories":[{"label":"Documentation","url":"https://skillfed.io/packages/category/software-development-documentation"}],"enrichment":{"capability":"A Sphinx extension that automatically lints shell code blocks in documentation using the shellcheck utility, reporting shell script errors and style issues during the documentation build.","skillfed_tags":["sphinx-extension","shell-linting","abandoned"],"use_cases":["Validate shell scripts embedded in installation guides or deployment documentation before publishing.","Catch common shell scripting mistakes in code examples during CI/CD documentation builds.","Enforce consistent shell style across multiple documentation files in a large project.","Document shell commands with automatic verification that they follow best practices."],"what_it_does":"sphinxcontrib-shellcheck is a Sphinx documentation builder extension that integrates the shellcheck linter into your documentation build process. It scans bash, sh, dash, and ksh code blocks embedded in reStructuredText files and reports shell script errors, style violations, and potential bugs with line and column references.\n\nThe extension runs as a custom Sphinx builder (invoked with `sphinx-build -b shellcheck`) and processes code blocks marked with shell language directives. It relies on the external shellcheck utility to perform the actual linting and outputs violations to both the console and a log file. Configuration options allow you to specify shell dialects, the shellcheck executable path, terminal prompt character, and debug verbosity.","worth_installing":"No. The package is abandoned (last release March 2020) and has not been updated for modern Python or Sphinx versions. While it has low install friction and a permissive MIT license, the lack of maintenance means it will not receive bug fixes, security updates, or compatibility patches. If you need shell linting in Sphinx documentation, consider maintaining a fork or evaluating active alternatives."},"id":"sphinxcontrib-shellcheck","links":{"html":"https://skillfed.io/packages/sphinxcontrib-shellcheck","md":"https://skillfed.io/packages/sphinxcontrib-shellcheck.md","pypi":"https://pypi.org/project/sphinxcontrib-shellcheck/"},"maintenance":{"status":"abandoned"},"meta":{"latest_release":"2020-03-30","license_spdx":null,"license_treatment":"permissive","name":"sphinxcontrib-shellcheck","python_support":"unspecified","summary":"Sphinx extension to lint shell code blocks"},"popularity":{"monthly_downloads":76715,"position":14597,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"1.1.2"}