feat: modernize 20250228 (#1369)

- dependencies: use modern `eslint` and code-style tools 
- refactor: modernize imports
- refactor: modernize code style 
- docs: fix tsdocs


fixes #1347

---------

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

Author: jkowalleck

.eslintignore

@@ -3,7 +3,9 @@
 version: 2
 updates:
   - package-ecosystem: 'npm'
-    directory: '/'
+    directories:
+      - '/.'
+      - '/tools/code-style'
     schedule:
       interval: 'weekly'
       day: 'saturday'
@@ -44,11 +46,13 @@ updates:
         patterns:
           - 'eslint'
           - '@eslint/*'
+          - '*-eslint'
           - 'eslint-*'
-          - '@eslint-community/*'
-          - '@typescript-eslint/*'
           - '@types/eslint'
-          - '@types/eslint*'
+          - '@types/eslint-*'
+          - '@types/*-eslint'
+          - '@eslint-community/*'
+          - '@typescript-eslint/*'z
       webpack:
         patterns:
           - 'webpack'

.eslintrc.js

@@ -54,7 +54,7 @@ jobs:
   test-standard:
     name: test standard
     runs-on: ubuntu-latest
-    timeout-minutes: 30
+    timeout-minutes: 10
     steps:
       - name: Checkout
         # see https://github.com/actions/checkout
@@ -67,9 +67,34 @@ jobs:
           # cache: "npm"
           # cache-dependency-path: "**/package-lock.json"
       - name: setup project
-        run: npm i --ignore-scripts
+        run: |
+          npm install --ignore-scripts --loglevel=silly
+      - name: setup tools
+        run: |
+          echo "::group::install code-style deps"
+          npm run -- dev-setup:code-style --ignore-scripts --loglevel=silly
+          echo "::endgroup::"
+      - name: make reports dir
+        run: mkdir -p "$REPORTS_DIR"
       - name: test
-        run: npm run test:standard
+        run: >
+          npm run -- test:standard
+          --format json
+          --output-file "$PWD/$REPORTS_DIR/eslint.json"
+      - name: Annotate Code
+        if: ${{ failure() || success() }}
+        # see https://github.com/DerLev/eslint-annotations
+        uses: DerLev/eslint-annotations@v2
+        with:
+          eslint-report: ${{ env.REPORTS_DIR }}/eslint.json
+      - name: artifact eslint result
+        # see https://github.com/actions/upload-artifact
+        uses: actions/upload-artifact@v4
+        if: ${{ failure() }}
+        with:
+          name: ${{ env.STANDARD_REPORTS_ARTIFACT }}
+          path: ${{ env.REPORTS_DIR }}
+          if-no-files-found: error
 
   test-jest:
     needs: [ 'build' ]

.github/dependabot.yml

@@ -5,12 +5,12 @@ But please read the
 [CycloneDX contributing guidelines](https://github.com/CycloneDX/.github/blob/master/CONTRIBUTING.md)
 first.
 
-## Setup
+## Set up the project
 
-To start developing simply run to install dev-dependencies and tools:
+Install dependencies:
 
 ```shell
-npm ci
+npm run dev-setup
 ```
 
 This will install process automatically build the project from source.

.github/workflows/nodejs.yml

@@ -8,6 +8,8 @@ All notable changes to this project will be documented in this file.
 
 * BREAKING Changes
   * Dropped support for `node<20.18.0` ([#1362] via [#1365])
+* Documentation
+  * Fixed docs of default values (via [#1369]) 
 * Dependencies
   * Upgraded runtime-dependency `@cyclonedx/cyclonedx-library@^8.0.0`, was `@^7.0.0` (via [#1367])
   * Upgraded runtime-dependency `normalize-package-data@^7.0.0`, was `@^3||^4||^5||^6` (via [#1368])
@@ -16,6 +18,7 @@ All notable changes to this project will be documented in this file.
 [#1365]: https://github.com/CycloneDX/cyclonedx-webpack-plugin/pull/1365
 [#1367]: https://github.com/CycloneDX/cyclonedx-webpack-plugin/pull/1367
 [#1368]: https://github.com/CycloneDX/cyclonedx-webpack-plugin/pull/1368
+[#1369]: https://github.com/CycloneDX/cyclonedx-webpack-plugin/pull/1369
 
 ## 4.0.1 - 2025-01-29
 

CONTRIBUTING.md

@@ -0,0 +1,106 @@
+/*!
+This file is part of CycloneDX Webpack plugin.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+SPDX-License-Identifier: Apache-2.0
+Copyright (c) OWASP Foundation. All Rights Reserved.
+*/
+
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+import { default as baseCfg, globals } from './tools/code-style/eslint.config.mjs'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+/* eslint-disable jsdoc/valid-types */
+
+/**
+ * @type {import('@types/eslint').Linter.FlatConfig[]}
+ * @see {@link https://eslint.org/}
+ */
+export default [
+  ...baseCfg,
+  {
+    name: 'project-specific',
+    rules: {
+      "complexity": ["error", { "max": 15 }]
+    }
+  },
+  {
+    name: 'project-specific',
+    files: ['src/*.ts'],
+    rules: {
+      '@typescript-eslint/no-unsafe-assignment': 'warn',
+      '@typescript-eslint/no-unsafe-member-access': 'warn',
+    }
+  },
+  {
+    files: ['**/*.js'],
+    languageOptions: { sourceType: 'commonjs' }
+  },
+  {
+    files: ['{src,tests}/**/*!(.{node,web}).{js,mjs,cjs.ts}'],
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.node
+      }
+    }
+  },
+  {
+    files: [
+      '**/*.{test,spec}.{js,mjs,cjs,ts}',
+      'tests/**.{js,mjs,cjs,ts}'
+    ],
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      }
+    }
+  },
+  {
+    files: ['src/**/*.ts'],
+    languageOptions: {
+      parserOptions: {
+        project: path.join(__dirname, 'tsconfig.json'),
+      },
+    },
+  },
+  {
+    files: ['examples/**/*.{js,mjs,cjs,ts}'],
+    rules: {
+      'no-console': 'off'
+    },
+    languageOptions: {
+      globals: globals.browser
+    }
+  },
+  {
+    // global ignores must have nothing but a "ignores" property!
+    // see https://github.com/eslint/eslint/discussions/17429#discussioncomment-6579229
+    ignores: [
+      'reports/',
+      'dist/',
+      'docs/api/',
+      'docs/_build/',
+      'docs/.venv/',
+      'examples/**/dist/',
+      'tools/',
+      'tests/integration/'
+    ],
+  },
+]

HISTORY.md

@@ -17,7 +17,7 @@ SPDX-License-Identifier: Apache-2.0
 Copyright (c) OWASP Foundation. All Rights Reserved.
 */
 
-const { Tooltip, Toast, Popover } = require('bootstrap')
+const { Popover, Toast, Tooltip } = require('bootstrap')
 
 // no real world use, but showcase
 

eslint.config.mjs

@@ -17,10 +17,12 @@ SPDX-License-Identifier: Apache-2.0
 Copyright (c) OWASP Foundation. All Rights Reserved.
 */
 
-const path = require('path')
+const path = require('node:path')
 
 const { CycloneDxWebpackPlugin } = require('@cyclonedx/webpack-plugin')
 
+/* eslint-disable jsdoc/valid-types */
+
 /** @type {import('@cyclonedx/webpack-plugin').CycloneDxWebpackPluginOptions} */
 const cycloneDxWebpackPluginOptions = {
   specVersion: '1.6',

examples/simple/src/index.js

@@ -17,10 +17,11 @@ SPDX-License-Identifier: Apache-2.0
 Copyright (c) OWASP Foundation. All Rights Reserved.
 */
 
+/* eslint-disable jsdoc/valid-types */
+
 /**
  * For a detailed explanation regarding each configuration property, visit:
  * {@link https://jestjs.io/docs/configuration}
- *
  * @type {import('jest').Config}
  */
 module.exports = {