Add npm-package-json-lint (#2150)

* Add npm-package-json-lint * Add cspell words * Add default template * Test files * Update changelog * Generated files * Add cli_executable * Add cli_help_arg_name and test_folder descriptor fields * Change cli_lint_mode and add cli_lint_extra_args_after * Update schema * Fix package.json
oxsecurity · Dec 22, 2022 · abfc7df · abfc7df
1 parent 2e0e163
commit abfc7df
Show file tree

Hide file tree

Showing 40 changed files with 121 additions and 1 deletion.
diff --git a/.automation/generated/linter-links-previews.json b/.automation/generated/linter-links-previews.json
@@ -264,6 +264,11 @@
     "image": "https://repository-images.githubusercontent.com/240214900/1dcdef80-773c-11ea-8c94-305acc58f5c6",
     "title": "nvuillam/npm-groovy-lint"
   },
+  "npm-package-json-lint": {
+    "description": "A configurable linter for package.json files",
+    "image": null,
+    "title": "npm-package-json-lint | npm-package-json-lint"
+  },
   "perlcritic": {
     "description": "Critique Perl source code for best-practices.",
     "image": null,

diff --git a/.automation/test/npm_package_json_lint/bad/package.json b/.automation/test/npm_package_json_lint/bad/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "test-package"
+}
diff --git a/.automation/test/npm_package_json_lint/good/package.json b/.automation/test/npm_package_json_lint/good/package.json
@@ -0,0 +1,4 @@
+{
+  "name": "test-package",
+  "version": "1.2.3"
+}
diff --git a/.github/linters/.cspell.json b/.github/linters/.cspell.json
@@ -913,6 +913,8 @@
         "nowrap",
         "noxincludenode",
         "npmignore",
+        "npmpackagejsonlintignore",
+        "npmpackagejsonlintrc",
         "npmrc",
         "nsclean",
         "nunjucks",
@@ -1343,4 +1345,4 @@
         "\u0636clojure",
         "\u077bcbad"
     ]
-}
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,9 @@ Note: Can be used with `oxsecurity/megalinter@beta` in your GitHub Action mega-l
   - HTML email not rendering correctly ([#2120](https://github.com/oxsecurity/megalinter/issues/2120)). Set `REPORTERS_MARKDOWN_TYPE` to `simple` to avoid external images in PR/MR markdown comments.
   - Fix branding to use the correct 'OX Security' name
 
+- Linters
+  - Add [npm-package-json-lint](https://github.com/tclindner/npm-package-json-lint) linter
+
 - Linter versions upgrades
   - [cspell](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell) from 6.14.3 to **6.15.0** on 2022-11-26
   - [swiftlint](https://github.com/realm/SwiftLint) from 0.50.0 to **0.50.1** on 2022-11-26

diff --git a/Dockerfile b/Dockerfile
@@ -203,6 +203,8 @@ RUN npm --no-cache install --ignore-scripts \
                 @prantlf/jsonlint \
                 eslint-plugin-jsonc \
                 v8r \
+                npm-package-json-lint \
+                npm-package-json-lint-config-default \
                 eslint-plugin-react \
                 eslint-plugin-jsx-a11y \
                 markdownlint-cli \

diff --git a/TEMPLATES/.npmpackagejsonlintrc.json b/TEMPLATES/.npmpackagejsonlintrc.json
@@ -0,0 +1,3 @@
+{
+  "extends": "npm-package-json-lint-config-default"
+}
diff --git a/flavors/ci_light/Dockerfile b/flavors/ci_light/Dockerfile
@@ -110,6 +110,8 @@ RUN npm --no-cache install --ignore-scripts \
                 @microsoft/eslint-formatter-sarif \
                 v8r \
                 prettier \
+                npm-package-json-lint \
+                npm-package-json-lint-config-default \
                 secretlint \
                 @secretlint/secretlint-rule-preset-recommend \
                 @secretlint/secretlint-formatter-sarif && \

diff --git a/flavors/ci_light/flavor.json b/flavors/ci_light/flavor.json
@@ -14,6 +14,7 @@
         "JSON_ESLINT_PLUGIN_JSONC",
         "JSON_V8R",
         "JSON_PRETTIER",
+        "JSON_NPM_PACKAGE_JSON_LINT",
         "MAKEFILE_CHECKMAKE",
         "REPOSITORY_GIT_DIFF",
         "REPOSITORY_GITLEAKS",

diff --git a/flavors/cupcake/Dockerfile b/flavors/cupcake/Dockerfile
@@ -168,6 +168,8 @@ RUN npm --no-cache install --ignore-scripts \
                 @prantlf/jsonlint \
                 eslint-plugin-jsonc \
                 v8r \
+                npm-package-json-lint \
+                npm-package-json-lint-config-default \
                 eslint-plugin-react \
                 eslint-plugin-jsx-a11y \
                 markdownlint-cli \

diff --git a/flavors/cupcake/flavor.json b/flavors/cupcake/flavor.json
@@ -40,6 +40,7 @@
         "JSON_ESLINT_PLUGIN_JSONC",
         "JSON_V8R",
         "JSON_PRETTIER",
+        "JSON_NPM_PACKAGE_JSON_LINT",
         "JSX_ESLINT",
         "KOTLIN_KTLINT",
         "KUBERNETES_KUBEVAL",

diff --git a/flavors/documentation/Dockerfile b/flavors/documentation/Dockerfile
@@ -127,6 +127,8 @@ RUN npm --no-cache install --ignore-scripts \
                 @microsoft/eslint-formatter-sarif \
                 v8r \
                 prettier \
+                npm-package-json-lint \
+                npm-package-json-lint-config-default \
                 markdownlint-cli \
                 markdown-link-check \
                 markdown-table-formatter \

diff --git a/flavors/documentation/flavor.json b/flavors/documentation/flavor.json
@@ -25,6 +25,7 @@
         "JSON_ESLINT_PLUGIN_JSONC",
         "JSON_V8R",
         "JSON_PRETTIER",
+        "JSON_NPM_PACKAGE_JSON_LINT",
         "KOTLIN_KTLINT",
         "KUBERNETES_KUBEVAL",
         "KUBERNETES_KUBECONFORM",

diff --git a/flavors/dotnet/Dockerfile b/flavors/dotnet/Dockerfile
@@ -145,6 +145,8 @@ RUN npm --no-cache install --ignore-scripts \
                 @microsoft/eslint-formatter-sarif \
                 v8r \
                 prettier \
+                npm-package-json-lint \
+                npm-package-json-lint-config-default \
                 markdownlint-cli \
                 markdown-link-check \
                 markdown-table-formatter \

diff --git a/flavors/dotnet/flavor.json b/flavors/dotnet/flavor.json
@@ -35,6 +35,7 @@
         "JSON_ESLINT_PLUGIN_JSONC",
         "JSON_V8R",
         "JSON_PRETTIER",
+        "JSON_NPM_PACKAGE_JSON_LINT",
         "KOTLIN_KTLINT",
         "KUBERNETES_KUBEVAL",
         "KUBERNETES_KUBECONFORM",

diff --git a/flavors/go/Dockerfile b/flavors/go/Dockerfile
@@ -127,6 +127,8 @@ RUN npm --no-cache install --ignore-scripts \
                 @microsoft/eslint-formatter-sarif \
                 v8r \
                 prettier \
+                npm-package-json-lint \
+                npm-package-json-lint-config-default \
                 markdownlint-cli \
                 markdown-link-check \
                 markdown-table-formatter \

diff --git a/flavors/go/flavor.json b/flavors/go/flavor.json
@@ -28,6 +28,7 @@
         "JSON_ESLINT_PLUGIN_JSONC",
         "JSON_V8R",
         "JSON_PRETTIER",
+        "JSON_NPM_PACKAGE_JSON_LINT",
         "KOTLIN_KTLINT",
         "KUBERNETES_KUBEVAL",
         "KUBERNETES_KUBECONFORM",

diff --git a/flavors/java/Dockerfile b/flavors/java/Dockerfile
@@ -128,6 +128,8 @@ RUN npm --no-cache install --ignore-scripts \
                 @microsoft/eslint-formatter-sarif \
                 v8r \
                 prettier \
+                npm-package-json-lint \
+                npm-package-json-lint-config-default \
                 markdownlint-cli \
                 markdown-link-check \
                 markdown-table-formatter \

diff --git a/flavors/java/flavor.json b/flavors/java/flavor.json
@@ -29,6 +29,7 @@
         "JSON_ESLINT_PLUGIN_JSONC",
         "JSON_V8R",
         "JSON_PRETTIER",
+        "JSON_NPM_PACKAGE_JSON_LINT",
         "KOTLIN_KTLINT",
         "KUBERNETES_KUBEVAL",
         "KUBERNETES_KUBECONFORM",

diff --git a/flavors/javascript/Dockerfile b/flavors/javascript/Dockerfile
@@ -142,6 +142,8 @@ RUN npm --no-cache install --ignore-scripts \
                 @prantlf/jsonlint \
                 eslint-plugin-jsonc \
                 v8r \
+                npm-package-json-lint \
+                npm-package-json-lint-config-default \
                 eslint-plugin-react \
                 eslint-plugin-jsx-a11y \
                 markdownlint-cli \

diff --git a/flavors/javascript/flavor.json b/flavors/javascript/flavor.json
@@ -30,6 +30,7 @@
         "JSON_ESLINT_PLUGIN_JSONC",
         "JSON_V8R",
         "JSON_PRETTIER",
+        "JSON_NPM_PACKAGE_JSON_LINT",
         "JSX_ESLINT",
         "KOTLIN_KTLINT",
         "KUBERNETES_KUBEVAL",

diff --git a/flavors/php/Dockerfile b/flavors/php/Dockerfile
@@ -139,6 +139,8 @@ RUN npm --no-cache install --ignore-scripts \
                 @microsoft/eslint-formatter-sarif \
                 v8r \
                 prettier \
+                npm-package-json-lint \
+                npm-package-json-lint-config-default \
                 markdownlint-cli \
                 markdown-link-check \
                 markdown-table-formatter \

diff --git a/flavors/php/flavor.json b/flavors/php/flavor.json
@@ -26,6 +26,7 @@
         "JSON_ESLINT_PLUGIN_JSONC",
         "JSON_V8R",
         "JSON_PRETTIER",
+        "JSON_NPM_PACKAGE_JSON_LINT",
         "KOTLIN_KTLINT",
         "KUBERNETES_KUBEVAL",
         "KUBERNETES_KUBECONFORM",

diff --git a/flavors/python/Dockerfile b/flavors/python/Dockerfile
@@ -137,6 +137,8 @@ RUN npm --no-cache install --ignore-scripts \
                 @microsoft/eslint-formatter-sarif \
                 v8r \
                 prettier \
+                npm-package-json-lint \
+                npm-package-json-lint-config-default \
                 markdownlint-cli \
                 markdown-link-check \
                 markdown-table-formatter \

diff --git a/flavors/python/flavor.json b/flavors/python/flavor.json
@@ -25,6 +25,7 @@
         "JSON_ESLINT_PLUGIN_JSONC",
         "JSON_V8R",
         "JSON_PRETTIER",
+        "JSON_NPM_PACKAGE_JSON_LINT",
         "KOTLIN_KTLINT",
         "KUBERNETES_KUBEVAL",
         "KUBERNETES_KUBECONFORM",

diff --git a/flavors/ruby/Dockerfile b/flavors/ruby/Dockerfile
@@ -127,6 +127,8 @@ RUN npm --no-cache install --ignore-scripts \
                 @microsoft/eslint-formatter-sarif \
                 v8r \
                 prettier \
+                npm-package-json-lint \
+                npm-package-json-lint-config-default \
                 markdownlint-cli \
                 markdown-link-check \
                 markdown-table-formatter \

diff --git a/flavors/ruby/flavor.json b/flavors/ruby/flavor.json
@@ -25,6 +25,7 @@
         "JSON_ESLINT_PLUGIN_JSONC",
         "JSON_V8R",
         "JSON_PRETTIER",
+        "JSON_NPM_PACKAGE_JSON_LINT",
         "KOTLIN_KTLINT",
         "KUBERNETES_KUBEVAL",
         "KUBERNETES_KUBECONFORM",

diff --git a/flavors/rust/Dockerfile b/flavors/rust/Dockerfile
@@ -127,6 +127,8 @@ RUN npm --no-cache install --ignore-scripts \
                 @microsoft/eslint-formatter-sarif \
                 v8r \
                 prettier \
+                npm-package-json-lint \
+                npm-package-json-lint-config-default \
                 markdownlint-cli \
                 markdown-link-check \
                 markdown-table-formatter \

diff --git a/flavors/rust/flavor.json b/flavors/rust/flavor.json
@@ -25,6 +25,7 @@
         "JSON_ESLINT_PLUGIN_JSONC",
         "JSON_V8R",
         "JSON_PRETTIER",
+        "JSON_NPM_PACKAGE_JSON_LINT",
         "KOTLIN_KTLINT",
         "KUBERNETES_KUBEVAL",
         "KUBERNETES_KUBECONFORM",

diff --git a/flavors/salesforce/Dockerfile b/flavors/salesforce/Dockerfile
@@ -128,6 +128,8 @@ RUN npm --no-cache install --ignore-scripts \
                 @microsoft/eslint-formatter-sarif \
                 v8r \
                 prettier \
+                npm-package-json-lint \
+                npm-package-json-lint-config-default \
                 markdownlint-cli \
                 markdown-link-check \
                 markdown-table-formatter \

diff --git a/flavors/salesforce/flavor.json b/flavors/salesforce/flavor.json
@@ -26,6 +26,7 @@
         "JSON_ESLINT_PLUGIN_JSONC",
         "JSON_V8R",
         "JSON_PRETTIER",
+        "JSON_NPM_PACKAGE_JSON_LINT",
         "KOTLIN_KTLINT",
         "KUBERNETES_KUBEVAL",
         "KUBERNETES_KUBECONFORM",

diff --git a/flavors/swift/Dockerfile b/flavors/swift/Dockerfile
@@ -129,6 +129,8 @@ RUN npm --no-cache install --ignore-scripts \
                 @microsoft/eslint-formatter-sarif \
                 v8r \
                 prettier \
+                npm-package-json-lint \
+                npm-package-json-lint-config-default \
                 markdownlint-cli \
                 markdown-link-check \
                 markdown-table-formatter \

diff --git a/flavors/swift/flavor.json b/flavors/swift/flavor.json
@@ -25,6 +25,7 @@
         "JSON_ESLINT_PLUGIN_JSONC",
         "JSON_V8R",
         "JSON_PRETTIER",
+        "JSON_NPM_PACKAGE_JSON_LINT",
         "KOTLIN_KTLINT",
         "KUBERNETES_KUBEVAL",
         "KUBERNETES_KUBECONFORM",

diff --git a/flavors/terraform/Dockerfile b/flavors/terraform/Dockerfile
@@ -131,6 +131,8 @@ RUN npm --no-cache install --ignore-scripts \
                 @microsoft/eslint-formatter-sarif \
                 v8r \
                 prettier \
+                npm-package-json-lint \
+                npm-package-json-lint-config-default \
                 markdownlint-cli \
                 markdown-link-check \
                 markdown-table-formatter \

diff --git a/flavors/terraform/flavor.json b/flavors/terraform/flavor.json
@@ -25,6 +25,7 @@
         "JSON_ESLINT_PLUGIN_JSONC",
         "JSON_V8R",
         "JSON_PRETTIER",
+        "JSON_NPM_PACKAGE_JSON_LINT",
         "KOTLIN_KTLINT",
         "KUBERNETES_KUBEVAL",
         "KUBERNETES_KUBECONFORM",