<a href="https://github.com/warpnet/salt-lint" style="color: black;">
<h1 align="center">salt-lint</h1>
</a>
<p align="center">
<a href="https://pypi.org/project/salt-lint/">
<img src="https://img.shields.io/github/v/release/warpnet/salt-lint?style=for-the-badge"
alt="Latest release version">
</a>
<a href="https://pypi.org/project/salt-lint/">
<img src="https://img.shields.io/pypi/pyversions/salt-lint?style=for-the-badge"
alt="PyPI - Python Version">
</a>
<a href="https://raw.githubusercontent.com/warpnet/salt-lint/main/LICENSE">
<img src="https://img.shields.io/pypi/l/salt-lint?style=for-the-badge&color=blue"
alt="PyPI - License">
</a>
<a href="https://github.com/warpnet/salt-lint/actions">
<img src="https://img.shields.io/github/actions/workflow/status/warpnet/salt-lint/tox.yml?style=for-the-badge&color=blue&branch=main"
alt="GitHub Workflow Status">
</a>
<a href="https://github.com/warpnet/salt-lint/graphs/contributors">
<img src="https://img.shields.io/github/contributors/warpnet/salt-lint?style=for-the-badge&color=blue"
alt="GitHub contributors">
</a>
</br>
<b>salt-lint</b> checks Salt State files (SLS) for best practices and behavior that could potentially be improved.
<br />
<a href="https://salt-lint.readthedocs.io/en/latest/"><strong>Explore the docs »</strong></a>
<br />
<a href="https://salt-lint.readthedocs.io/en/latest/rules/">Check the Linting Rules</a>
·
<a href="https://github.com/warpnet/salt-lint/issues/new?assignees=&labels=Type%3A%20Bug&template=bug_report.md&title=Bug%3A">Report Bug</a>
·
<a href="https://github.com/warpnet/salt-lint/issues/new?assignees=&labels=Type%3A%20Enhancement&template=feature_request.md&title=Feature+Request%3A">Request Feature</a>
</p>
## Demo
[](https://asciinema.org/a/377244)
## Acknowledgement
The project is heavily based on [ansible-lint](https://github.com/ansible/ansible-lint), with the modified work by [Warpnet B.V.](https://github.com/warpnet). [ansible-lint](https://github.com/ansible/ansible-lint) was created by [Will Thames](https://github.com/willthames) and is now maintained as part of the [Ansible](https://www.ansible.com/) by [Red Hat](https://www.redhat.com) project.
# Changelog
All notable changes in **salt-lint** are documented below.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.9.2] (2023-02-09)
### Fixed
- Ensure version identification adheres to [PEP440](https://peps.python.org/pep-0440/) ([!304](https://github.com/warpnet/salt-lint/issues/304))
## [0.9.1] (2023-01-16)
### Fixed
- Revert changes to rule 210 ([!299](https://github.com/warpnet/salt-lint/issues/299))
## [0.9.0] (2023-01-13)
### Added
- Rule 219 for catching missing over-indentation of nested dicts ([#284](https://github.com/warpnet/salt-lint/pull/284)).
- Add Python 3.11 support ([#290](https://github.com/warpnet/salt-lint/pull/290)).
- Add alternative typos of onchanges in rule 216 ([#286](https://github.com/warpnet/salt-lint/pull/286)).
## [0.8.0] (2021-11-09)
### Fixed
- False positive when detecting missing spaces in Jinja variables when the Jinja statement is nested in literal braces ([#272](https://github.com/warpnet/salt-lint/pull/272)).
- Ensure a single missing quote in the file mode is also detected as incorrect quotation of a file mode ([#273](https://github.com/warpnet/salt-lint/pull/273)).
- Ignore non file mode arguments for the file mode quotation and leading zero checks ([#274](https://github.com/warpnet/salt-lint/pull/274)).
## [0.7.0] (2021-11-01)
### Added
- Add Python 3.10 support ([#265](https://github.com/warpnet/salt-lint/pull/265)).
- Add initial man page ([#270](https://github.com/warpnet/salt-lint/pull/270)).
### Fixed
- Close temporary file after writing to STDIN ([#263](https://github.com/warpnet/salt-lint/pull/263)).
## [0.6.1] (2021-06-01)
### Removed
- Remove rule 218 because of a false positive
## [0.6.0] (2021-06-01)
### Deprecated
- Drop Python 2.7 support ([#239](https://github.com/warpnet/salt-lint/pull/239)).
### Added
- Rule 216, 217 and 218 for catching common typographical errors ([#249](https://github.com/warpnet/salt-lint/pull/249)).
## [0.5.2] (2021-01-29)
### Fixed
- Append the contents of the `CHANGELOG.md` file to the long description of the package instead of the duplicate `README.md` contents ([#234](https://github.com/warpnet/salt-lint/pull/234)).
- Ignore Jinja specific rules in Jinja escaped blocks ([#236](https://github.com/warpnet/salt-lint/pull/236)).
## [0.5.1] (2021-01-19)
### Fixed
- Ensure all excluded paths from both the CLI and configuration are passed to the runner ([#231](https://github.com/warpnet/salt-lint/pull/231)).
## [0.5.0] (2021-01-17)
### Added
- Rule 213 to recommend using cmd.run together with onchanges ([#207](https://github.com/warpnet/salt-lint/pull/207)).
- Rule 214 to check SLS file with a period in the name (besides the suffix period) as they can not be referenced by Salt ([#209](https://github.com/warpnet/salt-lint/pull/209)).
- Rules 901-915 to check for deprecated states and state options ([#214](https://github.com/warpnet/salt-lint/pull/214)).
- This `CHANGELOG.md` file to be able to list all notable changes for each version of **salt-lint** ([#223](https://github.com/warpnet/salt-lint/pull/223)).
[Unreleased]: https://github.com/warpnet/salt-lint/compare/v0.9.2...HEAD
[0.9.2]: https://github.com/warpnet/salt-lint/compare/v0.9.1...v0.9.2]
[0.9.1]: https://github.com/warpnet/salt-lint/compare/v0.9.0...v0.9.1
[0.9.0]: https://github.com/warpnet/salt-lint/compare/v0.8.0...v0.9.0
[0.8.0]: https://github.com/warpnet/salt-lint/compare/v0.7.0...v0.8.0
[0.7.0]: https://github.com/warpnet/salt-lint/compare/v0.6.1...v0.7.0
[0.6.1]: https://github.com/warpnet/salt-lint/compare/v0.6.0...v0.6.1
[0.6.0]: https://github.com/warpnet/salt-lint/compare/v0.5.2...v0.6.0
[0.5.2]: https://github.com/warpnet/salt-lint/compare/v0.5.1...v0.5.2
[0.5.1]: https://github.com/warpnet/salt-lint/compare/v0.5.0...v0.5.1
[0.5.0]: https://github.com/warpnet/salt-lint/compare/v0.4.2...v0.5.0
Raw data
{
"_id": null,
"home_page": "https://github.com/warpnet/salt-lint",
"name": "salt-lint",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "salt,saltstack,lint,linter,checker",
"author": "Warpnet B.V.",
"author_email": "info@warpnet.nl",
"download_url": "https://files.pythonhosted.org/packages/e5/e9/4df64ca147c084ca1cdbea9210549758d07f4ed94ac37d1cd1c99288ef5c/salt-lint-0.9.2.tar.gz",
"platform": null,
"description": "\n<a href=\"https://github.com/warpnet/salt-lint\" style=\"color: black;\">\n <h1 align=\"center\">salt-lint</h1>\n</a>\n<p align=\"center\">\n <a href=\"https://pypi.org/project/salt-lint/\">\n <img src=\"https://img.shields.io/github/v/release/warpnet/salt-lint?style=for-the-badge\"\n alt=\"Latest release version\">\n </a>\n <a href=\"https://pypi.org/project/salt-lint/\">\n <img src=\"https://img.shields.io/pypi/pyversions/salt-lint?style=for-the-badge\"\n alt=\"PyPI - Python Version\">\n </a>\n <a href=\"https://raw.githubusercontent.com/warpnet/salt-lint/main/LICENSE\">\n <img src=\"https://img.shields.io/pypi/l/salt-lint?style=for-the-badge&color=blue\"\n alt=\"PyPI - License\">\n </a>\n <a href=\"https://github.com/warpnet/salt-lint/actions\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/warpnet/salt-lint/tox.yml?style=for-the-badge&color=blue&branch=main\"\n alt=\"GitHub Workflow Status\">\n </a>\n <a href=\"https://github.com/warpnet/salt-lint/graphs/contributors\">\n <img src=\"https://img.shields.io/github/contributors/warpnet/salt-lint?style=for-the-badge&color=blue\"\n alt=\"GitHub contributors\">\n </a>\n </br>\n <b>salt-lint</b> checks Salt State files (SLS) for best practices and behavior that could potentially be improved.\n <br />\n <a href=\"https://salt-lint.readthedocs.io/en/latest/\"><strong>Explore the docs \u00bb</strong></a>\n <br />\n <a href=\"https://salt-lint.readthedocs.io/en/latest/rules/\">Check the Linting Rules</a>\n \u00b7\n <a href=\"https://github.com/warpnet/salt-lint/issues/new?assignees=&labels=Type%3A%20Bug&template=bug_report.md&title=Bug%3A\">Report Bug</a>\n \u00b7\n <a href=\"https://github.com/warpnet/salt-lint/issues/new?assignees=&labels=Type%3A%20Enhancement&template=feature_request.md&title=Feature+Request%3A\">Request Feature</a>\n</p>\n\n## Demo\n[](https://asciinema.org/a/377244)\n\n## Acknowledgement\nThe project is heavily based on [ansible-lint](https://github.com/ansible/ansible-lint), with the modified work by [Warpnet B.V.](https://github.com/warpnet). [ansible-lint](https://github.com/ansible/ansible-lint) was created by [Will Thames](https://github.com/willthames) and is now maintained as part of the [Ansible](https://www.ansible.com/) by [Red Hat](https://www.redhat.com) project.\n# Changelog\nAll notable changes in **salt-lint** are documented below.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n## [0.9.2] (2023-02-09)\n### Fixed\n- Ensure version identification adheres to [PEP440](https://peps.python.org/pep-0440/) ([!304](https://github.com/warpnet/salt-lint/issues/304))\n\n## [0.9.1] (2023-01-16)\n### Fixed\n- Revert changes to rule 210 ([!299](https://github.com/warpnet/salt-lint/issues/299))\n\n## [0.9.0] (2023-01-13)\n### Added\n- Rule 219 for catching missing over-indentation of nested dicts ([#284](https://github.com/warpnet/salt-lint/pull/284)).\n- Add Python 3.11 support ([#290](https://github.com/warpnet/salt-lint/pull/290)).\n- Add alternative typos of onchanges in rule 216 ([#286](https://github.com/warpnet/salt-lint/pull/286)).\n\n## [0.8.0] (2021-11-09)\n### Fixed\n- False positive when detecting missing spaces in Jinja variables when the Jinja statement is nested in literal braces ([#272](https://github.com/warpnet/salt-lint/pull/272)).\n- Ensure a single missing quote in the file mode is also detected as incorrect quotation of a file mode ([#273](https://github.com/warpnet/salt-lint/pull/273)).\n- Ignore non file mode arguments for the file mode quotation and leading zero checks ([#274](https://github.com/warpnet/salt-lint/pull/274)).\n\n## [0.7.0] (2021-11-01)\n### Added\n- Add Python 3.10 support ([#265](https://github.com/warpnet/salt-lint/pull/265)).\n- Add initial man page ([#270](https://github.com/warpnet/salt-lint/pull/270)).\n\n### Fixed\n- Close temporary file after writing to STDIN ([#263](https://github.com/warpnet/salt-lint/pull/263)).\n\n## [0.6.1] (2021-06-01)\n### Removed\n- Remove rule 218 because of a false positive\n\n## [0.6.0] (2021-06-01)\n### Deprecated\n- Drop Python 2.7 support ([#239](https://github.com/warpnet/salt-lint/pull/239)).\n\n### Added\n- Rule 216, 217 and 218 for catching common typographical errors ([#249](https://github.com/warpnet/salt-lint/pull/249)).\n\n## [0.5.2] (2021-01-29)\n### Fixed\n- Append the contents of the `CHANGELOG.md` file to the long description of the package instead of the duplicate `README.md` contents ([#234](https://github.com/warpnet/salt-lint/pull/234)).\n- Ignore Jinja specific rules in Jinja escaped blocks ([#236](https://github.com/warpnet/salt-lint/pull/236)).\n\n## [0.5.1] (2021-01-19)\n### Fixed\n- Ensure all excluded paths from both the CLI and configuration are passed to the runner ([#231](https://github.com/warpnet/salt-lint/pull/231)).\n\n## [0.5.0] (2021-01-17)\n### Added\n- Rule 213 to recommend using cmd.run together with onchanges ([#207](https://github.com/warpnet/salt-lint/pull/207)).\n- Rule 214 to check SLS file with a period in the name (besides the suffix period) as they can not be referenced by Salt ([#209](https://github.com/warpnet/salt-lint/pull/209)).\n- Rules 901-915 to check for deprecated states and state options ([#214](https://github.com/warpnet/salt-lint/pull/214)).\n- This `CHANGELOG.md` file to be able to list all notable changes for each version of **salt-lint** ([#223](https://github.com/warpnet/salt-lint/pull/223)).\n\n[Unreleased]: https://github.com/warpnet/salt-lint/compare/v0.9.2...HEAD\n[0.9.2]: https://github.com/warpnet/salt-lint/compare/v0.9.1...v0.9.2]\n[0.9.1]: https://github.com/warpnet/salt-lint/compare/v0.9.0...v0.9.1\n[0.9.0]: https://github.com/warpnet/salt-lint/compare/v0.8.0...v0.9.0\n[0.8.0]: https://github.com/warpnet/salt-lint/compare/v0.7.0...v0.8.0\n[0.7.0]: https://github.com/warpnet/salt-lint/compare/v0.6.1...v0.7.0\n[0.6.1]: https://github.com/warpnet/salt-lint/compare/v0.6.0...v0.6.1\n[0.6.0]: https://github.com/warpnet/salt-lint/compare/v0.5.2...v0.6.0\n[0.5.2]: https://github.com/warpnet/salt-lint/compare/v0.5.1...v0.5.2\n[0.5.1]: https://github.com/warpnet/salt-lint/compare/v0.5.0...v0.5.1\n[0.5.0]: https://github.com/warpnet/salt-lint/compare/v0.4.2...v0.5.0\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A command-line utility that checks for best practices in SaltStack.",
"version": "0.9.2",
"split_keywords": [
"salt",
"saltstack",
"lint",
"linter",
"checker"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ec186f513afbe6b22fb1c2ab0019baeb7769b0c987cbead4b753269e5bcc8bbc",
"md5": "c639e47ac27346544f281be6a630c6d2",
"sha256": "d9dbf137a2ef917e0a6110d50bc79b132d5a35464cea943c891a30dd4412c6b2"
},
"downloads": -1,
"filename": "salt_lint-0.9.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c639e47ac27346544f281be6a630c6d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 35605,
"upload_time": "2023-02-09T10:13:03",
"upload_time_iso_8601": "2023-02-09T10:13:03.725601Z",
"url": "https://files.pythonhosted.org/packages/ec/18/6f513afbe6b22fb1c2ab0019baeb7769b0c987cbead4b753269e5bcc8bbc/salt_lint-0.9.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e5e94df64ca147c084ca1cdbea9210549758d07f4ed94ac37d1cd1c99288ef5c",
"md5": "99ff7a6c6304cf8c9525ce807d11cd39",
"sha256": "7f74e682e7fd78722a6d391ea8edc9fc795113ecfd40657d68057d404ee7be8e"
},
"downloads": -1,
"filename": "salt-lint-0.9.2.tar.gz",
"has_sig": false,
"md5_digest": "99ff7a6c6304cf8c9525ce807d11cd39",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 21055,
"upload_time": "2023-02-09T10:13:05",
"upload_time_iso_8601": "2023-02-09T10:13:05.351264Z",
"url": "https://files.pythonhosted.org/packages/e5/e9/4df64ca147c084ca1cdbea9210549758d07f4ed94ac37d1cd1c99288ef5c/salt-lint-0.9.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-09 10:13:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "warpnet",
"github_project": "salt-lint",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "salt-lint"
}
JSON
