@dpuse/dpuse-development 0.3.766 → 0.3.780

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
@@ -9,7 +9,9 @@
9
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)
10
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)
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)
12
+ [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
+
14
+ Actions for managing DPUse projects.
13
15
 
14
16
  ## About DPUse
15
17
 
@@ -25,7 +27,7 @@ In addition, DPUse provides [Tools](https://www.dpuse.app) used by the applicati
25
27
 
26
28
  ## Introduction
27
29
 
28
- Actions for managing DPUse projects.
30
+ The package implements a common set of actions used to manage DPUse repositories. All actions are designed to be run from `package.json` scripts and assume that the project follows the standard DPUse directory structure and that it includes a `config.json` file in the root directory. See [API Reference](https://github.com/dpuse/dpuse-development/blob/main/API_REFERENCE.md).
29
31
 
30
32
  <!-- OPENING_END -->
31
33
 
@@ -33,16 +35,16 @@ Actions for managing DPUse projects.
33
35
 
34
36
  ## Usage
35
37
 
36
- This package is published to the [public npm registry](https://www.npmjs.com/package/@dpuse/dpuse-development). Install it with:
38
+ This [package](https://www.npmjs.com/package/@dpuse/dpuse-development) is available on [npm](https://www.npmjs.com/). Install it with:
37
39
 
38
40
  ```bash
39
41
  npm install @dpuse/dpuse-development
40
42
  ```
41
43
 
42
44
  > [!WARNING]
43
- > This project is currently published to npm, but is not designed for general use. It is custom built for the DPUse CI/CD process. You are welcome to clone and customise it for your own purposes, but you will need to adapt it to your own project structure and tooling.
45
+ > This project is not designed for general use. It is custom built for the DPUse CI/CD process. You are welcome to clone and customise it for your own purposes, but you will need to adapt it to your own project structure and tooling.
44
46
 
45
- To work on the source instead, clone this repository. Cloned or forked code is unsupported and isn't guaranteed to remain compatible with the DPUse Engine as it evolves.
47
+ To work on the source instead, clone this repository.
46
48
 
47
49
  ```bash
48
50
  git clone https://github.com/dpuse/dpuse-development.git
@@ -52,55 +54,10 @@ npm install
52
54
 
53
55
  _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._
54
56
 
55
- This repository provides these commands to every DPUse project, and uses them itself:
56
-
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.|
57
+ This repository manages itself using the actions it implements.
74
58
 
75
59
  <!-- USAGE_END -->
76
60
 
77
- ## Architecture
78
-
79
- The package implements the following actions:
80
-
81
- | Name | Notes |
82
- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
83
- | auditDependencies | Audit the project's dependencies for known security vulnerabilities. Also runs the `npm outdated` command. |
84
- | checkConfigFiles | |
85
- | checkDependencies | Identifies outdated dependencies using npm `outdated` and `npm-check-updates` with option to automatically install latest versions. |
86
- | documentBundleSizes | |
87
- | documentDependencies | Identify licenses of the project's production and peer dependencies. Updates the table in the **Dependency Licenses** section of this page and summary files licenses.json and licenseTree.json in th licenses directory of this repository. Also downloads a copy of dependency license to `licenses/downloads'.. |
88
- | documentGovernance | |
89
- | documentActions | |
90
- | documentAPIReference | Lists every export of each import path in `API_REFERENCE.md`. Runs on each build where the project has that file. |
91
- | documentOpening | |
92
- | documentUsage | |
93
- | formatCode | Uses `prettier` to enforce formatting style rules. |
94
- | lintCode | Uses `eslint` to check the code for potential errors and enforces coding style rules. |
95
- | uploadDirectoryToR2 | |
96
- | buildProject | Builds the package using Vite. Output to '/dist' directory. Builds bundle analysis reports. |
97
- | publishProject | |
98
- | releaseProject | Bump version, builds config, builds project, synchronise with `GitHub` and publish to `npm` or Cloudflare. |
99
- | syncProjectWithGitHub | Synchronise the local repository with the main GitHub repository. |
100
- | testProject | |
101
-
102
- All actions are designed to be run from `package.json` scripts and assume that the project follows the standard DPUse directory structure and that it includes a `config.json` file in the root directory.
103
-
104
61
  ## API Reference
105
62
 
106
63
  See [API_REFERENCE.md](./API_REFERENCE.md) for the complete API reference, including every exported action and type.
@@ -118,32 +75,39 @@ See [API_REFERENCE.md](./API_REFERENCE.md) for the complete API reference, inclu
118
75
 
119
76
  ## Bundle Analysis
120
77
 
121
- 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.
78
+ This report is updated with each release, from the bundle the release builds, 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.
122
79
 
123
80
  _Note: Sonda's Vite reports currently exclude CSS files, since Vite does not generate source maps for CSS._
124
81
 
125
82
  |Chunk/Module/File|Composition|
126
83
  |:------ |:-----------|
127
- | dist/dpuse-development.es.js | 331.1 kB · gzip 85.7 kB |
84
+ | dist/dpuse-development.es.js | 331.3 kB · gzip 85.2 kB |
128
85
  | &nbsp;&nbsp;&nbsp;&nbsp;acorn → dist/acorn.mjs | `████████░░░░░░░░░░░░` 39.5% |
129
86
  | &nbsp;&nbsp;&nbsp;&nbsp;acorn-typescript → lib/index.mjs | `███████░░░░░░░░░░░░░` 34.6% |
130
87
  | &nbsp;&nbsp;&nbsp;&nbsp;src | `███░░░░░░░░░░░░░░░░░` 15.7% |
131
- | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentGovernance.ts | `█░░░░░░░░░░░░░░░░░░░` 2.7% |
132
- | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentApiReference.ts | `░░░░░░░░░░░░░░░░░░░░` 2.2% |
88
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentQualitySecurity.ts | `░░░░░░░░░░░░░░░░░░░░` 2.5% |
89
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;index.ts | `░░░░░░░░░░░░░░░░░░░░` 2.4% |
90
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentApiReference.ts | `░░░░░░░░░░░░░░░░░░░░` 2.3% |
133
91
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 1.7% |
134
- | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;manageProject.ts | `░░░░░░░░░░░░░░░░░░░░` 1.7% |
135
- | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;index.ts | `░░░░░░░░░░░░░░░░░░░░` 1.6% |
136
- | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentUsage.ts | `░░░░░░░░░░░░░░░░░░░░` 1.3% |
137
92
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentBundleSizes.ts | `░░░░░░░░░░░░░░░░░░░░` 1.3% |
138
93
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;checkConfigFiles.ts | `░░░░░░░░░░░░░░░░░░░░` 1.1% |
94
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentUsage.ts | `░░░░░░░░░░░░░░░░░░░░` 0.8% |
139
95
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentActions.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
140
96
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentOpening.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
141
97
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cloudflare.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
142
98
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;checkDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
99
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentContributingLicense.ts | `░░░░░░░░░░░░░░░░░░░░` 0.4% |
100
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;releaseProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.3% |
101
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;testProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.3% |
102
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;publishProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.2% |
103
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.2% |
104
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;syncProjectWithGitHub.ts | `░░░░░░░░░░░░░░░░░░░░` 0.2% |
143
105
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;formatCode.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
144
106
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;auditDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
107
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;buildProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
145
108
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lintCode.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
146
- | &nbsp;&nbsp;&nbsp;&nbsp;(bundler output, whitespace & JSON) | `█░░░░░░░░░░░░░░░░░░░` 6.6% |
109
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;checkProject.ts | `░░░░░░░░░░░░░░░░░░░░` 0.0% |
110
+ | &nbsp;&nbsp;&nbsp;&nbsp;(bundler output, whitespace & JSON) | `█░░░░░░░░░░░░░░░░░░░` 6.7% |
147
111
  | &nbsp;&nbsp;&nbsp;&nbsp;@dpuse/dpuse-shared | `█░░░░░░░░░░░░░░░░░░░` 3.4% |
148
112
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;dist/componentConfig.schema-DT3mO5rS.js | `█░░░░░░░░░░░░░░░░░░░` 2.6% |
149
113
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;dist/dpuse-shared-componentModuleConnector.es.js | `░░░░░░░░░░░░░░░░░░░░` 0.7% |
@@ -155,7 +119,7 @@ _Note: Sonda's Vite reports currently exclude CSS files, since Vite does not gen
155
119
 
156
120
  <!-- BUNDLE_END -->
157
121
 
158
- <!-- GOVERNANCE_START -->
122
+ <!-- QUALITY_SECURITY_START -->
159
123
 
160
124
  ## Quality & Security
161
125
 
@@ -173,7 +137,7 @@ This section is updated each time `npm run document` is run. Settings come from
173
137
 
174
138
  |Check or setting|Status|What it does|
175
139
  |:-|:-|:-|
176
- |[Fallow](./code-health-reports/fallow/index.md)|✅ A (87)|Unused code, duplication, complexity and dependency hygiene.|
140
+ |[Fallow](./code-health-reports/fallow/index.md)|✅ A (85)|Unused code, duplication, complexity and dependency hygiene.|
177
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.|
178
142
 
179
143
  ### Security Analysis
@@ -207,6 +171,10 @@ This project is working towards the [OpenSSF Best Practices](https://www.bestpra
207
171
 
208
172
  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.
209
173
 
174
+ <!-- QUALITY_SECURITY_END -->
175
+
176
+ <!-- CONTRIBUTING_LICENSE_START -->
177
+
210
178
  ## Contributing
211
179
 
212
180
  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.
@@ -219,4 +187,4 @@ This project is licensed under the MIT License, permitting free use, modificatio
219
187
 
220
188
  [MIT](./LICENSE) © 2026 Jonathan Terrell
221
189
 
222
- <!-- GOVERNANCE_END -->
190
+ <!-- CONTRIBUTING_LICENSE_END -->