chore: update npm-package-json-lint config

matijs · Robbert · commit f9c6c49bb37e · 2024-08-02T09:56:59.000+02:00
- 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`
diff --git a/.npmpackagejsonlintrc.json b/.npmpackagejsonlintrc.json
diff --git a/npmpackagejsonlint.config.cjs 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
diff --git a/proprietary/LICENSE.md b/proprietary/LICENSE.md
diff --git 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
@@ -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
@@ -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"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,9 @@`
`1`	`1`	`{`
	`2`	`+ "name": "@example/assets",`
`2`	`3`	`"version": "1.0.0-alpha.0",`
`3`	`4`	`"author": "Community for NL Design System",`
`4`	`5`	`"description": "Assets",`
`5`	`6`	`"license": "SEE LICENSE IN LICENSE.md",`
`6`		`- "name": "@example/assets",`
`7`	`7`	`"keywords": [`
`8`	`8`	`"nl-design-system"`
`9`	`9`	`],`
`@@ -14,6 +14,7 @@`
`14`	`14`	`"files": [],`
`15`	`15`	`"repository": {`
`16`	`16`	`"type": "git+ssh",`
`17`		`- "url": "git@github.com:nl-design-system/example.git"`
	`17`	`+ "url": "git@github.com:nl-design-system/example.git",`
	`18`	`+ "directory": "proprietary/assets"`
`18`	`19`	`}`
`19`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,9 @@`
`1`	`1`	`{`
	`2`	`+ "name": "@example/font",`
`2`	`3`	`"version": "1.0.0-alpha.0",`
`3`	`4`	`"author": "Community for NL Design System",`
`4`	`5`	`"description": "Font assets",`
`5`	`6`	`"license": "SEE LICENSE IN LICENSE.md",`
`6`		`- "name": "@example/font",`
`7`	`7`	`"main": "dist/index.css",`
`8`	`8`	`"keywords": [`
`9`	`9`	`"nl-design-system"`
`@@ -17,6 +17,7 @@`
`17`	`17`	`],`
`18`	`18`	`"repository": {`
`19`	`19`	`"type": "git+ssh",`
`20`		`- "url": "git@github.com:nl-design-system/example.git"`
	`20`	`+ "url": "git@github.com:nl-design-system/example.git",`
	`21`	`+ "directory": "proprietary/font"`
`21`	`22`	`}`
`22`	`23`	`}`