templates/spec-skeleton.md
templates/spec-skeleton.mdBrowse 8 files
723 tokens
3,058 bytes
Token encoding: o200k_base
Snapshot 646e806
← Back to SKILL.md
Migration spec skeleton
Colocated as <name>.spec.ts. Arrange with tree writes, act by calling the imported default export, assert with explicit reads. Inside packages/nx, import the tree util relatively (../../generators/testing-utils/create-tree-with-empty-workspace) instead of @nx/devkit/testing.
import { addProjectConfiguration, readJson, type Tree } from '@nx/devkit';
import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing';
import update from './remove-foo-option';
describe('remove-foo-option migration', () => {
let tree: Tree;
beforeEach(() => {
tree = createTreeWithEmptyWorkspace();
// arrange the trigger shape every test acts on
addProjectConfiguration(tree, 'app1', {
root: 'apps/app1',
targets: {
build: { executor: '@nx/foo:build', options: { foo: true } },
},
});
});
it('should remove the foo option from build targets', async () => {
await update(tree);
const project = readJson(tree, 'apps/app1/project.json');
expect(project.targets.build.options.foo).toBeUndefined();
});
it('should not change projects that do not use the executor', async () => {
addProjectConfiguration(tree, 'other', {
root: 'apps/other',
targets: {
build: { executor: '@acme/other:build', options: { foo: true } },
},
});
const originalContent = tree.read('apps/other/project.json', 'utf-8');
await update(tree);
expect(tree.read('apps/other/project.json', 'utf-8')).toEqual(
originalContent
);
});
it('should be a no-op when run twice', async () => {
await update(tree);
const afterFirstRun = tree.read('apps/app1/project.json', 'utf-8');
// guards the vacuous pass: a missing path reads as null on both sides
expect(afterFirstRun).not.toBeNull();
await update(tree);
expect(tree.read('apps/app1/project.json', 'utf-8')).toEqual(afterFirstRun);
});
});
Rules:
- Explicit assertions or
toMatchInlineSnapshot. NevertoMatchSnapshot(external snapshot files); no migration spec in the repo uses it. - The mandatory case list (negative, idempotency, malformed-input, multi-edit, precedence, list-sanity, reproduced-behavior, each with its trigger) lives in SKILL.md section 5; the skeleton above shows the negative and idempotency shapes.
- Prompt-only migrations get no spec file; there is no implementation to import.
- Any migration returning
{ nextSteps, agentContext }(hybrid or not): assert on the return value.
const result = await update(tree);
expect(result.nextSteps).toContainEqual(expect.stringContaining('...'));
expect(result.agentContext).toContainEqual(expect.stringContaining('...'));
- A migration returning
skipAgenticasserts both directions, since the waiving path is the one that changes whatnx migratedoes.
// the path that leaves nothing for the AI step
expect((await update(tree)).skipAgentic).toBe(true);
// a path that still needs it
expect((await update(treeWithUnhandledShape))?.skipAgentic).toBeFalsy();