Skip to content

CLI: Add addon-console automigration #32083

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
ndelangen merged 13 commits into from
Sep 15, 2025
Merged

CLI: Add addon-console automigration #32083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
416e7c3
feat(cli): Add addon-console automigration
Sidnioulz Jul 19, 2025
d9f1955
Core: Filter out unnamed spies from actions panel
Sidnioulz Jul 29, 2025
c0a5a7b
Docs: Update actions documentation with spy examples
Sidnioulz Aug 4, 2025
5d56085
Update docs/essentials/actions.mdx
Sidnioulz Aug 18, 2025
24f3db8
Update docs/essentials/actions.mdx
Sidnioulz Aug 18, 2025
34efeab
Update docs/essentials/actions.mdx
Sidnioulz Aug 18, 2025
951debc
docs: Fix actions links and handle PR comments
Sidnioulz Aug 20, 2025
a412784
docs: Type preview exports in snippets
Sidnioulz Aug 31, 2025
4868b59
CLI: Fix import path in console automigration
Sidnioulz Sep 4, 2025
4817d9b
CLI: Rework addon-console automigration tests
Sidnioulz Sep 4, 2025
54eb145
refactor: Remove stale TODOs
Sidnioulz Sep 15, 2025
bfdec60
Merge branch 'next' into sidnioulz/addon-console-automigration
Sidnioulz Sep 15, 2025
8077930
Merge branch 'next' into sidnioulz/addon-console-automigration
Sidnioulz Sep 15, 2025
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
7 changes: 7 additions & 0 deletions code/core/src/actions/loaders.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,17 @@ const logActionsWhenMockCalled: LoaderFunction = (context) => {
onMockCall((mock, args) => {
const name = mock.getMockName();

// Default name provided by vi.fn(), which we don't want to log.
if (name === 'spy') {
return;
}

// Escape hatch allowing users to disable logging for specific spies.
// This is what Vitest sets when you pass `mockName('')` to a spy.
if (name === 'vi.fn()') {
return;
}

// TODO: Make this a configurable API in 8.2
if (
!/^next\/.*::/.test(name) ||
Expand Down
309 changes: 309 additions & 0 deletions code/core/src/csf-tools/ConfigFile.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1462,6 +1462,315 @@ describe('ConfigFile', () => {
});
});

describe('removeImport', () => {
it(`removes a default require import`, () => {
const source = dedent`
const path = require('path');
const config: StorybookConfig = { };
export default config;
`;

const config = loadConfig(source).parse();
config.removeImport('path', 'path');

const parsed = babelPrint(config._ast);

expect(parsed).toMatchInlineSnapshot(`
const config: StorybookConfig = { };
export default config;
`);
});

it(`removes a default ES6 import`, () => {
const source = dedent`
import path from 'path';
const config: StorybookConfig = { };
export default config;
`;

const config = loadConfig(source).parse();
config.removeImport('path', 'path');

const parsed = babelPrint(config._ast);

expect(parsed).toMatchInlineSnapshot(`
const config: StorybookConfig = { };
export default config;
`);
});

it(`removes a named require import`, () => {
const source = dedent`
const { dirname, basename } = require('path');
const config: StorybookConfig = { };
export default config;
`;

const config = loadConfig(source).parse();
config.removeImport(['dirname'], 'path');

const parsed = babelPrint(config._ast);

expect(parsed).toMatchInlineSnapshot(`
const {
basename,
} = require('path');
const config: StorybookConfig = { };
export default config;
`);
});

it(`removes a named ES6 import`, () => {
const source = dedent`
import { dirname, basename } from 'path';
const config: StorybookConfig = { };
export default config;
`;

const config = loadConfig(source).parse();
config.removeImport(['dirname'], 'path');

const parsed = babelPrint(config._ast);

expect(parsed).toMatchInlineSnapshot(`
import { basename } from 'path';
const config: StorybookConfig = { };
export default config;
`);
});

it(`removes multiple named require imports`, () => {
const source = dedent`
const { dirname, basename, join } = require('path');
const config: StorybookConfig = { };
export default config;
`;

const config = loadConfig(source).parse();
config.removeImport(['dirname', 'basename'], 'path');

const parsed = babelPrint(config._ast);

expect(parsed).toMatchInlineSnapshot(`
const {
join,
} = require('path');
const config: StorybookConfig = { };
export default config;
`);
});

it(`removes multiple named ES6 imports`, () => {
const source = dedent`
import { dirname, basename, join } from 'path';
const config: StorybookConfig = { };
export default config;
`;

const config = loadConfig(source).parse();
config.removeImport(['dirname', 'basename'], 'path');

const parsed = babelPrint(config._ast);

expect(parsed).toMatchInlineSnapshot(`
import { join } from 'path';
const config: StorybookConfig = { };
export default config;
`);
});

it(`removes a namespace ES6 import`, () => {
const source = dedent`
import * as path from 'path';
const config: StorybookConfig = { };
export default config;
`;
const config = loadConfig(source).parse();
config.removeImport({ namespace: 'path' }, 'path');

const parsed = babelPrint(config._ast);

expect(parsed).toMatchInlineSnapshot(`
const config: StorybookConfig = { };
export default config;
`);
});

it(`preserves default import when removing a namespace ES6 import`, () => {
const source = dedent`
import path, * as alsoPath from 'path';
const config: StorybookConfig = { };
export default config;
`;
const config = loadConfig(source).parse();
config.removeImport({ namespace: 'alsoPath' }, 'path');

const parsed = babelPrint(config._ast);

expect(parsed).toMatchInlineSnapshot(`
import path from 'path';
const config: StorybookConfig = { };
export default config;
`);
});

it(`removes entire require declaration when all named imports are removed`, () => {
const source = dedent`
const { dirname, basename } = require('path');
const config: StorybookConfig = { };
export default config;
`;

const config = loadConfig(source).parse();
config.removeImport(['dirname', 'basename'], 'path');

const parsed = babelPrint(config._ast);

expect(parsed).toMatchInlineSnapshot(`
const config: StorybookConfig = { };
export default config;
`);
});

it(`removes entire ES6 declaration when all named imports are removed`, () => {
const source = dedent`
import { dirname, basename } from 'path';
const config: StorybookConfig = { };
export default config;
`;

const config = loadConfig(source).parse();
config.removeImport(['dirname', 'basename'], 'path');

const parsed = babelPrint(config._ast);

expect(parsed).toMatchInlineSnapshot(`
const config: StorybookConfig = { };
export default config;
`);
});

it(`handles node: prefix in require imports`, () => {
const source = dedent`
const { dirname } = require('path');
const config: StorybookConfig = { };
export default config;
`;

const config = loadConfig(source).parse();
config.removeImport(['dirname'], 'node:path');

const parsed = babelPrint(config._ast);

expect(parsed).toMatchInlineSnapshot(`
const config: StorybookConfig = { };
export default config;
`);
});

it(`handles node: prefix in ES6 imports`, () => {
const source = dedent`
import { dirname } from 'path';
const config: StorybookConfig = { };
export default config;
`;

const config = loadConfig(source).parse();
config.removeImport(['dirname'], 'node:path');

const parsed = babelPrint(config._ast);

expect(parsed).toMatchInlineSnapshot(`
const config: StorybookConfig = { };
export default config;
`);
});

it(`does nothing when require import does not exist`, () => {
const source = dedent`
const config: StorybookConfig = { };
export default config;
`;

const config = loadConfig(source).parse();
config.removeImport('path', 'path');

const parsed = babelPrint(config._ast);

expect(parsed).toMatchInlineSnapshot(source);
});

it(`does nothing when trying to remove non-existent named require import`, () => {
const source = dedent`
const { dirname } = require('path');
const config: StorybookConfig = { };
export default config;
`;

const config = loadConfig(source).parse();
config.removeImport(['nonexistent'], 'path');

const parsed = babelPrint(config._ast);

expect(parsed).toMatchInlineSnapshot(source);
});

it(`does nothing when trying to remove non-existent named ES6 import`, () => {
const source = dedent`
import { dirname } from 'path';
const config: StorybookConfig = { };
export default config;
`;

const config = loadConfig(source).parse();
config.removeImport(['nonexistent'], 'path');

const parsed = babelPrint(config._ast);

expect(parsed).toMatchInlineSnapshot(source);
});

it(`removes ES6 import while preserving require import`, () => {
const source = dedent`
import { readFile } from 'fs';
const { dirname } = require('path');
const config: StorybookConfig = { };
export default config;
`;

const config = loadConfig(source).parse();
config.removeImport(['readFile'], 'fs');

const parsed = babelPrint(config._ast);

expect(parsed).toMatchInlineSnapshot(`
const { dirname } = require('path');
const config: StorybookConfig = { };
export default config;
`);
});

it(`removes require import while preserving ES6 import`, () => {
const source = dedent`
import { readFile } from 'fs';
const { dirname } = require('path');
const config: StorybookConfig = { };
export default config;
`;

const config = loadConfig(source).parse();
config.removeImport(['dirname'], 'path');

const parsed = babelPrint(config._ast);

expect(parsed).toMatchInlineSnapshot(`
import { readFile } from 'fs';
const config: StorybookConfig = { };
export default config;
`);
});
});

describe('removeEntryFromArray', () => {
it('removes a string literal entry', () => {
const source = dedent`
Expand Down
Loading