chore: tool-belts to workspaces (#1102)

converted tool-belts (groups of dependencies that formed a (group of)
tool)
to workspaces.

this should allow installing and running the library, and have some
additional tools not installed in this setup.
this would enable us to have certain tool-belts runnable only in
specific setups. and these setups would not be installed or interfere in
usual test-/build-related setups.

---------

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

.eslintrc.js

@@ -17,6 +17,8 @@ SPDX-License-Identifier: Apache-2.0
 Copyright (c) OWASP Foundation. All Rights Reserved.
 */
 
+const path = require('path')
+
 /* eslint-disable jsdoc/valid-types */
 
 /**
@@ -53,7 +55,7 @@ module.exports = {
     // endregion sort imports/exports
     // region license-header
     /* see https://github.com/Stuk/eslint-plugin-header#readme */
-    'header/header': ['error', './.license-header.js'],
+    'header/header': ['error', path.join(__dirname, '.license-header.js')],
     // endregion license-header
     // indent is managed by plugin '*standard'
     'editorconfig/indent': 'off'
@@ -105,19 +107,19 @@ module.exports = {
         // endregion docs
       },
       parserOptions: {
-        project: './tsconfig.json'
+        project: path.join(__dirname, 'tsconfig.json')
       }
     },
     {
       files: ['examples/node/typescript/example.cjs/src/*.ts'],
       parserOptions: {
-        project: './examples/node/typescript/example.cjs/tsconfig.json'
+        project: path.join(__dirname, '/examples/node/typescript/example.cjs/tsconfig.json')
       }
     },
     {
       files: ['examples/node/typescript/example.mjs/src/*.ts'],
       parserOptions: {
-        project: './examples/node/typescript/example.mjs/tsconfig.json'
+        project: path.join(__dirname, '/examples/node/typescript/example.mjs/tsconfig.json')
       }
     },
     {

.github/workflows/nodejs.yml

@@ -75,7 +75,7 @@ jobs:
           # cache: "npm"
           # cache-dependency-path: "**/package-lock.json"
       - name: setup project
-        run: npm i --ignore-scripts --include=optional  --loglevel=silly
+        run: npm i --ignore-scripts --include=optional --loglevel=silly
       - name: test
         run: npm run test:lint
 
@@ -95,13 +95,16 @@ jobs:
           # cache: "npm"
           # cache-dependency-path: "**/package-lock.json"
       - name: setup project
-        run: npm i --ignore-scripts --include=optional  --loglevel=silly
+        run: >
+          npm i 
+          --ignore-scripts --loglevel=silly
+          -w tools/code-style --include-workspace-root
       - name: make reports dir
         run: mkdir -p "$REPORTS_DIR"
       - name: test
         run: >
           npm run --
-          test:standard
+          test:standard --
           --format checkstyle
           --output-file "$REPORTS_DIR/eslint.xml"
       - name: Publish Checkstyle report
@@ -157,28 +160,39 @@ jobs:
         run: |
           set -ex
           dep_constraints=''
-          dev_requirements='c8 mocha npm-run-all fast-glob'
+          dev_requirements=' c8 mocha npm-run-all2 fast-glob '
           # as long as npm cannot auto-resolve engine-constraints, we need to help here
           case "$NODE_VERSION" in
             '16')
-              # for some stupid reason, NPM tries to resolve dev-packages, event hey are to be omitted.
-              # this is frustrating when NPM is not resolving to compatible versions ...so drop them here
-              npm uninstall --save-dev eslint-plugin-jsdoc
+              dev_requirements="${dev_requirements/ c8 / c8@^9  }"
+              ;;
+            '14')
+              dev_requirements="${dev_requirements/ c8 / c8@^9  }"
+              dev_requirements="${dev_requirements/ npm-run-all2 / npm-run-all2@^5  }"
               ;;
             '14.0.0')
-              dev_requirements='c8@^8 mocha npm-run-all fast-glob'
+              dev_requirements="${dev_requirements/ c8 / c8@^8  }"
+              dev_requirements="${dev_requirements/ npm-run-all2 / npm-run-all2@^5  }"
               ;;
           esac
+          echo "::group::install dep_constraints"
           ## !! dont install all the dev-packages, especially since some are not runnable on node 14.0.0
           if [[ -n "$dep_constraints" ]]
             then
-            npm add --ignore-scripts --omit=dev --only=prod --production --loglevel=silly --save $dep_constraints
+            npm add --workspaces=false --ignore-scripts --omit=dev --only=prod --production --loglevel=silly --save $dep_constraints
           fi
-          npm i --ignore-scripts --include=optional --omit=dev --only=prod --production --loglevel=silly
+          echo "::endgroup::"
+          echo "::group::install deps"
+          npm i --workspaces=false --ignore-scripts --include=optional --omit=dev --only=prod --production --loglevel=silly
+          echo "::endgroup::"
+          echo "::group::install libxmljs2 "
           ## rebuild deps for which scripts were ignored, or partially installed - since "ignore-scripts" was used
           npm rebuild --loglevel=silly libxmljs2 || npm uninstall --no-save libxmljs2
+          echo "::endgroup::"
+          echo "::group::install dev_requirements"
           ## install the needed dev-deps
-          npm i --ignore-scripts --loglevel=silly --no-save $dev_requirements
+          npm i --workspaces=false --ignore-scripts --loglevel=silly --no-save $dev_requirements
+          echo "::endgroup::"
       - name: fetch build artifact
         # see https://github.com/actions/download-artifact
         uses: actions/download-artifact@v4
@@ -225,7 +239,7 @@ jobs:
           ## dont install all the dev-packages, especially since some are not runnable on node 14.0.0
           npm i --ignore-scripts --omit=optional --omit=dev --loglevel=silly
           ## install the needed dev-deps
-          npm i --ignore-scripts --omit=optional --no-save --loglevel=silly mocha c8 npm-run-all fast-glob
+          npm i --ignore-scripts --omit=optional --no-save --loglevel=silly mocha c8 npm-run-all2 fast-glob
       - name: fetch build artifact
         # see https://github.com/actions/download-artifact
         uses: actions/download-artifact@v4
@@ -281,6 +295,7 @@ jobs:
           bash <(curl -Ls https://raw.githubusercontent.com/codacy/codacy-coverage-reporter/master/get.sh) report $auth $reports --partial -l Javascript &&\
           bash <(curl -Ls https://raw.githubusercontent.com/codacy/codacy-coverage-reporter/master/get.sh) final $auth
 
+
   examples-JS:
     needs: [ 'build' ]
     name: example JS ${{ matrix.js-type }}
@@ -440,6 +455,11 @@ jobs:
           # cache: "npm"
           # cache-dependency-path: "**/package-lock.json"
       - name: setup project
-        run: npm i --ignore-scripts --loglevel=silly
+        run: >
+          npm install
+          --ignore-scripts --loglevel=silly 
+          -w tools/docs-gen --include-workspace-root
       - name: api-doc ${{ matrix.target }}
-        run: npm run api-doc:${{ matrix.target }}
+        run: >
+          npm run -w tools/docs-gen
+          api-doc:${{ matrix.target }}

.github/workflows/release.yml

@@ -99,7 +99,10 @@ jobs:
         with:
           node-version: ${{ env.NODE_ACTIVE_LTS }}
       - name: install build tools
-        run: npm i --ignore-scripts --include=optional --loglevel=silly
+        run: >
+          npm install
+          --ignore-scripts --include=optional --loglevel=silly
+          -w tools/code-style --include-workspace-root
       # no explicit npm build. if a build is required, it should be configured as prepublish/prepublishOnly script of npm.
       - name: login to registries
         run: |

.npmrc

@@ -1,4 +1,3 @@
 ; see the docs: https://docs.npmjs.com/cli/v9/using-npm/config
 
-engine-strict=true
 package-lock=false

.readthedocs.yaml

@@ -15,7 +15,7 @@ build:
     # golang: "1.20"
   jobs:
     pre_build:
-      - npm i --ignore-scripts --include=optional
+      - npm i --ignore-scripts --loglevel=silly -w tools/docs-gen --include-workspace-root
       - npm run api-doc
 
 # Build documentation in the docs/ directory with Sphinx

CONTRIBUTING.md

@@ -13,7 +13,7 @@ it requires node>=18 on dev-time.
 Install dependencies:
 
 ```shell
-npm install
+npm install --workspaces --include-workspace-root
 ```
 
 The setup will also build the project.

package.json

@@ -94,28 +94,13 @@
     "@types/mocha": "^10",
     "@types/node": "ts5.4",
     "@types/spdx-expression-parse": "^3",
-    "@typescript-eslint/eslint-plugin": "6.21.0",
-    "@typescript-eslint/parser": "6.21.0",
-    "c8": "^8||^9",
+    "c8": "^8||^9||^10",
     "deepmerge": "^4.2.2",
-    "eslint": "8.57.0",
-    "eslint-config-love": "43.1.0",
-    "eslint-config-standard": "17.1.0",
-    "eslint-plugin-editorconfig": "4.0.3",
-    "eslint-plugin-header": "3.1.1",
-    "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-jsdoc": "48.2.8",
-    "eslint-plugin-n": "16.6.2",
-    "eslint-plugin-promise": "6.2.0",
-    "eslint-plugin-simple-import-sort": "12.1.0",
-    "eslint-plugin-tsdoc": "0.3.0",
     "fast-glob": "^3.3.1",
     "mocha": "10.5.2",
-    "npm-run-all2": "^6.1.2",
+    "npm-run-all2": "^5||^6",
     "rimraf": "^5.0.7",
     "ts-loader": "9.5.1",
-    "typedoc": "^0.25.0",
-    "typedoc-plugin-missing-exports": "^2.0.1",
     "typescript": "5.4.5",
     "webpack": "5.92.1",
     "webpack-cli": "5.1.4",
@@ -179,25 +164,28 @@
     "test": "./tests",
     "example": "./examples"
   },
+  "workspaces": [
+    "tools/schema-downloader",
+    "tools/docs-gen",
+    "tools/code-style"
+  ],
   "scripts": {
+    "dev-setup": "npm install --workspaces --include-workspace-root",
     "prepublish": "npm run build",
     "prepublishOnly": "run-s -lc build test",
-    "lint": "tsc --noEmit",
     "build": "run-p --aggregate-output -l build:*",
     "prebuild:node": "rimraf dist.node",
     "build:node": "tsc -b ./tsconfig.node.json",
     "prebuild:web": "rimraf dist.web",
     "build:web": "webpack build",
     "prebuild:d": "rimraf dist.d",
     "build:d": "tsc -b ./tsconfig.d.json",
-    "cs-fix": "eslint --fix .",
+    "cs-fix": "npm run-script -w tools/code-style cs-fix",
     "test": "run-p --aggregate-output -lc test:*",
     "test:node": "c8 mocha -p",
     "test:web": "node -e 'console.log(\"TODO: write web test\")'",
     "test:lint": "tsc --noEmit",
-    "test:standard": "eslint .",
-    "api-doc": "run-p --aggregate-output -lc api-doc:*",
-    "api-doc:node": "typedoc --options typedoc.node.json",
-    "api-doc:web": "typedoc --options typedoc.web.json"
+    "test:standard": "npm run-script -w tools/code-style test",
+    "api-doc": "npm run-script -w tools/docs-gen api-doc"
   }
 }

tools/code-style/.gitignore

@@ -0,0 +1,4 @@
+*
+!/.gitignore
+!/package.json
+!/.npmrc

tools/code-style/.npmrc

@@ -0,0 +1,3 @@
+; see the docs: https://docs.npmjs.com/cli/v9/using-npm/config
+
+package-lock=false

tools/code-style/package.json

@@ -0,0 +1,29 @@
+{
+  "private": true,
+  "name": "@cyclonedx/cyclonedx-library-code-style",
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">=25"
+  },
+  "dependencies": {
+    "@typescript-eslint/eslint-plugin": "6.21.0",
+    "@typescript-eslint/parser": "6.21.0",
+    "eslint": "8.57.0",
+    "eslint-config-love": "43.1.0",
+    "eslint-config-standard": "17.1.0",
+    "eslint-plugin-editorconfig": "4.0.3",
+    "eslint-plugin-header": "3.1.1",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-jsdoc": "48.2.8",
+    "eslint-plugin-n": "16.6.2",
+    "eslint-plugin-promise": "6.2.0",
+    "eslint-plugin-simple-import-sort": "12.1.0",
+    "eslint-plugin-tsdoc": "0.3.0",
+    "@cyclonedx/cyclonedx-library-docs-gen": "file:../docs-gen"
+  },
+  "scripts": {
+    "test": "cd ../..; eslint .",
+    "cs-fix": "cd ../..; eslint --fix ."
+  },
+  "workspaces": []
+}