Skip to content

Improve devDependencies slicing #236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
meduzen merged 3 commits into from
Feb 25, 2026
Merged

Improve devDependencies slicing #236

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4e4a635
Prevent deployment helper script to run the next CI step
meduzen Feb 25, 2026
86b924d
Refactor deployment helper script and warn if no dependencies sliced
meduzen Feb 25, 2026
e811c46
Revert change in `prepare-deploy` npm script
meduzen Feb 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 38 additions & 24 deletions scripts/prepare-deploy.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@
*/

import { execSync } from 'node:child_process'
import console from 'node:console'

console.time('Cleaning of devDependencies list')
import console, { warn } from 'node:console'

/** The list of `devDependencies` not needed to build the app. */
const USELESS_DEPS = [
Expand All @@ -30,37 +28,53 @@ const USELESS_DEPS = [
'typescript',
]

const depsArgs = USELESS_DEPS
/**
* Exclude invalid names, which reduces the risk of failure since we try
* to remove all deps in one command: they’ll all be deleted or fail.
*/
.filter(hasValidName)
const benchmarkLabel = 'Cleaning of devDependencies list'

// Wrap dep names with single quotes, which is needed for `@scope/name` deps.
.map(dep => `'${dep}'`)
console.time(benchmarkLabel)

// Create a space-separated list of `devDepencies.'(@scope/)name'`.
.join(` devDependencies.`)
sliceDevDependencies(USELESS_DEPS)

try {
execSync(`npm pkg delete devDependencies.${depsArgs}`, {
stdio: 'inherit',
timeout: 5000,
})
} catch (error) {
console.warn(`Slicing of devDepencencies failed: ${error.message}`);
}
console.timeEnd(benchmarkLabel);

console.timeEnd('Cleaning of devDependencies list');
/**
* Remove `devDependencies` from `package.json`.
*
* @param {string[]} devDeps A list of devDependencies names.
*/
function sliceDevDependencies(devDeps) {
const depsArgs = devDeps
/**
* Exclude invalid names, which reduces the risk of failure since we try
* to remove all deps in one command: they’ll all be deleted or fail.
*/
.filter(hasValidName)

/** Utils */
// Wrap dep names with single quotes, which is needed for `@scope/name` deps.
.map(dep => `'${dep}'`)

// Create a space-separated list of `devDepencies.'(@scope/)name'`.
.join(` devDependencies.`)

if (depsArgs.length) {
try {
execSync(`npm pkg delete devDependencies.${depsArgs}`, {
stdio: 'inherit',
timeout: 5000,
})
} catch (error) {
warn(`Slicing of devDepencencies failed: ${error.message}`);
}
} else {
warn('No devDepencencies to slice.');
}
}

/** @param {string} name The name of the dependency. */
function hasValidName (name) {
const isValid = /^[a-zA-Z0-9@/_.-]+$/.test(name)

if (!isValid) {
console.warn(`Invalid dependency name: ${name} will stay.`)
warn(`Invalid dependency name: ${name} will stay.`)
}

return isValid
Expand Down
Loading