From f63f45adcbd9d6a25889ce7f24154cd617a1a98f Mon Sep 17 00:00:00 2001 From: matijs Date: Fri, 26 Jul 2024 15:35:23 +0200 Subject: [PATCH] chore: update npm-package-json-lint config - Use new config file name: npmpackagejsonlint.config.cjs - Only use the rules we explicitly want to enforce - Use overrides to get rid of config files in folders - Bring files in line with the configuration - Remove unused `proprietary/LICENSE.md` --- .npmpackagejsonlintrc.json | 42 -------------------- npmpackagejsonlint.config.cjs | 19 +++++++++ package.json | 9 ++++- packages/components-css/package.json | 9 ++++- packages/components-react/package.json | 5 ++- packages/storybook/package.json | 5 ++- packages/web-components-react/package.json | 5 ++- packages/web-components-stencil/package.json | 5 ++- proprietary/.npmpackagejsonlintrc.json | 5 --- proprietary/LICENSE.md | 7 ---- proprietary/assets/package.json | 5 ++- proprietary/design-tokens/package.json | 5 ++- proprietary/font/package.json | 5 ++- 13 files changed, 54 insertions(+), 72 deletions(-) delete mode 100644 .npmpackagejsonlintrc.json create mode 100644 npmpackagejsonlint.config.cjs delete mode 100644 proprietary/.npmpackagejsonlintrc.json delete mode 100644 proprietary/LICENSE.md diff --git a/.npmpackagejsonlintrc.json b/.npmpackagejsonlintrc.json deleted file mode 100644 index bcfdfae7..00000000 --- a/.npmpackagejsonlintrc.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "rules": { - "bin-type": "error", - "config-type": "error", - "description-type": "error", - "devDependencies-type": "error", - "directories-type": "error", - "engines-type": "error", - "files-type": "error", - "homepage-type": "error", - "keywords-type": "error", - "license-type": "error", - "main-type": "error", - "man-type": "error", - "name-format": "error", - "name-type": "error", - "no-caret-version-dependencies": "error", - "no-caret-version-devDependencies": "error", - "no-tilde-version-dependencies": "error", - "no-tilde-version-devDependencies": "error", - "preferGlobal-type": "error", - "private-type": "error", - "repository-type": "error", - "require-author": "error", - "require-bugs": "off", - "require-description": "error", - "require-engines": "off", - "require-homepage": "off", - "require-keywords": "error", - "require-license": "error", - "require-name": "error", - "require-repository": "off", - "require-version": "error", - "scripts-type": "error", - "valid-values-author": "off", - "valid-values-license": ["error", ["EUPL-1.2"]], - "valid-values-name-scope": ["error", ["@example"]], - "valid-values-private": "off", - "version-format": "error", - "version-type": "error" - } -} diff --git a/npmpackagejsonlint.config.cjs b/npmpackagejsonlint.config.cjs new file mode 100644 index 00000000..59b23e77 --- /dev/null +++ b/npmpackagejsonlint.config.cjs @@ -0,0 +1,19 @@ +module.exports = { + rules: { + 'no-caret-version-dependencies': 'error', + 'no-caret-version-devDependencies': 'error', + 'no-tilde-version-dependencies': 'error', + 'no-tilde-version-devDependencies': 'error', + 'require-repository-directory': 'error', + 'valid-values-license': ['error', ['EUPL-1.2']], + 'valid-values-name-scope': ['error', ['@example']], + }, + overrides: [ + { + patterns: ['proprietary/**/package.json'], + rules: { + 'valid-values-license': ['error', ['SEE LICENSE IN LICENSE.md']], + }, + }, + ], +}; diff --git a/package.json b/package.json index 5fa0ef7a..186646da 100644 --- a/package.json +++ b/package.json @@ -1,13 +1,18 @@ { + "name": "@example/design-system", "version": "1.0.0-alpha.0", "author": "Community for NL Design System", "description": "Design system based on the NL Design System architecture", "license": "EUPL-1.2", - "name": "@example/design-system", "keywords": [ "nl-design-system" ], "private": true, + "repository": { + "type": "git+ssh", + "url": "git@github.com:nl-design-system/example.git", + "directory": "." + }, "engines": { "node": "^20", "pnpm": "^9" @@ -50,7 +55,7 @@ "lint:css": "stylelint --allow-empty-input '**/*.{css,scss}'", "lint:js": "eslint --ext .js,.cjs,.mjs,.json,.jsx,.mdx,.ts,.tsx --report-unused-disable-directives .", "lint:md": "markdownlint '**/*.md'", - "lint:package-json": "npmPkgJsonLint '**/package.json'", + "lint:package-json": "npmPkgJsonLint .", "lint:package-lock": "pnpm ls --recursive", "lint-fix": "npm-run-all --continue-on-error lint-fix:** prettier", "lint-fix:css": "stylelint --fix '**/*.{css,scss}'", diff --git a/packages/components-css/package.json b/packages/components-css/package.json index 617f6174..10d089b5 100644 --- a/packages/components-css/package.json +++ b/packages/components-css/package.json @@ -1,11 +1,16 @@ { + "name": "@example/components-css", "version": "1.0.0-alpha.0", "author": "Community for NL Design System", "description": "CSS Components for a design system based on the NL Design System architecture", "license": "EUPL-1.2", - "name": "@example/components-css", "keywords": [ "nl-design-system" ], - "private": true + "private": true, + "repository": { + "type": "git+ssh", + "url": "git@github.com:nl-design-system/example.git", + "directory": "packages/components-css" + } } diff --git a/packages/components-react/package.json b/packages/components-react/package.json index 929d480e..a12e7fb9 100644 --- a/packages/components-react/package.json +++ b/packages/components-react/package.json @@ -1,9 +1,9 @@ { + "name": "@example/components-react", "version": "1.0.0-alpha.0", "author": "Community for NL Design System", "description": "React component library for the Example repository, based on the NL Design System architecture", "license": "EUPL-1.2", - "name": "@example/components-react", "keywords": [ "nl-design-system" ], @@ -14,7 +14,8 @@ }, "repository": { "type": "git+ssh", - "url": "git@github.com:nl-design-system/example-community.git" + "url": "git@github.com:nl-design-system/example.git", + "directory": "packages/components-react" }, "scripts": { "build": "npm-run-all clean build:**", diff --git a/packages/storybook/package.json b/packages/storybook/package.json index e022c246..d4f23e69 100644 --- a/packages/storybook/package.json +++ b/packages/storybook/package.json @@ -1,16 +1,17 @@ { + "name": "@example/storybook", "version": "1.0.0-alpha.0", "author": "Community for NL Design System", "description": "Storybook based on the NL Design System architecture", "license": "EUPL-1.2", - "name": "@example/storybook", "keywords": [ "nl-design-system" ], "private": true, "repository": { "type": "git+ssh", - "url": "git@github.com:nl-design-system/example.git" + "url": "git@github.com:nl-design-system/example.git", + "directory": "packages/storybook" }, "scripts": { "build": "storybook build --output-dir dist/ --config-dir config/", diff --git a/packages/web-components-react/package.json b/packages/web-components-react/package.json index 91205e45..5927e706 100644 --- a/packages/web-components-react/package.json +++ b/packages/web-components-react/package.json @@ -1,16 +1,17 @@ { + "name": "@example/web-components-react", "version": "1.0.0-alpha.0", "author": "Community for NL Design System", "description": "React web components bundle based on the NL Design System architecture", "license": "EUPL-1.2", - "name": "@example/web-components-react", "keywords": [ "nl-design-system" ], "private": true, "repository": { "type": "git+ssh", - "url": "git@github.com:nl-design-system/example.git" + "url": "git@github.com:nl-design-system/example.git", + "directory": "packages/web-components-react" }, "sideEffects": false, "scripts": { diff --git a/packages/web-components-stencil/package.json b/packages/web-components-stencil/package.json index 0d6c1d0e..05ac4efe 100644 --- a/packages/web-components-stencil/package.json +++ b/packages/web-components-stencil/package.json @@ -1,9 +1,9 @@ { + "name": "@example/web-components-stencil", "version": "1.0.0-alpha.0", "author": "Community for NL Design System", "description": "Stencil web components bundle based on the NL Design System architecture", "license": "EUPL-1.2", - "name": "@example/web-components-stencil", "keywords": [ "nl-design-system" ], @@ -20,7 +20,8 @@ ], "repository": { "type": "git+ssh", - "url": "git@github.com:nl-design-system/example.git" + "url": "git@github.com:nl-design-system/example.git", + "directory": "packages/web-components-stencil" }, "scripts": { "build": "npm-run-all clean build:**", diff --git a/proprietary/.npmpackagejsonlintrc.json b/proprietary/.npmpackagejsonlintrc.json deleted file mode 100644 index 9413d8f6..00000000 --- a/proprietary/.npmpackagejsonlintrc.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "rules": { - "valid-values-license": ["error", ["SEE LICENSE IN LICENSE.md"]] - } -} diff --git a/proprietary/LICENSE.md b/proprietary/LICENSE.md deleted file mode 100644 index 1f173a02..00000000 --- a/proprietary/LICENSE.md +++ /dev/null @@ -1,7 +0,0 @@ -# License - -Copyright (c) {year} {author}. All rights reserved. - -The open source license does NOT apply to files in this directory. - -These are properietary assets to {author}. diff --git a/proprietary/assets/package.json b/proprietary/assets/package.json index 0bbe6ab8..0c5fd55f 100644 --- a/proprietary/assets/package.json +++ b/proprietary/assets/package.json @@ -1,9 +1,9 @@ { + "name": "@example/assets", "version": "1.0.0-alpha.0", "author": "Community for NL Design System", "description": "Assets", "license": "SEE LICENSE IN LICENSE.md", - "name": "@example/assets", "keywords": [ "nl-design-system" ], @@ -14,6 +14,7 @@ "files": [], "repository": { "type": "git+ssh", - "url": "git@github.com:nl-design-system/example.git" + "url": "git@github.com:nl-design-system/example.git", + "directory": "proprietary/assets" } } diff --git a/proprietary/design-tokens/package.json b/proprietary/design-tokens/package.json index 161ce379..5df08e19 100644 --- a/proprietary/design-tokens/package.json +++ b/proprietary/design-tokens/package.json @@ -1,9 +1,9 @@ { + "name": "@example/design-tokens", "version": "1.0.0-alpha.0", "author": "Community for NL Design System", "description": "Example design tokens", "license": "SEE LICENSE IN LICENSE.md", - "name": "@example/design-tokens", "keywords": [ "nl-design-system" ], @@ -13,7 +13,8 @@ }, "repository": { "type": "git+ssh", - "url": "git@github.com:nl-design-system/example.git" + "url": "git@github.com:nl-design-system/example.git", + "directory": "proprietary/design-tokens" }, "scripts": { "clean": "rimraf dist/", diff --git a/proprietary/font/package.json b/proprietary/font/package.json index 75928a84..9dde8fc1 100644 --- a/proprietary/font/package.json +++ b/proprietary/font/package.json @@ -1,9 +1,9 @@ { + "name": "@example/font", "version": "1.0.0-alpha.0", "author": "Community for NL Design System", "description": "Font assets", "license": "SEE LICENSE IN LICENSE.md", - "name": "@example/font", "main": "dist/index.css", "keywords": [ "nl-design-system" @@ -17,6 +17,7 @@ ], "repository": { "type": "git+ssh", - "url": "git@github.com:nl-design-system/example.git" + "url": "git@github.com:nl-design-system/example.git", + "directory": "proprietary/font" } }