Skip to content

setup(package.json): reduce amout of code to maintain #513

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

Open
AugustinMauroy wants to merge 3 commits into
base: main
Choose a base branch
from
Open

setup(package.json): reduce amout of code to maintain #513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
303374a
setup(package.json): reduce amout of code to maintain
AugustinMauroy Jul 19, 2026
1843f80
Merge branch 'main' into reduce-maintaince
AugustinMauroy Aug 7, 2026
f6f198e
fix
AugustinMauroy Aug 7, 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
2 changes: 1 addition & 1 deletion .github/scripts/pr-prefixes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ export const SUPPORTED_PREFIXES = [
'test',
] as const;

export const SCOPE_RGX = new RegExp(`^(${SUPPORTED_PREFIXES.join('|')})\\([\\w\\-\\d]*\\)\\: `);
export const SCOPE_RGX = new RegExp(`^(${SUPPORTED_PREFIXES.join('|')})\\(\\S[^)]*\\): [^\\n]*$`);
290 changes: 234 additions & 56 deletions .github/scripts/pr-title.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,69 +11,247 @@ describe('Pull Request checks', { concurrency: true }, async () => {
const encoding = 'utf8';
const prTestPath = fileURLToPath(import.meta.resolve('./pr-title.ts'));

for (const prefix of SUPPORTED_PREFIXES) {
describe(prefix, () => {
it('should pass when valid', async () => {
const { code, stderr } = await spawnPromisified(
execPath,
[prTestPath],
{
encoding,
env: { PR_TITLE: `${prefix}(DEP0000): update …` },
},
);

equal(stderr, '');
equal(code, 0);
});
const runCheck = async (title: string) =>
spawnPromisified(execPath, [prTestPath], {
encoding,
env: { PR_TITLE: title },
});

it('should fail when missing scope', async () => {
const { code, stderr } = await spawnPromisified(
execPath,
[prTestPath],
{
encoding,
env: { PR_TITLE: `${prefix}: update …` },
},
);

match(stderr, /AssertionError/);
match(stderr, new RegExp(prefix));
match(stderr, /pull request title/i);
equal(code, 1);
});
const assertPass = async (title: string) => {
const { code, stderr } = await runCheck(title);

it('should fail scope is misformatted', async () => {
const { code, stderr } = await spawnPromisified(
execPath,
[prTestPath],
{
encoding,
env: { PR_TITLE: `${prefix}(DEP0000) update …` },
},
);

match(stderr, /AssertionError/);
match(stderr, new RegExp(prefix));
match(stderr, /pull request title/i);
equal(code, 1);
equal(stderr, '');
equal(code, 0);
};

const assertFail = async (title: string) => {
const { code, stderr } = await runCheck(title);

match(stderr, /AssertionError/);
match(stderr, /pull request title/i);
equal(code, 1);
};

describe('supported prefixes', () => {
for (const prefix of SUPPORTED_PREFIXES) {
describe(prefix, () => {
it('passes with valid scope', async () => {
await assertPass(
`${prefix}(DEP0000): update dependency`,
);
});

it('passes with normal scope', async () => {
await assertPass(
`${prefix}(api): update endpoint`,
);
});

it('passes with numeric scope', async () => {
await assertPass(
`${prefix}(v2): update API`,
);
});

it('fails without scope', async () => {
await assertFail(
`${prefix}: update dependency`,
);
});

it('fails without colon', async () => {
await assertFail(
`${prefix}(api) update dependency`,
);
});

it('fails without space after colon', async () => {
await assertFail(
`${prefix}(api):update dependency`,
);
});

it('fails with empty scope', async () => {
await assertFail(
`${prefix}(): update dependency`,
);
});
});
}
});

describe('scope formats', () => {
it('allows package.json scopes', async () => {
await assertPass(
'setup(package.json): reduce amount of code to maintain',
);
});
}

describe('unsupported prefix', () => {
it('should fail', async () => {
const prefix = 'foo';
const { code, stderr } = await spawnPromisified(execPath, [prTestPath], {
encoding,
env: { PR_TITLE: `${prefix}(DEP0000): update …` },
});
it('allows dotted scopes', async () => {
await assertPass(
'fix(node.test.ts): update tests',
);
});

it('allows kebab-case scopes', async () => {
await assertPass(
'feat(my-feature): add feature',
);
});

it('allows snake_case scopes', async () => {
await assertPass(
'fix(my_module): update module',
);
});

it('allows backticks in scopes', async () => {
await assertPass(
'feat(`foo`): introduced',
);
});

it('allows npm package scopes', async () => {
await assertPass(
'dep(@scope/pkg): update package',
);
});

it('allows slash-separated scopes', async () => {
await assertPass(
'fix(api/users): fix endpoint',
);
});

it('allows long scopes', async () => {
await assertPass(
'feat(very-long-package-name-that-is-used-by-the-app): cleanup',
);
});
});

describe('invalid scope formats', () => {
it('fails with missing opening parenthesis', async () => {
await assertFail(
'featapi): add feature',
);
});

it('fails with missing closing parenthesis', async () => {
await assertFail(
'feat(api: add feature',
);
});

it('fails with extra closing parenthesis', async () => {
await assertFail(
'feat(api)): add feature',
);
});

it('fails with whitespace-only scope', async () => {
await assertFail(
'feat( ): add feature',
);
});

it('fails with newline in title', async () => {
await assertFail(
'feat(api): add feature\nsecond line',
);
});
});

describe('description formats', () => {
it('allows empty description', async () => {
await assertPass(
'feat(api): ',
);
});

it('allows punctuation', async () => {
await assertPass(
'feat(api): update API, remove old behavior.',
);
});

it('allows unicode', async () => {
await assertPass(
'feat(api): improve documentation 🚀',
);
});

it('allows numbers', async () => {
await assertPass(
'fix(api): fix issue #1234',
);
});
});

describe('prefix validation', () => {
it('fails for unsupported prefix', async () => {
const { code, stderr } = await runCheck(
'foo(api): update dependency',
);

match(stderr, /AssertionError/);
match(stderr, new RegExp(prefix));
match(stderr, /pull request title/i);
for (const p of SUPPORTED_PREFIXES) match(stderr, new RegExp(p));
match(stderr, /foo/);

for (const prefix of SUPPORTED_PREFIXES) {
match(stderr, new RegExp(prefix));
}

equal(code, 1);
});
})

it('fails with uppercase prefix', async () => {
await assertFail(
'Feat(api): update feature',
);
});

it('fails with leading whitespace', async () => {
await assertFail(
' feat(api): update feature',
);
});

it('fails with whitespace before scope', async () => {
await assertFail(
'feat (api): update feature',
);
});
});

describe('real world examples', () => {
it('accepts setup(package.json)', async () => {
await assertPass(
'setup(package.json): reduce amount of code to maintain',
);
});

it('accepts feat(`foo`)', async () => {
await assertPass(
'feat(`foo`): introduced',
);
});

it('accepts dependency updates', async () => {
await assertPass(
'dep(typescript): update to latest version',
);
});

it('accepts documentation updates', async () => {
await assertPass(
'doc(readme): improve examples',
);
});

it('accepts test updates', async () => {
await assertPass(
'test(pr-title): improve coverage',
);
});
});
});
15 changes: 14 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ Each codemod resides in its own directory under `recipes/` and should include:
| `codemod.yml` | Codemod manifest file |
| `workflow.yml` | Workflow definition file |
| `tests/` | Test suite using `jssg` testing utilities |
| `tsconfig.json` | TypeScript configuration |

> [!NOTE]
> The `workflow.ts` naming is conventional but can be changed as needed. Ensure to update the `workflow.yml` accordingly. We use `workflow` when there are one step codemods; for multi-step codemods, consider using `what-to-change.ts` or similar descriptive names.
Expand Down Expand Up @@ -149,6 +148,20 @@ registry:
visibility: public
```

**`package.json` example:**
```json
{
"name": "@nodejs/<codemod-name>",
"type": "module",
"scripts": {
"test": "npx codemod jssg test -l typescript ./src/workflow.ts"
},
"devDependencies": {
"@nodejs/codemod-utils": "^*"
}
}
```

## Useful Resources

- [Codemod CLI Reference](https://docs.codemod.com/cli/cli-reference)
Expand Down
Loading