@dpuse/dpuse-development 0.3.783 → 0.3.787
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 +32 -34
- package/dist/dpuse-development.es.js +258 -240
- package/dist/dpuse-development.es.js.map +1 -1
- package/dist/types/src/utilities/index.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,9 +5,6 @@
|
|
|
5
5
|
[](./LICENSE)
|
|
6
6
|
[](https://github.com/dpuse/dpuse-development/releases/latest)
|
|
7
7
|
[](https://github.com/dpuse/dpuse-development/actions/workflows/ci.yml)
|
|
8
|
-
[](https://github.com/dpuse/dpuse-development/actions/workflows/codeql.yml)
|
|
9
|
-
[](./code-health-reports/fallow/index.md)
|
|
10
|
-
[](https://sonarcloud.io/summary/new_code?id=dpuse_dpuse-development)
|
|
11
8
|
|
|
12
9
|
[DPUse](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)
|
|
13
10
|
|
|
@@ -54,7 +51,7 @@ npm install
|
|
|
54
51
|
|
|
55
52
|
_Requires [Node.js](https://nodejs.org/) 24 or later, [npm](https://www.npmjs.com/) 12 or later, and [TypeScript](https://www.typescriptlang.org/) 6.0.3 or later._
|
|
56
53
|
|
|
57
|
-
This repository manages itself using the actions it implements.
|
|
54
|
+
This repository manages itself using the actions it implements. See the `scripts` block in [package.json](https://github.com/dpuse/dpuse-development/blob/main/package.json) for details.
|
|
58
55
|
|
|
59
56
|
<!-- USAGE_END -->
|
|
60
57
|
|
|
@@ -81,11 +78,11 @@ _Note: Sonda's Vite reports currently exclude CSS files, since Vite does not gen
|
|
|
81
78
|
|
|
82
79
|
| Chunk/Module/File | Composition |
|
|
83
80
|
| :----------------------------------------------------------------------------------------------- | :--------------------------- |
|
|
84
|
-
| dist/dpuse-development.es.js |
|
|
85
|
-
| acorn → dist/acorn.mjs | `████████░░░░░░░░░░░░` 39.
|
|
86
|
-
| acorn-typescript → lib/index.mjs | `███████░░░░░░░░░░░░░` 34.
|
|
87
|
-
| src | `███░░░░░░░░░░░░░░░░░`
|
|
88
|
-
| documentQualitySecurity.ts |
|
|
81
|
+
| dist/dpuse-development.es.js | 332.6 kB · gzip 85.6 kB |
|
|
82
|
+
| acorn → dist/acorn.mjs | `████████░░░░░░░░░░░░` 39.3% |
|
|
83
|
+
| acorn-typescript → lib/index.mjs | `███████░░░░░░░░░░░░░` 34.4% |
|
|
84
|
+
| src | `███░░░░░░░░░░░░░░░░░` 16.1% |
|
|
85
|
+
| documentQualitySecurity.ts | `█░░░░░░░░░░░░░░░░░░░` 2.9% |
|
|
89
86
|
| index.ts | `░░░░░░░░░░░░░░░░░░░░` 2.4% |
|
|
90
87
|
| documentApiReference.ts | `░░░░░░░░░░░░░░░░░░░░` 2.3% |
|
|
91
88
|
| documentDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 1.7% |
|
|
@@ -93,9 +90,9 @@ _Note: Sonda's Vite reports currently exclude CSS files, since Vite does not gen
|
|
|
93
90
|
| checkConfigFiles.ts | `░░░░░░░░░░░░░░░░░░░░` 1.1% |
|
|
94
91
|
| documentUsage.ts | `░░░░░░░░░░░░░░░░░░░░` 0.8% |
|
|
95
92
|
| documentActions.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
|
|
96
|
-
| documentOpening.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
|
|
97
93
|
| cloudflare.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
|
|
98
|
-
| checkDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 0.
|
|
94
|
+
| checkDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 0.4% |
|
|
95
|
+
| documentOpening.ts | `░░░░░░░░░░░░░░░░░░░░` 0.4% |
|
|
99
96
|
| documentContributingLicense.ts | `░░░░░░░░░░░░░░░░░░░░` 0.4% |
|
|
100
97
|
| releaseProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.3% |
|
|
101
98
|
| testProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.2% |
|
|
@@ -107,7 +104,7 @@ _Note: Sonda's Vite reports currently exclude CSS files, since Vite does not gen
|
|
|
107
104
|
| buildProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
|
|
108
105
|
| lintCode.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
|
|
109
106
|
| checkProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.0% |
|
|
110
|
-
| (bundler output, whitespace & JSON) | `█░░░░░░░░░░░░░░░░░░░` 6.
|
|
107
|
+
| (bundler output, whitespace & JSON) | `█░░░░░░░░░░░░░░░░░░░` 6.6% |
|
|
111
108
|
| @dpuse/dpuse-shared | `█░░░░░░░░░░░░░░░░░░░` 3.4% |
|
|
112
109
|
| dist/componentConfig.schema-DT3mO5rS.js | `█░░░░░░░░░░░░░░░░░░░` 2.6% |
|
|
113
110
|
| dist/dpuse-shared-componentModuleConnector.es.js | `░░░░░░░░░░░░░░░░░░░░` 0.7% |
|
|
@@ -123,40 +120,41 @@ _Note: Sonda's Vite reports currently exclude CSS files, since Vite does not gen
|
|
|
123
120
|
|
|
124
121
|
## Quality & Security
|
|
125
122
|
|
|
126
|
-
This section is updated each time `npm run document` is run. Settings come from the repository's workflow files and GitHub
|
|
123
|
+
This section is updated each time `npm run document` is run. Settings come from the repository's workflow files and GitHub. Test coverage and the Fallow score are measured at the same time.
|
|
127
124
|
|
|
128
125
|
### Testing
|
|
129
126
|
|
|
130
|
-
| Check
|
|
131
|
-
| :------------------- |
|
|
132
|
-
| Unit tests | ✅ On
|
|
133
|
-
| Property-based tests | ✅ fast-check
|
|
134
|
-
| Test coverage | ✅
|
|
127
|
+
| Check | Status | What it does |
|
|
128
|
+
| :------------------- | :----- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
129
|
+
| Unit tests | ✅ On | [Vitest](https://vitest.dev) runs the unit tests. Runs in the [CI workflow](https://github.com/dpuse/dpuse-development/actions/workflows/ci.yml) on every push to `main`. |
|
|
130
|
+
| Property-based tests | ✅ On | [fast-check](https://fast-check.dev) runs many random inputs per test to find edge cases, alongside the unit tests. Runs in the [CI workflow](https://github.com/dpuse/dpuse-development/actions/workflows/ci.yml) on every push to `main`. |
|
|
131
|
+
| Test coverage | ✅ On |  [Vitest's V8 coverage](https://vitest.dev/guide/coverage) measures the share of source lines the unit tests run. The target is 80%. |
|
|
135
132
|
|
|
136
133
|
### Code Quality
|
|
137
134
|
|
|
138
|
-
| Check
|
|
139
|
-
|
|
|
140
|
-
| [Fallow](./code-health-reports/fallow/index.md)
|
|
141
|
-
| [
|
|
135
|
+
| Check | Status | What it does |
|
|
136
|
+
| :------------ | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
137
|
+
| Code health | ✅ On | [](./code-health-reports/fallow/index.md) [Fallow](https://github.com/fallow-rs/fallow) finds unused code, duplication, complexity and dependency problems. |
|
|
138
|
+
| Code analysis | ✅ On | [](https://sonarcloud.io/summary/new_code?id=dpuse_dpuse-development) [SonarCloud](https://sonarcloud.io) checks every push for bugs, code smells and vulnerabilities. |
|
|
139
|
+
| Linting | ✅ On | [ESLint](https://eslint.org) checks the code for errors and style problems. Runs in the [CI workflow](https://github.com/dpuse/dpuse-development/actions/workflows/ci.yml) on every push to `main`. |
|
|
142
140
|
|
|
143
141
|
### Security Analysis
|
|
144
142
|
|
|
145
|
-
| Check
|
|
146
|
-
|
|
|
147
|
-
| [
|
|
148
|
-
|
|
|
149
|
-
|
|
|
143
|
+
| Check | Status | What it does |
|
|
144
|
+
| :-------------- | :----- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
145
|
+
| Push protection | ✅ On | [GitHub push protection](https://docs.github.com/en/code-security/secret-scanning/push-protection-for-repositories-and-organizations) blocks pushes that contain credentials. |
|
|
146
|
+
| Static analysis | ✅ On | [](https://github.com/dpuse/dpuse-development/security/code-scanning) [CodeQL](https://codeql.github.com) scans GitHub Actions and JavaScript/TypeScript for security vulnerabilities, using the extended security queries, on every push and pull request to `main` and weekly. |
|
|
147
|
+
| Secret scanning | ✅ On | [GitHub secret scanning](https://docs.github.com/en/code-security/secret-scanning) detects credentials, such as API keys and tokens, committed to the repository. |
|
|
150
148
|
|
|
151
149
|
### Dependencies
|
|
152
150
|
|
|
153
|
-
| Check
|
|
154
|
-
|
|
|
155
|
-
|
|
|
156
|
-
| [Socket
|
|
157
|
-
|
|
|
158
|
-
|
|
|
159
|
-
|
|
|
151
|
+
| Check | Status | What it does |
|
|
152
|
+
| :------------------ | :----- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
153
|
+
| Vulnerability audit | ✅ On | [npm audit](https://docs.npmjs.com/cli/commands/npm-audit) fails when any dependency has a known vulnerability. Runs in the [CI workflow](https://github.com/dpuse/dpuse-development/actions/workflows/ci.yml) on every push to `main`. |
|
|
154
|
+
| Supply chain risk | ✅ On | [Socket](https://socket.dev) flags malicious packages, typosquatting and suspicious behaviour that may not yet have a CVE. |
|
|
155
|
+
| Security alerts | ✅ On | [Dependabot](https://docs.github.com/en/code-security/dependabot) alerts when a dependency has a known vulnerability, using the GitHub Advisory Database. |
|
|
156
|
+
| Security updates | ❌ Off | [Dependabot](https://docs.github.com/en/code-security/dependabot) opens pull requests that update vulnerable dependencies. These are handled manually. |
|
|
157
|
+
| Version updates | ❌ Off | [Dependabot](https://docs.github.com/en/code-security/dependabot) opens pull requests for new dependency versions. These are handled manually. |
|
|
160
158
|
|
|
161
159
|
### OpenSSF 🚧
|
|
162
160
|
|