@dpuse/dpuse-development 0.3.751 → 0.3.753

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -37,6 +37,9 @@ jobs:
37
37
  with:
38
38
  languages: ${{ matrix.language }}
39
39
  build-mode: ${{ matrix.build-mode }}
40
+ # More security queries than the default suite, some less precise. Code quality is left to ESLint, SonarCloud
41
+ # and Fallow.
42
+ queries: security-extended
40
43
 
41
44
  - name: Perform CodeQL Analysis
42
45
  uses: github/codeql-action/analyze@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4
package/README.md CHANGED
@@ -6,6 +6,7 @@
6
6
  [![DPUse version](https://img.shields.io/github/v/release/dpuse/dpuse-development?color=f6821f&label=DPUse)](https://github.com/dpuse/dpuse-development/releases/latest)
7
7
  [![CI](https://github.com/dpuse/dpuse-development/actions/workflows/ci.yml/badge.svg)](https://github.com/dpuse/dpuse-development/actions/workflows/ci.yml)
8
8
  [![CodeQL](https://github.com/dpuse/dpuse-development/actions/workflows/codeql.yml/badge.svg)](https://github.com/dpuse/dpuse-development/actions/workflows/codeql.yml)
9
+ [![Fallow code health](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fdpuse%2Fdpuse-development%2Fmain%2Fcode-health-reports%2Ffallow%2Fbadge.json)](./code-health-reports/fallow/index.md)
9
10
  [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=dpuse_dpuse-development&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=dpuse_dpuse-development)
10
11
 
11
12
  [Documentation](https://www.dpuse.app) · [Report a Vulnerability](https://github.com/dpuse/dpuse-development/security/advisories/new) · [Open an Issue](https://github.com/dpuse/dpuse-development/issues)
@@ -53,23 +54,23 @@ _Requires [Node.js](https://nodejs.org/) 24 or later, [npm](https://www.npmjs.co
53
54
 
54
55
  This repository provides these commands to every DPUse project, and uses them itself:
55
56
 
56
- | Command | What it does |
57
- | :----------------------------- | :-------------------------------------------------------------------------------------- |
58
- | `npm run build` | Builds the project. |
59
- | `npm test` | Runs the tests. |
60
- | `npm run lint` | Checks the code with ESLint. |
61
- | `npm run format` | Formats the code with Prettier. |
62
- | `npm run audit` | Checks dependencies for known vulnerabilities with npm audit. |
63
- | `npm run check` | Checks configuration files against the DPUse templates and lists outdated dependencies. |
64
- | `npm run update` | Updates the DPUse packages this project depends on to their latest versions. |
65
- | `npm run document` | Regenerates the README's generated sections. |
66
- | `npm run documentOpening` | Regenerates the README's opening section. |
67
- | `npm run documentUsage` | Regenerates the README's Usage section. |
68
- | `npm run documentDependencies` | Regenerates the README's dependency licence report. |
69
- | `npm run documentBundleSizes` | Regenerates the README's bundle size report. |
70
- | `npm run documentGovernance` | Regenerates the README's Security & Quality, Contributing and License sections. |
71
- | `npm run sync` | Bumps the version, then commits and pushes to GitHub. |
72
- | `npm run release` | Bumps the version, commits and pushes, and creates a GitHub release. |
57
+ |Command|What it does|
58
+ |:-|:-|
59
+ |`npm run build`|Builds the project.|
60
+ |`npm test`|Runs the tests.|
61
+ |`npm run test:coverage`|Runs the unit tests and measures coverage.|
62
+ |`npm run lint`|Checks the code with ESLint.|
63
+ |`npm run format`|Formats the code with Prettier.|
64
+ |`npm run audit`|Checks dependencies for known vulnerabilities with npm audit.|
65
+ |`npm run check`|Checks configuration files against the DPUse templates and lists outdated dependencies.|
66
+ |`npm run document`|Regenerates the README's generated sections.|
67
+ |`npm run documentOpening`|Regenerates the README's opening section.|
68
+ |`npm run documentUsage`|Regenerates the README's Usage section.|
69
+ |`npm run documentDependencies`|Regenerates the README's dependency licence report.|
70
+ |`npm run documentBundleSizes`|Regenerates the README's bundle size report.|
71
+ |`npm run documentGovernance`|Regenerates the README's Quality & Security, Contributing and License sections.|
72
+ |`npm run sync`|Bumps the version, then commits and pushes to GitHub.|
73
+ |`npm run release`|Bumps the version, commits and pushes, and creates a GitHub release.|
73
74
 
74
75
  <!-- USAGE_END -->
75
76
 
@@ -112,31 +113,31 @@ All actions are designed to be run from `package.json` scripts and assume that t
112
113
 
113
114
  ## Bundle Analysis
114
115
 
115
- The Bundle Analysis Report is generated automatically on each release using [Sonda](https://sonda.dev/), which analyses final source maps to reveal the actual effects of tree-shaking and minification rather than relying on pre-build estimates.
116
+ This report is updated each time the project is built, using [Sonda](https://sonda.dev/), which analyses final source maps to reveal the actual effects of tree-shaking and minification rather than relying on pre-build estimates.
116
117
 
117
118
  _Note: Sonda's Vite reports currently exclude CSS files, since Vite does not generate source maps for CSS._
118
119
 
119
120
  |Chunk/Module/File|Composition|
120
121
  |:------ |:-----------|
121
- | dist/dpuse-development.es.js | 323.0 kB · gzip 83.1 kB |
122
- | &nbsp;&nbsp;&nbsp;&nbsp;acorn → dist/acorn.mjs | `████████░░░░░░░░░░░░` 40.5% |
123
- | &nbsp;&nbsp;&nbsp;&nbsp;acorn-typescript → lib/index.mjs | `███████░░░░░░░░░░░░░` 35.5% |
124
- | &nbsp;&nbsp;&nbsp;&nbsp;src | `███░░░░░░░░░░░░░░░░░` 13.5% |
125
- | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentGovernance.ts | `░░░░░░░░░░░░░░░░░░░░` 2.5% |
122
+ | dist/dpuse-development.es.js | 323.7 kB · gzip 83.3 kB |
123
+ | &nbsp;&nbsp;&nbsp;&nbsp;acorn → dist/acorn.mjs | `████████░░░░░░░░░░░░` 40.4% |
124
+ | &nbsp;&nbsp;&nbsp;&nbsp;acorn-typescript → lib/index.mjs | `███████░░░░░░░░░░░░░` 35.4% |
125
+ | &nbsp;&nbsp;&nbsp;&nbsp;src | `███░░░░░░░░░░░░░░░░░` 13.8% |
126
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentGovernance.ts | `█░░░░░░░░░░░░░░░░░░░` 2.7% |
126
127
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 1.7% |
127
128
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;manageProject.ts | `░░░░░░░░░░░░░░░░░░░░` 1.7% |
128
- | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;index.ts | `░░░░░░░░░░░░░░░░░░░░` 1.6% |
129
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;index.ts | `░░░░░░░░░░░░░░░░░░░░` 1.7% |
129
130
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentUsage.ts | `░░░░░░░░░░░░░░░░░░░░` 1.4% |
130
- | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentBundleSizes.ts | `░░░░░░░░░░░░░░░░░░░░` 1.4% |
131
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentBundleSizes.ts | `░░░░░░░░░░░░░░░░░░░░` 1.3% |
131
132
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;checkConfigFiles.ts | `░░░░░░░░░░░░░░░░░░░░` 1.2% |
132
133
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentActions.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
134
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentOpening.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
133
135
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cloudflare.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
134
136
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;checkDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
135
- | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentOpening.ts | `░░░░░░░░░░░░░░░░░░░░` 0.4% |
136
137
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;formatCode.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
137
138
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;auditDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
138
139
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lintCode.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
139
- | &nbsp;&nbsp;&nbsp;&nbsp;(bundler output, whitespace & JSON) | `█░░░░░░░░░░░░░░░░░░░` 6.9% |
140
+ | &nbsp;&nbsp;&nbsp;&nbsp;(bundler output, whitespace & JSON) | `█░░░░░░░░░░░░░░░░░░░` 6.7% |
140
141
  | &nbsp;&nbsp;&nbsp;&nbsp;@dpuse/dpuse-shared | `█░░░░░░░░░░░░░░░░░░░` 3.5% |
141
142
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;dist/componentConfig.schema-DT3mO5rS.js | `█░░░░░░░░░░░░░░░░░░░` 2.6% |
142
143
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;dist/dpuse-shared-componentModuleConnector.es.js | `░░░░░░░░░░░░░░░░░░░░` 0.7% |
@@ -150,30 +151,42 @@ _Note: Sonda's Vite reports currently exclude CSS files, since Vite does not gen
150
151
 
151
152
  <!-- GOVERNANCE_START -->
152
153
 
153
- ## Security & Quality
154
+ ## Quality & Security
154
155
 
155
- ### Checks & Settings
156
+ This section is updated each time `npm run document` is run. Settings come from the repository's workflow files and GitHub, and test coverage and the Fallow score are measured at the same time.
156
157
 
157
- Read from the repository each time this README is generated, so the status is current as of the latest release.
158
+ ### Testing
158
159
 
159
- | Check or setting | Status | What it does |
160
- | :------------------------------------------------------------------------------ | :--------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------- |
161
- | [CodeQL](https://github.com/dpuse/dpuse-development/security/code-scanning) | ✅ GitHub Actions, JavaScript/TypeScript | Static analysis for security vulnerabilities and coding errors, on every push and pull request to `main` and weekly. |
162
- | [SonarCloud](https://sonarcloud.io/summary/new_code?id=dpuse_dpuse-development) | ✅ On | Code quality and security analysis on every push: bugs, code smells and vulnerabilities. |
163
- | Unit tests | ✅ On | Run in CI on every push to `main`. |
164
- | Property-based tests | ✅ fast-check | Fuzz testing: many random inputs per test to find edge cases, run with the unit tests. |
165
- | npm audit | ✅ On | Fails CI when any dependency has a known vulnerability. |
166
- | [Socket.dev](https://socket.dev) | ✅ On | Flags supply chain risk in dependencies: malicious packages, typosquatting and suspicious behaviour that may not yet have a CVE. |
167
- | Dependabot alerts | ✅ On | Alerts when a dependency has a known vulnerability, using the GitHub Advisory Database. |
168
- | Dependabot security updates | ❌ Off | Opens pull requests that update vulnerable dependencies. |
169
- | Dependabot version updates | ❌ Off | Opens pull requests for new dependency versions. |
170
- | Secret scanning | ✅ On | Detects credentials, such as API keys and tokens, committed to the repository. |
171
- | Push protection | ✅ On | Blocks pushes that contain credentials. |
172
- | Private vulnerability reporting | ✅ On | Lets anyone report a vulnerability privately. See [Reporting Vulnerabilities](#reporting-vulnerabilities). |
160
+ |Check or setting|Status|What it does|
161
+ |:-|:-|:-|
162
+ |Unit tests|✅ On|Run in CI on every push to `main`.|
163
+ |Property-based tests|✅ fast-check|Fuzz testing: many random inputs per test to find edge cases, run with the unit tests.|
164
+ |Test coverage|✅ 99.6% of lines|Share of source lines the unit tests run. The target is 80%.|
173
165
 
174
- ### Reporting Vulnerabilities
166
+ ### Code Quality
175
167
 
176
- Please do not open public GitHub issues for security vulnerabilities. Use [GitHub private vulnerability reporting](https://github.com/dpuse/dpuse-development/security/advisories/new) instead. See [SECURITY.md](./SECURITY.md) for the full disclosure policy, contact details, and expected response times.
168
+ |Check or setting|Status|What it does|
169
+ |:-|:-|:-|
170
+ |[Fallow](./code-health-reports/fallow/index.md)|✅ A (87)|Unused code, duplication, complexity and dependency hygiene.|
171
+ |[SonarCloud](https://sonarcloud.io/summary/new_code?id=dpuse_dpuse-development)|✅ On|Code quality and security analysis on every push: bugs, code smells and vulnerabilities.|
172
+
173
+ ### Security Analysis
174
+
175
+ |Check or setting|Status|What it does|
176
+ |:-|:-|:-|
177
+ |[CodeQL](https://github.com/dpuse/dpuse-development/security/code-scanning)|✅ GitHub Actions, JavaScript/TypeScript|Static analysis for security vulnerabilities, using the extended security queries, on every push and pull request to `main` and weekly.|
178
+ |Secret scanning|✅ On|Detects credentials, such as API keys and tokens, committed to the repository.|
179
+ |Push protection|✅ On|Blocks pushes that contain credentials.|
180
+
181
+ ### Dependencies
182
+
183
+ |Check or setting|Status|What it does|
184
+ |:-|:-|:-|
185
+ |npm audit|✅ On|Fails CI when any dependency has a known vulnerability.|
186
+ |[Socket.dev](https://socket.dev)|✅ On|Flags supply chain risk in dependencies: malicious packages, typosquatting and suspicious behaviour that may not yet have a CVE.|
187
+ |Dependabot alerts|✅ On|Alerts when a dependency has a known vulnerability, using the GitHub Advisory Database.|
188
+ |Dependabot security updates|❌ Off|Opens pull requests that update vulnerable dependencies.|
189
+ |Dependabot version updates|❌ Off|Opens pull requests for new dependency versions.|
177
190
 
178
191
  ### OpenSSF 🚧
179
192
 
@@ -184,6 +197,10 @@ This project is working towards the [OpenSSF Best Practices](https://www.bestpra
184
197
  > [!NOTE]
185
198
  > Apart from the Best Practices badge above, the remaining Scorecard gaps need multi-person review or a pull-request workflow, which this solo-maintained project doesn't use.
186
199
 
200
+ ### Reporting Vulnerabilities
201
+
202
+ Please do not open public GitHub issues for security vulnerabilities. Use [GitHub private vulnerability reporting](https://github.com/dpuse/dpuse-development/security/advisories/new) instead. See [SECURITY.md](./SECURITY.md) for the full disclosure policy, contact details, and expected response times.
203
+
187
204
  ## Contributing
188
205
 
189
206
  This repository is maintained solely by its owner and does not, at present, accept external contributions into the canonical repo. Its source is published openly under the MIT License — every DPUse project is fully open source except DPUse Engine, which remains closed and proprietary.