{"id":13443425,"url":"https://github.com/federicotdn/flymake-shellcheck","last_synced_at":"2025-05-09T01:45:22.481Z","repository":{"id":40508258,"uuid":"145578982","full_name":"federicotdn/flymake-shellcheck","owner":"federicotdn","description":"A ShellCheck-powered backend for Flymake","archived":false,"fork":false,"pushed_at":"2024-06-26T21:22:42.000Z","size":35,"stargazers_count":57,"open_issues_count":4,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-09T01:45:19.383Z","etag":null,"topics":["bash","emacs","flymake","sh","shell","shellcheck"],"latest_commit_sha":null,"homepage":"","language":"Emacs Lisp","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/federicotdn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-08-21T14:54:48.000Z","updated_at":"2025-05-07T12:27:19.000Z","dependencies_parsed_at":"2024-10-26T20:29:53.374Z","dependency_job_id":"49dd6022-9cec-45af-bfb8-ed217e9afdf9","html_url":"https://github.com/federicotdn/flymake-shellcheck","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/federicotdn%2Fflymake-shellcheck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/federicotdn%2Fflymake-shellcheck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/federicotdn%2Fflymake-shellcheck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/federicotdn%2Fflymake-shellcheck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/federicotdn","download_url":"https://codeload.github.com/federicotdn/flymake-shellcheck/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253176443,"owners_count":21866142,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","emacs","flymake","sh","shell","shellcheck"],"created_at":"2024-07-31T03:02:00.542Z","updated_at":"2025-05-09T01:45:22.452Z","avatar_url":"https://github.com/federicotdn.png","language":"Emacs Lisp","funding_links":[],"categories":["Emacs Lisp"],"sub_categories":[],"readme":"# flymake-shellcheck (maintenance mode)\n[![MELPA](https://melpa.org/packages/flymake-shellcheck-badge.svg)](https://melpa.org/#/flymake-shellcheck)\n![License](https://img.shields.io/github/license/federicotdn/flymake-shellcheck.svg)\n\n\u003e **Note:** If you're using Emacs version 29 or higher, installing this package is not necessary, as the Flymake-Shellcheck integration is now built-in into the editor. This project is now in maintenance mode; no new features or enhancements will be made for it, unless they are required for security reasons.\n\nAn Emacs (26+) Flymake handler for bash/sh scripts, using [ShellCheck](https://github.com/koalaman/shellcheck). Installing Flymake is not necessary as it is included with Emacs itself.\n\n## Installation\nFirst, make sure ShellCheck is installed by following [the installation guide](https://github.com/koalaman/shellcheck#installing). After that, you can install `flymake-shellcheck` by using the `package-install` command (make sure [MELPA](https://melpa.org/) is included in your package sources):\n\n\u003ckbd\u003eM-x\u003c/kbd\u003e `package-install` \u003ckbd\u003eRET\u003c/kbd\u003e `flymake-shellcheck` \u003ckbd\u003eRET\u003c/kbd\u003e\n\nAlternatively, you can just add `flymake-shellcheck.el` to your `load-path`.\n\n## Usage\nTo enable the Flymake backend whenever a bash or sh script is visited, add the following to your `init.el` file:\n\n```elisp\n(add-hook 'sh-mode-hook 'flymake-shellcheck-load)\n```\n\nIf you're using [`use-package`](https://github.com/jwiegley/use-package), try this instead:\n\n```elisp\n(use-package flymake-shellcheck\n  :commands flymake-shellcheck-load\n  :init\n  (add-hook 'sh-mode-hook 'flymake-shellcheck-load))\n```\n\nAfter opening a shell/sh file, remember to enable Flymake:\n\n\u003ckbd\u003eM-x\u003c/kbd\u003e `flymake-mode` \u003ckbd\u003eRET\u003c/kbd\u003e\n\n## Customization\n\n- You can set the `flymake-shellcheck-program` variable to the path of the ShellCheck executable in your system, in case `executable-find` wasn't able to find it automatically.\n- You can set the `flymake-shellcheck-use-file` variable to `nil` if you wish to run the syntax checker on the contents of the buffer, rather than the contents of the file on disk (default: `t`).\n- You can set the `flymake-shellcheck-allow-external-files` variable to `t` if you want to allow shellcheck to read external sources (it adds `-x` as argument, described in [the SC1091 docs](https://github.com/koalaman/shellcheck/wiki/SC1091), default: `nil`).\n\n## License\n\nDistributed under the GNU General Public License, version 3.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffedericotdn%2Fflymake-shellcheck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffedericotdn%2Fflymake-shellcheck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffedericotdn%2Fflymake-shellcheck/lists"}