Pretty-format JSON files (cookiecutter#1864)

* Add a pre-commit hook to standardize JSON file formatting * Enforce JSON formatting standards * Feedback: Indent JSON files with 2 spaces
pkrueger-cariad · Jun 16, 2023 · 6761ffd · 6761ffd
1 parent bc493bf
commit 6761ffd
Show file tree

Hide file tree

Showing 26 changed files with 164 additions and 130 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -29,7 +29,12 @@ repos:
       - id: check-symlinks
       - id: check-case-conflict
       - id: check-docstring-first
-      - id: check-json
+      - id: pretty-format-json
+        args:
+          - "--autofix"
+          - "--indent=2"
+          - "--no-sort-keys"
+          - "--no-ensure-ascii"
         exclude: "invalid-syntax.json|tests/fake-repo-bad-json/cookiecutter.json|tests/fake-repo/cookiecutter.json"
       - id: check-toml
       - id: check-xml

diff --git a/tests/fake-nested-templates/cookiecutter.json b/tests/fake-nested-templates/cookiecutter.json
@@ -1,5 +1,5 @@
 {
-	"template": [
-		"fake-project (fake-project)"
-	]
-}
+  "template": [
+    "fake-project (fake-project)"
+  ]
+}
diff --git a/tests/fake-nested-templates/fake-project/cookiecutter.json b/tests/fake-nested-templates/fake-project/cookiecutter.json
@@ -1 +1 @@
-{}
+{}
diff --git a/tests/fake-repo-dict/cookiecutter.json b/tests/fake-repo-dict/cookiecutter.json
@@ -1,20 +1,20 @@
 {
-    "project_slug": "fake-project-dict",
-    "file_types": {
-        "png": {
-            "name": "Portable Network Graphic",
-            "library": "libpng",
-            "apps": [
-                "GIMP"
-            ]
-        },
-        "bmp": {
-            "name": "Bitmap",
-            "library": "libbmp",
-            "apps": [
-                "Paint",
-                "GIMP"
-            ]
-        }
+  "project_slug": "fake-project-dict",
+  "file_types": {
+    "png": {
+      "name": "Portable Network Graphic",
+      "library": "libpng",
+      "apps": [
+        "GIMP"
+      ]
+    },
+    "bmp": {
+      "name": "Bitmap",
+      "library": "libbmp",
+      "apps": [
+        "Paint",
+        "GIMP"
+      ]
     }
+  }
 }
diff --git a/tests/fake-repo-dir/my-dir/cookiecutter.json b/tests/fake-repo-dir/my-dir/cookiecutter.json
@@ -1,11 +1,11 @@
 {
-	"full_name": "Audrey Roy",
-	"email": "audreyr@gmail.com",
-	"github_username": "audreyr",
-	"project_name": "Fake Project",
-	"repo_name": "fake-project",
-	"project_short_description": "This is a fake project.",
-	"release_date": "2013-07-28",
-	"year": "2013",
-	"version": "0.1"
-}
+  "full_name": "Audrey Roy",
+  "email": "audreyr@gmail.com",
+  "github_username": "audreyr",
+  "project_name": "Fake Project",
+  "repo_name": "fake-project",
+  "project_short_description": "This is a fake project.",
+  "release_date": "2013-07-28",
+  "year": "2013",
+  "version": "0.1"
+}
diff --git a/tests/fake-repo-pre/cookiecutter.json b/tests/fake-repo-pre/cookiecutter.json
@@ -1,11 +1,11 @@
 {
-	"full_name": "Audrey Roy",
-	"email": "audreyr@gmail.com",
-	"github_username": "audreyr",
-	"project_name": "Fake Project",
-	"repo_name": "fake-project",
-	"project_short_description": "This is a fake project.",
-	"release_date": "2013-07-28",
-	"year": "2013",
-	"version": "0.1"
-}
+  "full_name": "Audrey Roy",
+  "email": "audreyr@gmail.com",
+  "github_username": "audreyr",
+  "project_name": "Fake Project",
+  "repo_name": "fake-project",
+  "project_short_description": "This is a fake project.",
+  "release_date": "2013-07-28",
+  "year": "2013",
+  "version": "0.1"
+}
diff --git a/tests/fake-repo-pre2/cookiecutter.json b/tests/fake-repo-pre2/cookiecutter.json
@@ -1,11 +1,11 @@
 {
-	"full_name": "Audrey Roy",
-	"email": "audreyr@gmail.com",
-	"github_username": "audreyr",
-	"project_name": "Fake Project",
-	"repo_name": "fake-project",
-	"project_short_description": "This is a fake project.",
-	"release_date": "2013-07-28",
-	"year": "2013",
-	"version": "0.1"
-}
+  "full_name": "Audrey Roy",
+  "email": "audreyr@gmail.com",
+  "github_username": "audreyr",
+  "project_name": "Fake Project",
+  "repo_name": "fake-project",
+  "project_short_description": "This is a fake project.",
+  "release_date": "2013-07-28",
+  "year": "2013",
+  "version": "0.1"
+}
diff --git a/tests/fake-repo-tmpl/cookiecutter.json b/tests/fake-repo-tmpl/cookiecutter.json
@@ -1,11 +1,11 @@
 {
-	"full_name": "Audrey Roy",
-	"email": "audreyr@gmail.com",
-	"github_username": "audreyr",
-	"project_name": "Fake Project Templated",
-	"repo_name": "{{ cookiecutter.project_name|lower|replace(' ', '-') }}",
-	"project_short_description": "This is a fake project.",
-	"release_date": "2013-07-28",
-	"year": "2013",
-	"version": "0.1"
+  "full_name": "Audrey Roy",
+  "email": "audreyr@gmail.com",
+  "github_username": "audreyr",
+  "project_name": "Fake Project Templated",
+  "repo_name": "{{ cookiecutter.project_name|lower|replace(' ', '-') }}",
+  "project_short_description": "This is a fake project.",
+  "release_date": "2013-07-28",
+  "year": "2013",
+  "version": "0.1"
 }
diff --git a/tests/test-extensions/custom-extension-post/cookiecutter.json b/tests/test-extensions/custom-extension-post/cookiecutter.json
@@ -1,5 +1,7 @@
 {
-    "project_slug": "foobar",
-    "name": "World",
-    "_extensions": ["hello_extension.HelloExtension"]
+  "project_slug": "foobar",
+  "name": "World",
+  "_extensions": [
+    "hello_extension.HelloExtension"
+  ]
 }
diff --git a/tests/test-extensions/custom-extension-pre/cookiecutter.json b/tests/test-extensions/custom-extension-pre/cookiecutter.json
@@ -1,5 +1,7 @@
 {
-    "project_slug": "foobar",
-    "name": "World",
-    "_extensions": ["hello_extension.HelloExtension"]
+  "project_slug": "foobar",
+  "name": "World",
+  "_extensions": [
+    "hello_extension.HelloExtension"
+  ]
 }
diff --git a/tests/test-extensions/default/cookiecutter.json b/tests/test-extensions/default/cookiecutter.json
@@ -1,4 +1,4 @@
 {
-    "project_slug": "{{ 'It\\'s slugified Foobar' | slugify() }}",
-    "year": "{% now 'utc', '%Y' %}"
+  "project_slug": "{{ 'It\\'s slugified Foobar' | slugify() }}",
+  "year": "{% now 'utc', '%Y' %}"
 }
diff --git a/tests/test-extensions/local_extension/cookiecutter.json b/tests/test-extensions/local_extension/cookiecutter.json
@@ -1,10 +1,9 @@
 {
-    "project_slug": "Foobar",
-    "test_value_class_based": "{{cookiecutter.project_slug | foobar}}",
-    "test_value_function_based": "{{cookiecutter.project_slug | simplefilterextension}}",
-    "_extensions": [
-        "local_extensions.simplefilterextension",
-        "local_extensions.FoobarExtension"
-    ]
+  "project_slug": "Foobar",
+  "test_value_class_based": "{{cookiecutter.project_slug | foobar}}",
+  "test_value_function_based": "{{cookiecutter.project_slug | simplefilterextension}}",
+  "_extensions": [
+    "local_extensions.simplefilterextension",
+    "local_extensions.FoobarExtension"
+  ]
 }
-
diff --git a/tests/test-extensions/unknown/cookiecutter.json b/tests/test-extensions/unknown/cookiecutter.json
@@ -1,6 +1,7 @@
 {
-    "project_slug": "Foobar",
-    "year": "{{cookiecutter.nope | foobar}}",
-    "_extensions": ["FoobarExtension"]
+  "project_slug": "Foobar",
+  "year": "{{cookiecutter.nope | foobar}}",
+  "_extensions": [
+    "FoobarExtension"
+  ]
 }
-
diff --git a/tests/test-generate-context/choices_template.json b/tests/test-generate-context/choices_template.json
@@ -1,7 +1,11 @@
 {
-    "full_name": "Raphael Pierzina",
-    "github_username": "hackebrot",
-    "project_name": "Kivy Project",
-    "repo_name": "{{cookiecutter.project_name|lower}}",
-    "orientation": ["all", "landscape", "portrait"]
+  "full_name": "Raphael Pierzina",
+  "github_username": "hackebrot",
+  "project_name": "Kivy Project",
+  "repo_name": "{{cookiecutter.project_name|lower}}",
+  "orientation": [
+    "all",
+    "landscape",
+    "portrait"
+  ]
 }
diff --git a/tests/test-generate-context/nested_dict.json b/tests/test-generate-context/nested_dict.json
@@ -1,10 +1,14 @@
 {
-    "full_name": "Raphael Pierzina",
-    "github_username": "hackebrot",
-    "project": {
-        "name": "Kivy Project",
-        "description": "Kivy Project",
-        "repo_name": "{{cookiecutter.project_name|lower}}",
-        "orientation": ["all", "landscape", "portrait"]
-    }
-}
+  "full_name": "Raphael Pierzina",
+  "github_username": "hackebrot",
+  "project": {
+    "name": "Kivy Project",
+    "description": "Kivy Project",
+    "repo_name": "{{cookiecutter.project_name|lower}}",
+    "orientation": [
+      "all",
+      "landscape",
+      "portrait"
+    ]
+  }
+}
diff --git a/tests/test-generate-context/non_ascii.json b/tests/test-generate-context/non_ascii.json
@@ -1,3 +1,3 @@
 {
-    "full_name": "éèà"
+  "full_name": "éèà"
 }
diff --git a/tests/test-generate-context/test.json b/tests/test-generate-context/test.json
@@ -1 +1,4 @@
-{"1": 2, "some_key": "some_val"}
+{
+  "1": 2,
+  "some_key": "some_val"
+}
diff --git a/tests/test-generate-files-line-end/cookiecutter.json b/tests/test-generate-files-line-end/cookiecutter.json
@@ -1,9 +1,9 @@
 {
-    "full_name": "Philippe Ombredanne",
-    "year": "2015",
-    "color": "blue",
-    "letter": "D",
-    "folder_name": "im_a.dir",
-    "filename": "im_a.file",
-    "test_name": "output_folder"
-}
+  "full_name": "Philippe Ombredanne",
+  "year": "2015",
+  "color": "blue",
+  "letter": "D",
+  "folder_name": "im_a.dir",
+  "filename": "im_a.file",
+  "test_name": "output_folder"
+}
diff --git a/tests/test-output-folder/cookiecutter.json b/tests/test-output-folder/cookiecutter.json
@@ -1,9 +1,9 @@
 {
-    "full_name": "Audrey Greenfeld",
-    "year": "2014",
-    "color": "green",
-    "letter": "D",
-    "folder_name": "im_a.dir",
-    "filename": "im_a.file",
-    "test_name": "output_folder"
-}
+  "full_name": "Audrey Greenfeld",
+  "year": "2014",
+  "color": "green",
+  "letter": "D",
+  "folder_name": "im_a.dir",
+  "filename": "im_a.file",
+  "test_name": "output_folder"
+}
diff --git a/tests/test-replay/cookiedozer_load.json b/tests/test-replay/cookiedozer_load.json
@@ -1 +1,8 @@
-{"cookiecutter": {"version": "0.1.0", "email": "raphael@hackebrot.de", "full_name": "Raphael Pierzina", "github_username": "hackebrot"}}
+{
+  "cookiecutter": {
+    "version": "0.1.0",
+    "email": "raphael@hackebrot.de",
+    "full_name": "Raphael Pierzina",
+    "github_username": "hackebrot"
+  }
+}
diff --git a/tests/test-replay/invalid_replay.json b/tests/test-replay/invalid_replay.json
@@ -1 +1,8 @@
-{"not cookiecutter": {"version": "0.1.0", "email": "raphael@hackebrot.de", "full_name": "Raphael Pierzina", "github_username": "hackebrot"}}
+{
+  "not cookiecutter": {
+    "version": "0.1.0",
+    "email": "raphael@hackebrot.de",
+    "full_name": "Raphael Pierzina",
+    "github_username": "hackebrot"
+  }
+}
diff --git a/tests/test-templates/extends/cookiecutter.json b/tests/test-templates/extends/cookiecutter.json
@@ -1,5 +1,5 @@
 {
-    "project_slug": "foobar",
-    "command_line_interface": "click",
-    "use_pytest": "y"
+  "project_slug": "foobar",
+  "command_line_interface": "click",
+  "use_pytest": "y"
 }
diff --git a/tests/test-templates/include/cookiecutter.json b/tests/test-templates/include/cookiecutter.json
@@ -1,5 +1,5 @@
 {
-    "project_slug": "foobar",
-    "command_line_interface": "click",
-    "use_pytest": "y"
+  "project_slug": "foobar",
+  "command_line_interface": "click",
+  "use_pytest": "y"
 }
diff --git a/tests/test-templates/no-templates/cookiecutter.json b/tests/test-templates/no-templates/cookiecutter.json
@@ -1,5 +1,5 @@
 {
-    "project_slug": "foobar",
-    "command_line_interface": "click",
-    "use_pytest": "y"
+  "project_slug": "foobar",
+  "command_line_interface": "click",
+  "use_pytest": "y"
 }
diff --git a/tests/test-templates/super/cookiecutter.json b/tests/test-templates/super/cookiecutter.json
@@ -1,5 +1,5 @@
 {
-    "project_slug": "foobar",
-    "command_line_interface": "click",
-    "use_pytest": "y"
+  "project_slug": "foobar",
+  "command_line_interface": "click",
+  "use_pytest": "y"
 }
diff --git a/tests/undefined-variable/file-name/cookiecutter.json b/tests/undefined-variable/file-name/cookiecutter.json
@@ -1,4 +1,4 @@
 {
-    "project_slug": "testproject",
-    "github_username": "hackebrot"
+  "project_slug": "testproject",
+  "github_username": "hackebrot"
 }