@dpuse/dpuse-development 0.3.780 → 0.3.782

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.
package/README.md CHANGED
@@ -79,41 +79,41 @@ This report is updated with each release, from the bundle the release builds, us
79
79
 
80
80
  _Note: Sonda's Vite reports currently exclude CSS files, since Vite does not generate source maps for CSS._
81
81
 
82
- |Chunk/Module/File|Composition|
83
- |:------ |:-----------|
84
- | dist/dpuse-development.es.js | 331.3 kB · gzip 85.2 kB |
85
- |     acorn → dist/acorn.mjs | `████████░░░░░░░░░░░░` 39.5% |
86
- |     acorn-typescript → lib/index.mjs | `███████░░░░░░░░░░░░░` 34.6% |
87
- |     src | `███░░░░░░░░░░░░░░░░░` 15.7% |
88
- |         documentQualitySecurity.ts | `░░░░░░░░░░░░░░░░░░░░` 2.5% |
89
- |         index.ts | `░░░░░░░░░░░░░░░░░░░░` 2.4% |
90
- |         documentApiReference.ts | `░░░░░░░░░░░░░░░░░░░░` 2.3% |
91
- |         documentDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 1.7% |
92
- |         documentBundleSizes.ts | `░░░░░░░░░░░░░░░░░░░░` 1.3% |
93
- |         checkConfigFiles.ts | `░░░░░░░░░░░░░░░░░░░░` 1.1% |
94
- |         documentUsage.ts | `░░░░░░░░░░░░░░░░░░░░` 0.8% |
95
- |         documentActions.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
96
- |         documentOpening.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
97
- |         cloudflare.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
98
- |         checkDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
99
- |         documentContributingLicense.ts | `░░░░░░░░░░░░░░░░░░░░` 0.4% |
100
- |         releaseProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.3% |
101
- |         testProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.3% |
102
- |         publishProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.2% |
103
- |         documentProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.2% |
104
- |         syncProjectWithGitHub.ts | `░░░░░░░░░░░░░░░░░░░░` 0.2% |
105
- |         formatCode.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
106
- |         auditDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
107
- |         buildProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
108
- |         lintCode.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
109
- |         checkProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.0% |
110
- |     (bundler output, whitespace & JSON) | `█░░░░░░░░░░░░░░░░░░░` 6.7% |
111
- |     @dpuse/dpuse-shared | `█░░░░░░░░░░░░░░░░░░░` 3.4% |
112
- |         dist/componentConfig.schema-DT3mO5rS.js | `█░░░░░░░░░░░░░░░░░░░` 2.6% |
113
- |         dist/dpuse-shared-componentModuleConnector.es.js | `░░░░░░░░░░░░░░░░░░░░` 0.7% |
114
- |         dist/moduleConfig.schema-aYmFWSrn.js | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
115
- |         dist/dpuse-shared-componentModulePresenter.es.js | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
116
- |     valibot → dist/index.mjs | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
82
+ | Chunk/Module/File | Composition |
83
+ | :----------------------------------------------------------------------------------------------- | :--------------------------- |
84
+ | dist/dpuse-development.es.js | 331.4 kB · gzip 85.3 kB |
85
+ |     acorn → dist/acorn.mjs | `████████░░░░░░░░░░░░` 39.5% |
86
+ |     acorn-typescript → lib/index.mjs | `███████░░░░░░░░░░░░░` 34.6% |
87
+ |     src | `███░░░░░░░░░░░░░░░░░` 15.7% |
88
+ |         documentQualitySecurity.ts | `░░░░░░░░░░░░░░░░░░░░` 2.5% |
89
+ |         index.ts | `░░░░░░░░░░░░░░░░░░░░` 2.4% |
90
+ |         documentApiReference.ts | `░░░░░░░░░░░░░░░░░░░░` 2.3% |
91
+ |         documentDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 1.7% |
92
+ |         documentBundleSizes.ts | `░░░░░░░░░░░░░░░░░░░░` 1.3% |
93
+ |         checkConfigFiles.ts | `░░░░░░░░░░░░░░░░░░░░` 1.1% |
94
+ |         documentUsage.ts | `░░░░░░░░░░░░░░░░░░░░` 0.8% |
95
+ |         documentActions.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
96
+ |         documentOpening.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
97
+ |         cloudflare.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
98
+ |         checkDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
99
+ |         documentContributingLicense.ts | `░░░░░░░░░░░░░░░░░░░░` 0.4% |
100
+ |         releaseProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.3% |
101
+ |         testProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.3% |
102
+ |         publishProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.2% |
103
+ |         documentProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.2% |
104
+ |         syncProjectWithGitHub.ts | `░░░░░░░░░░░░░░░░░░░░` 0.2% |
105
+ |         formatCode.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
106
+ |         auditDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
107
+ |         buildProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
108
+ |         lintCode.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
109
+ |         checkProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.0% |
110
+ |     (bundler output, whitespace & JSON) | `█░░░░░░░░░░░░░░░░░░░` 6.7% |
111
+ |     @dpuse/dpuse-shared | `█░░░░░░░░░░░░░░░░░░░` 3.4% |
112
+ |         dist/componentConfig.schema-DT3mO5rS.js | `█░░░░░░░░░░░░░░░░░░░` 2.6% |
113
+ |         dist/dpuse-shared-componentModuleConnector.es.js | `░░░░░░░░░░░░░░░░░░░░` 0.7% |
114
+ |         dist/moduleConfig.schema-aYmFWSrn.js | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
115
+ |         dist/dpuse-shared-componentModulePresenter.es.js | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
116
+ |     valibot → dist/index.mjs | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
117
117
 
118
118
  (bundler output, whitespace & JSON) = bytes Sonda can't trace to a source file: whitespace (indentation and line breaks), code the bundler generates (region comments, the combined import/export lines, its small runtime helper and wrappers), and imported JSON such as `config.json`, which the bundler doesn't map. The JSON and the generated code are real bytes that ship; the whitespace mostly disappears once compressed.
119
119
 
@@ -127,36 +127,36 @@ This section is updated each time `npm run document` is run. Settings come from
127
127
 
128
128
  ### Testing
129
129
 
130
- |Check or setting|Status|What it does|
131
- |:-|:-|:-|
132
- |Unit tests|✅ On|Run in CI on every push to `main`.|
133
- |Property-based tests|✅ fast-check|Fuzz testing: many random inputs per test to find edge cases, run with the unit tests.|
134
- |Test coverage|✅ 99.7% of lines|Share of source lines the unit tests run. The target is 80%.|
130
+ | Check or setting | Status | What it does |
131
+ | :------------------- | :---------------- | :------------------------------------------------------------------------------------- |
132
+ | Unit tests | ✅ On | Run in CI on every push to `main`. |
133
+ | Property-based tests | ✅ fast-check | Fuzz testing: many random inputs per test to find edge cases, run with the unit tests. |
134
+ | Test coverage | ✅ 99.7% of lines | Share of source lines the unit tests run. The target is 80%. |
135
135
 
136
136
  ### Code Quality
137
137
 
138
- |Check or setting|Status|What it does|
139
- |:-|:-|:-|
140
- |[Fallow](./code-health-reports/fallow/index.md)|✅ A (85)|Unused code, duplication, complexity and dependency hygiene.|
141
- |[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.|
138
+ | Check or setting | Status | What it does |
139
+ | :------------------------------------------------------------------------------ | :-------- | :--------------------------------------------------------------------------------------- |
140
+ | [Fallow](./code-health-reports/fallow/index.md) | ✅ A (85) | Unused code, duplication, complexity and dependency hygiene. |
141
+ | [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. |
142
142
 
143
143
  ### Security Analysis
144
144
 
145
- |Check or setting|Status|What it does|
146
- |:-|:-|:-|
147
- |[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.|
148
- |Secret scanning|✅ On|Detects credentials, such as API keys and tokens, committed to the repository.|
149
- |Push protection|✅ On|Blocks pushes that contain credentials.|
145
+ | Check or setting | Status | What it does |
146
+ | :-------------------------------------------------------------------------- | :--------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- |
147
+ | [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. |
148
+ | Secret scanning | ✅ On | Detects credentials, such as API keys and tokens, committed to the repository. |
149
+ | Push protection | ✅ On | Blocks pushes that contain credentials. |
150
150
 
151
151
  ### Dependencies
152
152
 
153
- |Check or setting|Status|What it does|
154
- |:-|:-|:-|
155
- |npm audit|✅ On|Fails CI when any dependency has a known vulnerability.|
156
- |[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.|
157
- |Dependabot alerts|✅ On|Alerts when a dependency has a known vulnerability, using the GitHub Advisory Database.|
158
- |Dependabot security updates|❌ Off|Opens pull requests that update vulnerable dependencies.|
159
- |Dependabot version updates|❌ Off|Opens pull requests for new dependency versions.|
153
+ | Check or setting | Status | What it does |
154
+ | :------------------------------- | :----- | :------------------------------------------------------------------------------------------------------------------------------- |
155
+ | npm audit | ✅ On | Fails CI when any dependency has a known vulnerability. |
156
+ | [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. |
157
+ | Dependabot alerts | ✅ On | Alerts when a dependency has a known vulnerability, using the GitHub Advisory Database. |
158
+ | Dependabot security updates | ❌ Off | Opens pull requests that update vulnerable dependencies. |
159
+ | Dependabot version updates | ❌ Off | Opens pull requests for new dependency versions. |
160
160
 
161
161
  ### OpenSSF 🚧
162
162
 
@@ -6385,7 +6385,7 @@ async function Br(e) {
6385
6385
  }
6386
6386
  }
6387
6387
  async function Vr(e, n) {
6388
- await t.writeFile(e, JSON.stringify(n, void 0, 4), "utf-8");
6388
+ await t.writeFile(e, `${JSON.stringify(n, void 0, 4)}\n`, "utf-8");
6389
6389
  }
6390
6390
  async function Hr(e, t, n) {
6391
6391
  await Ur("README.md", ei(await zr("./README.md"), e, t, n));
@@ -7474,7 +7474,13 @@ function Oo(e) {
7474
7474
  async function ko({ allowedLicenses: e = "MIT", moduleLevel: t = !1 } = {}) {
7475
7475
  try {
7476
7476
  let n = Wr((await J("config.json")).id).typeId === "connector";
7477
- await Wi(), n && await Si(), await Sa(), await ji(e), await Br("bundle-analysis-reports/sonda/index.json") === null ? Z(`ℹ️ Bundle sizes NOT documented, as there is no '${no}' yet. Build the project first.`) : await uo({ moduleLevel: t }), await ra(), await Ci(), await Br("API_REFERENCE.md") === null ? Z(`ℹ️ '${Oa}' NOT required by this project`) : await ja();
7477
+ await Wi(), n && await Si(), await Sa(), await ji(e), await Br("bundle-analysis-reports/sonda/index.json") === null ? Z(`ℹ️ Bundle sizes NOT documented, as there is no '${no}' yet. Build the project first.`) : await uo({ moduleLevel: t }), await ra(), await Ci();
7478
+ let r = await Br(Oa) !== null;
7479
+ r ? await ja() : Z(`ℹ️ '${Oa}' NOT required by this project`), await q("ℹ️ Format generated files", "prettier", [
7480
+ "--write",
7481
+ "README.md",
7482
+ ...r ? [Oa] : []
7483
+ ]);
7478
7484
  } catch (e) {
7479
7485
  console.error("❌ Error documenting project", e), process.exit(1);
7480
7486
  }