Merge branch 'develop' into style-override-on-windows

.codeclimate.yml

@@ -1,5 +1,6 @@
 version: "2"
 
+# https://codeclimate.com/
 # https://docs.codeclimate.com/docs/maintainability#section-checks
 # https://docs.codeclimate.com/docs/advanced-configuration#default-checks
 checks:
@@ -31,7 +32,7 @@ plugins:
     config:
       # https://radon.readthedocs.io/en/latest/commandline.html#the-cc-command
       threshold: "C"
-  shellcheck: #https://docs.codeclimate.com/docs/shellcheck
+  shellcheck: # https://docs.codeclimate.com/docs/shellcheck
     enabled: true
-  sonar-python: #https://docs.codeclimate.com/docs/sonar-python
+  sonar-python: # https://docs.codeclimate.com/docs/sonar-python
     enabled: true

.github/workflows/python.yaml

@@ -38,7 +38,7 @@ jobs:
         run: |
           echo "LINT_DOCS=,lint,docs" >> $GITHUB_ENV
 
-      - name: "Run tests on ${{ matrix.os }} with Python ${{ matrix.python-version }}"
+      - name: "Run tests on ${{ matrix.os }}"
         run: |
           tox -e clean,$(echo py${{ matrix.python-version }} | tr -d .)${{env.LINT_DOCS}},report
 

.pre-commit-config.yaml

@@ -36,9 +36,23 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.30.1
+    rev: v2.31.0
     hooks:
       - id: pyupgrade
+  - repo: https://github.com/myint/autoflake
+    rev: v1.4
+    hooks:
+      - id: autoflake
+        args:
+          [
+            --in-place,
+            --remove-all-unused-imports,
+            --remove-unused-variables,
+            --remove-duplicate-keys,
+            --ignore-init-module-imports,
+            --exclude,
+            compat.py,
+          ]
   - repo: https://github.com/psf/black
     rev: 21.12b0
     hooks:
@@ -66,22 +80,6 @@ repos:
     hooks:
       - id: prettier
         stages: [commit]
-  - repo: https://github.com/myint/autoflake
-    rev: v1.4
-    hooks:
-      - id: autoflake
-        name: autoflake
-        language: python
-        args:
-          [
-            --in-place,
-            --remove-all-unused-imports,
-            --remove-unused-variables,
-            --remove-duplicate-keys,
-            --ignore-init-module-imports,
-            --exclude,
-            compat.py,
-          ]
   - repo: https://github.com/PyCQA/flake8
     rev: 4.0.1
     hooks:

.prettierignore

@@ -6,3 +6,6 @@ README.md
 
 # Prettier uses double quotes, ruamel.yaml uses single quotes
 tests/test_yaml/*.yaml
+
+# The JSON generated with json.dumps() should not be prettified in tests, otherwise they fail
+tests/test_json/*.json

.pylintrc

@@ -38,7 +38,7 @@ disable=bad-continuation,bad-whitespace,
 bad-functions=map,filter
 
 # Good variable names which should always be accepted, separated by a comma
-good-names = i,j,k,e,ex,Run,_,id,rv
+good-names = i,j,k,e,ex,Run,_,id,rv,c
 
 # Regular expression matching correct constant names
 const-rgx=(([A-Z_][A-Z0-9_]*)|([a-z_][a-z0-9_]*)|(__.*__)|register|urlpatterns)$

.readthedocs.yml

@@ -4,7 +4,7 @@ sphinx:
   configuration: docs/conf.py
 formats: all
 python:
-  version: 3.8
+  version: "3.8"
   install:
     - method: pip
       path: .

CONTRIBUTING.rst

@@ -1,3 +1,5 @@
+.. include:: targets.rst
+
 ============
 Contributing
 ============
@@ -11,7 +13,7 @@ Bug reports or feature requests
 ===============================
 
 * First, search the `GitHub issue tracker <https://github.com/andreoliwa/nitpick/issues>`_ to see if your bug/feature is already there.
-* If nothing is found, just `add a new issue and follow the instructions there <https://github.com/andreoliwa/nitpick/issues/new/choose>`_.
+* If nothing is found, just `add a new issue and follow the instructions <https://github.com/andreoliwa/nitpick/issues/new/choose>`_.
 
 Documentation improvements
 ==========================

Makefile

@@ -22,11 +22,17 @@ help:
 build: .cache/make/pytest .cache/make/pre-commit # Quick build for local development
 .PHONY: build
 
-.cache/make/pytest: $(SRC) $(TESTS)
+.delete-cache:
+	# Force a cache update before running "nitpick fix" in pre-commit
+	# TODO: the cache doesn't detect changes in TOML style files
+	rm -rf .cache/nitpick
+.PHONY: .delete-cache
+
+.cache/make/pytest: .delete-cache $(SRC) $(TESTS)
 	invoke test
 	touch .cache/make/pytest
 
-.cache/make/pre-commit: $(ANY)
+.cache/make/pre-commit: .delete-cache $(ANY)
 	pre-commit run -a
 	touch .cache/make/pre-commit
 

README.rst

@@ -109,7 +109,7 @@ Implemented
    * - `Any TOML file <https://nitpick.rtfd.io/en/latest/plugins.html#toml-files>`_
      - ✅
      - ✅
-   * - `Any YAML file (except .pre-commit-config.yaml) <https://nitpick.rtfd.io/en/latest/plugins.html#yaml-files>`_
+   * - `Any YAML file <https://nitpick.rtfd.io/en/latest/plugins.html#yaml-files>`_
      - ✅
      - ✅
    * - `.editorconfig <https://nitpick.rtfd.io/en/latest/examples.html#example-editorconfig>`_
@@ -120,7 +120,7 @@ Implemented
      - ✅
    * - `.pre-commit-config.yaml <https://nitpick.rtfd.io/en/latest/plugins.html#pre-commit-config-yaml>`_
      - ✅
-     - `#282 <https://github.com/andreoliwa/nitpick/issues/282>`_ 🚧
+     - ✅
    * - `.pylintrc <https://nitpick.rtfd.io/en/latest/plugins.html#ini-files>`_
      - ✅
      - ✅