Skip to content

feat: allow sort scripts without run-s #277

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.

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
merged 10 commits into from
Apr 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 17 additions & 4 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,22 @@ const hasDevDependency = (dependency, packageJson) => {
)
}

const runSRegExp =
/(?<=^|[\s&;<>|(])(?:run-s|npm-run-all .*(?:--sequential|--serial|-s))(?=$|[\s&;<>|)])/

const isSequentialScript = (command) =>
command.includes('*') && runSRegExp.test(command)

const hasSequentialScript = (packageJson) => {
if (!hasDevDependency('npm-run-all', packageJson)) {
return false
}
const scripts = ['scripts', 'betterScripts'].flatMap((field) =>
packageJson[field] ? Object.values(packageJson[field]) : [],
)
return scripts.some((script) => isSequentialScript(script))
}

const sortScripts = onObject((scripts, packageJson) => {
const names = Object.keys(scripts)
const prefixable = new Set()
Expand All @@ -231,10 +247,7 @@ const sortScripts = onObject((scripts, packageJson) => {
return name
})

if (
!hasDevDependency('npm-run-all', packageJson) &&
!hasDevDependency('npm-run-all2', packageJson)
) {
if (!hasSequentialScript(packageJson)) {
keys.sort()
}

Expand Down
95 changes: 68 additions & 27 deletions tests/scripts.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import test from 'ava'
import sortPackageJson from '../index.js'
import { macro } from './_helpers.js'

const fixture = {
Expand Down Expand Up @@ -35,37 +36,77 @@ const expectAllSorted = {
watch: 'watch things',
}

const expectPreAndPostSorted = {
pretest: 'xyz',
test: 'node test.js',
posttest: 'abc',
multiply: '2 * 3',
prewatch: 'echo "about to watch"',
watch: 'watch things',
preinstall: 'echo "Installing"',
postinstall: 'echo "Installed"',
start: 'node server.js',
preprettier: 'echo "not pretty"',
prettier: 'prettier -l "**/*.js"',
postprettier: 'echo "so pretty"',
prepare: 'npm run build',
'pre-fetch-info': 'foo',
}

for (const field of ['scripts', 'betterScripts']) {
test(`${field} when npm-run-all is not a dev dependency`, macro.sortObject, {
test(`${field} when npm-run-all is NOT a dev dependency`, macro.sortObject, {
value: { [field]: fixture },
expect: { [field]: expectAllSorted },
})
test(`${field} when npm-run-all is a dev dependency`, macro.sortObject, {
value: {
[field]: fixture,
devDependencies: { 'npm-run-all': '^1.0.0' },
},
expect: {
[field]: expectPreAndPostSorted,
devDependencies: { 'npm-run-all': '^1.0.0' },

test(
`${field} when npm-run-all IS a dev dependency, but is NOT used in scripts`,
macro.sortObject,
{
value: {
[field]: { z: 'z', a: 'a' },
devDependencies: { 'npm-run-all': '^1.0.0' },
},
expect: {
[field]: { a: 'a', z: 'z' },
devDependencies: { 'npm-run-all': '^1.0.0' },
},
},
)
}

// `run-s` command
function sortScriptsWithNpmRunAll(script) {
const packageJson = {
scripts: { z: 'z', a: 'a', maybeRunS: script },
devDependencies: { 'npm-run-all': '^1.0.0' },
}

return Object.keys(sortPackageJson(packageJson).scripts)
}
const sortedScripts = ['a', 'maybeRunS', 'z']
const unsortedScripts = ['z', 'a', 'maybeRunS']
for (const { script, expected } of [
// Should NOT sort
{ script: 'run-s "lint:*"', expected: unsortedScripts },
{ script: 'npm-run-all -s "lint:*"', expected: unsortedScripts },
{ script: 'npm-run-all --sequential "lint:*"', expected: unsortedScripts },
{ script: 'npm-run-all --serial "lint:*"', expected: unsortedScripts },
{ script: 'npm-run-all "lint:*" --sequential', expected: unsortedScripts },
{ script: 'foo&&npm-run-all --serial "lint:*"', expected: unsortedScripts },
{ script: 'foo||npm-run-all --serial "lint:*"', expected: unsortedScripts },
{ script: 'foo|npm-run-all --serial "lint:*"', expected: unsortedScripts },
{ script: 'foo>npm-run-all --serial "lint:*"', expected: unsortedScripts },
{ script: 'foo<npm-run-all --serial "lint:*"', expected: unsortedScripts },
{
script: 'cross-env FOO=1 npm-run-all --serial "lint:*"',
expected: unsortedScripts,
},
{ script: 'npm-run-all "lint:*" --serial&&foo', expected: unsortedScripts },
{ script: 'npm-run-all "lint:*" --serial|foo', expected: unsortedScripts },
{ script: 'npm-run-all "lint:*" --serial||foo', expected: unsortedScripts },
{ script: 'npm-run-all "lint:*" --serial>foo', expected: unsortedScripts },
{ script: 'npm-run-all "lint:*" --serial<foo', expected: unsortedScripts },
{ script: 'npm-run-all --serial "lint:*"&&foo', expected: unsortedScripts },
{ script: 'npm-run-all "lint:*" --serial;foo', expected: unsortedScripts },
{ script: '(npm-run-all "lint:*" --serial)|foo', expected: unsortedScripts },

// Should sort
{ script: 'run-s lint:a lint:b', expected: sortedScripts },
{ script: 'not-run-s *', expected: sortedScripts },
{ script: 'npm-run-all * --serial!', expected: sortedScripts },
{ script: 'looks like && run-s-but-its-not *', expected: sortedScripts },
{ script: 'npm-run-all *', expected: sortedScripts },
{ script: 'npm-run-all --parallel watch:*', expected: sortedScripts },

// False positive
{ script: 'rm -rf dist/* && run-s lint:a lint:b', expected: unsortedScripts },
]) {
test(`command: '${script}'`, (t) => {
t.deepEqual(sortScriptsWithNpmRunAll(script), expected)
})
}

Expand All @@ -80,7 +121,7 @@ for (const field of ['scripts', 'betterScripts']) {
devDependencies: { 'npm-run-all2': '^1.0.0' },
},
expect: {
[field]: expectPreAndPostSorted,
[field]: expectAllSorted,
devDependencies: { 'npm-run-all2': '^1.0.0' },
},
})
Expand Down