From 45cb29e231bc215ec619c8ce5a62c60c8900a859 Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Tue, 23 Feb 2021 16:06:23 +0000 Subject: [PATCH] chore(release): 0.24.0 [skip ci] # [0.24.0](https://github.com/andreoliwa/nitpick/compare/v0.23.1...v0.24.0) (2021-02-23) ### Bug Fixes * check a YAML file with the text plugin ([#249](https://github.com/andreoliwa/nitpick/issues/249)) ([1821962](https://github.com/andreoliwa/nitpick/commit/1821962a2a1fce898d93a9e81a8663d9ae7c2aed)) * override a remote style with "./your-local-style.toml" ([#295](https://github.com/andreoliwa/nitpick/issues/295)) ([fe5f085](https://github.com/andreoliwa/nitpick/commit/fe5f085ef5200111ce4f4a2288a84091a96438e2)) * toml module now accepts keys beginning with dot (fix [#183](https://github.com/andreoliwa/nitpick/issues/183)) ([b086a24](https://github.com/andreoliwa/nitpick/commit/b086a24c5503c09e26ca429455bd4fea54cf01bb)) * validate sections in comma_separated_values (fix [#227](https://github.com/andreoliwa/nitpick/issues/227)) ([f1be98f](https://github.com/andreoliwa/nitpick/commit/f1be98f985ebcfc7e402f22271b428452a2f140b)) ### Features * apply changes to pyproject.toml ([#287](https://github.com/andreoliwa/nitpick/issues/287)) ([4b79f81](https://github.com/andreoliwa/nitpick/commit/4b79f81f98430b749e7fa9ee5c192506d6ed5cf7)) * apply changes to setup.cfg ([#288](https://github.com/andreoliwa/nitpick/issues/288)) ([f878630](https://github.com/andreoliwa/nitpick/commit/f87863066642cdab112d3145c488c9a780e7c98d)) * **cli:** add 'ls' command to list configured files ([cfc031b](https://github.com/andreoliwa/nitpick/commit/cfc031bdf30105dec9a8952bfb9657aec939b3b6)) * **cli:** add 'run' command to display violations ([a67bfa8](https://github.com/andreoliwa/nitpick/commit/a67bfa8bdaef2461853a237819cd35622c5935e9)) * **cli:** filter only the desired files on ls/run commands ([#265](https://github.com/andreoliwa/nitpick/issues/265)) ([f5e4a9c](https://github.com/andreoliwa/nitpick/commit/f5e4a9c47583cd809941ca96ec2ffbdbf0c92c6f)) * drop support for Python 3.5 ([#251](https://github.com/andreoliwa/nitpick/issues/251)) ([9f84a60](https://github.com/andreoliwa/nitpick/commit/9f84a608a4ca02e8a96ec8eaaf55e5cb207b35e3)), closes [#250](https://github.com/andreoliwa/nitpick/issues/250) * experimental CLI interface (alpha version) ([#255](https://github.com/andreoliwa/nitpick/issues/255)) ([c9ca5dc](https://github.com/andreoliwa/nitpick/commit/c9ca5dc3cc4586b459e2c58fb2e61d80aa3f1e5d)) --- CHANGELOG.md | 21 +++++++ README.md | 4 +- docs/conf.py | 2 +- docs/quickstart.rst | 2 +- docs/targets.rst | 2 +- docs/tool_nitpick_section.rst | 2 +- nitpick-style.toml | 2 +- package.json | 2 +- pyproject.toml | 2 +- setup.cfg | 108 ++++++++++++++-------------------- src/nitpick/__init__.py | 2 +- 11 files changed, 76 insertions(+), 73 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4d519e6d..7d4ee887 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,24 @@ +# [0.24.0](https://github.com/andreoliwa/nitpick/compare/v0.23.1...v0.24.0) (2021-02-23) + + +### Bug Fixes + +* check a YAML file with the text plugin ([#249](https://github.com/andreoliwa/nitpick/issues/249)) ([1821962](https://github.com/andreoliwa/nitpick/commit/1821962a2a1fce898d93a9e81a8663d9ae7c2aed)) +* override a remote style with "./your-local-style.toml" ([#295](https://github.com/andreoliwa/nitpick/issues/295)) ([fe5f085](https://github.com/andreoliwa/nitpick/commit/fe5f085ef5200111ce4f4a2288a84091a96438e2)) +* toml module now accepts keys beginning with dot (fix [#183](https://github.com/andreoliwa/nitpick/issues/183)) ([b086a24](https://github.com/andreoliwa/nitpick/commit/b086a24c5503c09e26ca429455bd4fea54cf01bb)) +* validate sections in comma_separated_values (fix [#227](https://github.com/andreoliwa/nitpick/issues/227)) ([f1be98f](https://github.com/andreoliwa/nitpick/commit/f1be98f985ebcfc7e402f22271b428452a2f140b)) + + +### Features + +* apply changes to pyproject.toml ([#287](https://github.com/andreoliwa/nitpick/issues/287)) ([4b79f81](https://github.com/andreoliwa/nitpick/commit/4b79f81f98430b749e7fa9ee5c192506d6ed5cf7)) +* apply changes to setup.cfg ([#288](https://github.com/andreoliwa/nitpick/issues/288)) ([f878630](https://github.com/andreoliwa/nitpick/commit/f87863066642cdab112d3145c488c9a780e7c98d)) +* **cli:** add 'ls' command to list configured files ([cfc031b](https://github.com/andreoliwa/nitpick/commit/cfc031bdf30105dec9a8952bfb9657aec939b3b6)) +* **cli:** add 'run' command to display violations ([a67bfa8](https://github.com/andreoliwa/nitpick/commit/a67bfa8bdaef2461853a237819cd35622c5935e9)) +* **cli:** filter only the desired files on ls/run commands ([#265](https://github.com/andreoliwa/nitpick/issues/265)) ([f5e4a9c](https://github.com/andreoliwa/nitpick/commit/f5e4a9c47583cd809941ca96ec2ffbdbf0c92c6f)) +* drop support for Python 3.5 ([#251](https://github.com/andreoliwa/nitpick/issues/251)) ([9f84a60](https://github.com/andreoliwa/nitpick/commit/9f84a608a4ca02e8a96ec8eaaf55e5cb207b35e3)), closes [#250](https://github.com/andreoliwa/nitpick/issues/250) +* experimental CLI interface (alpha version) ([#255](https://github.com/andreoliwa/nitpick/issues/255)) ([c9ca5dc](https://github.com/andreoliwa/nitpick/commit/c9ca5dc3cc4586b459e2c58fb2e61d80aa3f1e5d)) + ## [0.23.1](https://github.com/andreoliwa/nitpick/compare/v0.23.0...v0.23.1) (2020-11-02) ### Bug Fixes diff --git a/README.md b/README.md index bb98e4d3..49f87c20 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ To try the package, simply install it (in a virtualenv or globally) and run `fla $ flake8 . -Nitpick will download and use the opinionated [default style file](https://raw.githubusercontent.com/andreoliwa/nitpick/v0.23.1/nitpick-style.toml). +Nitpick will download and use the opinionated [default style file](https://raw.githubusercontent.com/andreoliwa/nitpick/v0.24.0/nitpick-style.toml). You can use it as a template to configure your own style. @@ -71,7 +71,7 @@ If you use [pre-commit](https://pre-commit.com/) on your project (you should), a repos: - repo: https://github.com/andreoliwa/nitpick - rev: v0.23.1 + rev: v0.24.0 hooks: - id: nitpick diff --git a/docs/conf.py b/docs/conf.py index 6d7131e5..fcdbf261 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,7 +18,7 @@ author = "W. Augusto Andreoli" # The short X.Y version -version = "0.23.1" +version = "0.24.0" # The full version, including alpha/beta/rc tags release = version diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 6ff26f25..c556a7a8 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -35,7 +35,7 @@ If you use pre-commit_ on your project (you should), add this to the ``.pre-comm repos: - repo: https://github.com/andreoliwa/nitpick - rev: v0.23.1 + rev: v0.24.0 hooks: - id: nitpick diff --git a/docs/targets.rst b/docs/targets.rst index 1b06aad0..80d5ed88 100644 --- a/docs/targets.rst +++ b/docs/targets.rst @@ -1,5 +1,5 @@ .. _nitpick-style.toml: -.. _default style file: https://raw.githubusercontent.com/andreoliwa/nitpick/v0.23.1/nitpick-style.toml +.. _default style file: https://raw.githubusercontent.com/andreoliwa/nitpick/v0.24.0/nitpick-style.toml .. _black: https://github.com/psf/black .. _Django: https://www.djangoproject.com diff --git a/docs/tool_nitpick_section.rst b/docs/tool_nitpick_section.rst index e018173a..37b7dce1 100644 --- a/docs/tool_nitpick_section.rst +++ b/docs/tool_nitpick_section.rst @@ -22,7 +22,7 @@ Use the URL of the remote file. If it's hosted on GitHub, use the raw GitHub URL .. code-block:: toml [tool.nitpick] - style = "https://raw.githubusercontent.com/andreoliwa/nitpick/v0.23.1/nitpick-style.toml" + style = "https://raw.githubusercontent.com/andreoliwa/nitpick/v0.24.0/nitpick-style.toml" You can also use the raw URL of a `GitHub Gist `_: diff --git a/nitpick-style.toml b/nitpick-style.toml index e72d038c..b656fc08 100644 --- a/nitpick-style.toml +++ b/nitpick-style.toml @@ -1,5 +1,5 @@ # Default style file for nitpick -# https://raw.githubusercontent.com/andreoliwa/nitpick/v0.23.1/nitpick-style.toml +# https://raw.githubusercontent.com/andreoliwa/nitpick/v0.24.0/nitpick-style.toml [nitpick] minimum_version = "0.10.0" diff --git a/package.json b/package.json index ff01d6ad..b8d494f2 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "nitpick", - "version": "0.23.1", + "version": "0.24.0", "repository": { "type": "git", "url": "https://github.com/andreoliwa/nitpick.git" diff --git a/pyproject.toml b/pyproject.toml index 786d4c1f..d2a5d5ad 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ line-length = 120 [tool.poetry] name = "nitpick" -version = "0.23.1" +version = "0.24.0" description = "Enforce the same configuration across multiple projects" authors = ["W. Augusto Andreoli "] license = "MIT" diff --git a/setup.cfg b/setup.cfg index c59703c4..c0bf7c72 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.23.1 +current_version = 0.24.0 commit = False tag = False @@ -45,12 +45,9 @@ max-line-length = 120 exclude = docs,.tox,build max-complexity = 10 inline-quotes = double - -# https://github.com/asottile/flake8-typing-imports#configuration min_python_version = 3.6.0 [isort] -; https://pycqa.github.io/isort/docs/configuration/options/ line_length = 120 skip = docs,.tox,build multi_line_output = 3 @@ -71,34 +68,31 @@ warn_unused_ignores = True [tool:pytest] addopts = -v norecursedirs = .* build dist CVS _darcs {arch} *.egg venv var docs -# https://docs.pytest.org/en/stable/reference.html#confval-testpaths testpaths = src tests [tox:tox] -; https://tox.readthedocs.io/en/latest/config.html isolated_build = True envlist = clean,lint,py39,py38,py37,py36,docs,report [gh-actions] -; https://github.com/ymyzk/tox-gh-actions -python = - 3.9: py39 - 3.8: py38, clean, lint, docs, report - 3.7: py37 - 3.6: py36 +python = + 3.9: py39 + 3.8: py38, clean, lint, docs, report + 3.7: py37 + 3.6: py36 [testenv] description = Run tests with pytest and coverage deps = pytest-cov extras = test -depends = - {py39,py38,py37,py36}: clean - report: py39,py38,py37,py36 -setenv = - PY_IGNORE_IMPORTMISMATCH = 1 -commands = - python -m pip --version - python -m pytest --cov-config=setup.cfg --cov --cov-append --cov-report=term-missing --doctest-modules {posargs:-vv} +depends = + {py39,py38,py37,py36}: clean + report: py39,py38,py37,py36 +setenv = + PY_IGNORE_IMPORTMISMATCH = 1 +commands = + python -m pip --version + python -m pytest --cov-config=setup.cfg --cov --cov-append --cov-report=term-missing --doctest-modules {posargs:-vv} [testenv:clean] description = Erase data for the coverage report before running tests @@ -111,76 +105,64 @@ commands = coverage erase description = Lint all files with pre-commit basepython = python3.8 platform = linux|darwin -; pylint needs both these extras: -; lint: install pylint itself -; test: for pylint to inspect tests -extras = - lint - test -deps = - pip>=19.2 - safety -# Run nitpick and pylint with tox, because local repos don't seem to work well with https://pre-commit.ci/ -# Run Nitpick locally on itself -commands = - flake8 --select=NIP - pylint src/ - safety check +extras = + lint + test +deps = + pip>=19.2 + safety +commands = + flake8 --select=NIP + pylint src/ + safety check [testenv:report] description = Coverage report platform = linux|darwin skip_install = true deps = coverage -commands = - coverage report - coverage html +commands = + coverage report + coverage html [testenv:docs] description = Build the HTML docs using Sphinx (sphinx-build, API docs, link checks) basepython = python3.8 platform = linux|darwin extras = doc -# Options to debug Sphinx: -nWT --keep-going -vvv -commands = - sphinx-apidoc --force --module-first --separate --implicit-namespaces --output-dir docs/source src/nitpick/ - python3 docs/generate_rst.py - sphinx-build --color -b linkcheck docs "{toxworkdir}/docs_out" - sphinx-build -d "{toxworkdir}/docs_doctree" --color -b html docs "{toxworkdir}/docs_out" {posargs} +commands = + sphinx-apidoc --force --module-first --separate --implicit-namespaces --output-dir docs/source src/nitpick/ + python3 docs/generate_rst.py + sphinx-build --color -b linkcheck docs "{toxworkdir}/docs_out" + sphinx-build -d "{toxworkdir}/docs_doctree" --color -b html docs "{toxworkdir}/docs_out" {posargs} [coverage:run] -; https://coverage.readthedocs.io/en/latest/config.html#run branch = true parallel = true -omit = - tests/* - .tox/* -; This config is needed by https://github.com/marketplace/actions/coveralls-python#usage +omit = + tests/* + .tox/* relative_files = True [coverage:paths] -; https://coverage.readthedocs.io/en/latest/config.html#paths source = src/ [coverage:report] -; https://coverage.readthedocs.io/en/latest/config.html#report show_missing = true precision = 2 skip_covered = true skip_empty = true sort = Cover - -; https://coverage.readthedocs.io/en/latest/excluding.html#advanced-exclusion -exclude_lines = - pragma: no cover - def __repr__ - if self.debug: - if settings.DEBUG - if TYPE_CHECKING: - raise AssertionError - raise NotImplementedError - if 0: - if __name__ == .__main__.: +exclude_lines = + pragma: no cover + def __repr__ + if self.debug: + if settings.DEBUG + if TYPE_CHECKING: + raise AssertionError + raise NotImplementedError + if 0: + if __name__ == .__main__.: [bandit] exclude = tests/* diff --git a/src/nitpick/__init__.py b/src/nitpick/__init__.py index 911b0692..f7b0e661 100644 --- a/src/nitpick/__init__.py +++ b/src/nitpick/__init__.py @@ -5,6 +5,6 @@ from nitpick.core import Nitpick # noqa: F401 __all__ = ("Nitpick",) -__version__ = "0.23.1" +__version__ = "0.24.0" logger.disable(PROJECT_NAME)