chore: drop inert packaging config and clear the dev dependency audit - #292
Open
imdt-claudiop wants to merge 2 commits into
Open
imdt-claudiop wants to merge 2 commits into
imdt-claudiop wants to merge 2 commits into
Conversation
Plain `npm audit fix` no longer reaches 0 vulnerabilities because advisory GHSA-82fw-gwwq-j7x9 (@vitest/mocker, moderate, dev-only) is only fixable across a semver-major boundary, so vitest and @vitest/coverage-v8 were upgraded from ^3.2.6 to ^4.1.11 (`npm audit fix --force` proposed @vitest/coverage-v8@5.0.0, which has a peer conflict with vitest 4, so both packages were aligned at 4.1.11); all 32 unit tests plus tsc, lint, build and validate-samples pass on vitest 4. The 23 samples are out of scope for this change and remain unaudited: each still reports 34 or 35 vulnerabilities, `npm audit fix` is a no-op there, and clearing them would require `--force` with major upgrades to copy-webpack-plugin and webpack-dev-server.
|
This pull request has conflicts ☹ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Two small, independent housekeeping commits on top of
v1.x.1.
chore: drop the unbuilt esm entry point and unused dev toolingRemoves packaging and tooling entries that no longer correspond to anything the repository actually does:
"module": "dist/esm/index.js"inpackage.json. Thebuildscript isrm -rf dist/cjs && tsc --module CommonJS --outDir dist/cjs, sodist/esmis never produced. Bundlers that honour themodulefield were being pointed at a path that does not exist in the published tarball..npmignore.package.jsonalready declares"files": ["dist"], which takes precedence and governs the published contents, so the file was inert.eslint-watchandlint-stageddev dependencies. Neither is referenced by any script or config in the repository (there is no husky or lint-staged configuration)."allowJs": trueintsconfig.json. The sources are TypeScript only.pathsmapping (bigbluebutton-html-plugin-sdk/*->dist/cjs/*) intsconfig.json. No source file imports the package by its own name, so the mapping resolved nothing;npx tscpasses identically without it.lint:watchinvokedyarn lintwhile the project is npm based. It now callsnpm run lint.keywordsarray carried boilerplate from another package (useAxios,apollo,fetch,mutation,query). Replaced with keywords that describe this package.No source file and no build output changes:
npm run buildproduces the samedist/cjsbefore and after.2.
chore(deps): npm audit fixBrings the SDK audit to 0 vulnerabilities. A plain
npm audit fixcould not get there: advisory GHSA-82fw-gwwq-j7x9 (@vitest/mocker, moderate, dev only) is fixable only across a semver major boundary.vitestand@vitest/coverage-v8therefore move from^3.2.6to^4.1.11. Note thatnpm audit fix --forceproposed@vitest/coverage-v8@5.0.0, which has a peer conflict with vitest 4, so both packages were aligned at 4.1.11 instead.Closes Issue(s)
None. This is not tracked by an issue.
Motivation
The packaging metadata advertised an ESM build that the repository does not produce, and carried dev dependencies and config flags that nothing uses. Separately, the dev dependency audit was not clean, and the remaining advisory needed a deliberate major upgrade rather than an automated fix.
More
Validation run locally on this branch, mirroring the four
pull_requestjobs, with Node.js 20.20.2:npm cinpx tscnpm run lintnpm run builddist/cjsnpm run test:unit:coveragenpm audit./scripts/validate-samples-code.shThe 32 unit tests pass identically on vitest 3 before the upgrade and on vitest 4 after it, so the major bump is not changing test behaviour.
Scope and known limitations:
The 23 sample projects under
samples/are not modified by this PR. They still report 34 or 35 vulnerabilities each,npm audit fixis a no-op there, and clearing them would require--forcewith major upgrades tocopy-webpack-pluginandwebpack-dev-server. That remains an open limitation, not something this PR addresses.This PR targets
v1.xonly. The equivalent cleanup onv0.0.xis outside its scope.Added/updated documentation
No documentation change applies: the removed keys (
module,.npmignore,lint:watch,allowJs) are not referenced inREADME.mdor anywhere else in the repository's Markdown.