Skip to content
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

Jump to bottom

Core: Sort the results of globby when constructing Story Index #16788

Merged
merged 3 commits into from Nov 26, 2021
Merged

Core: Sort the results of globby when constructing Story Index #16788

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
95b9763
Add a test for more deeply nested things
tmeasday Nov 25, 2021
14c30cf
Sort globbed files for consistent ordering.
tmeasday Nov 25, 2021
044f731
Update snapshot
tmeasday Nov 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
35 changes: 21 additions & 14 deletions lib/core-server/src/utils/StoryIndexGenerator.test.ts
View file
Open in desktop
Expand Up @@ -68,11 +68,11 @@ describe('StoryIndexGenerator', () => {
"name": "Story One",
"title": "Nested/Button",
},
"second-nested-f--story-one": Object {
"id": "second-nested-f--story-one",
"importPath": "./src/second-nested/F.stories.ts",
"second-nested-g--story-one": Object {
"id": "second-nested-g--story-one",
"importPath": "./src/second-nested/G.stories.ts",
"name": "Story One",
"title": "Second Nested/F",
"title": "Second Nested/G",
},
},
"v": 3,
Expand Down Expand Up @@ -112,17 +112,23 @@ describe('StoryIndexGenerator', () => {
"name": "Story One",
"title": "D",
},
"first-nested-deeply-f--story-one": Object {
"id": "first-nested-deeply-f--story-one",
"importPath": "./src/first-nested/deeply/F.stories.js",
"name": "Story One",
"title": "First Nested/Deeply/F",
},
"nested-button--story-one": Object {
"id": "nested-button--story-one",
"importPath": "./src/nested/Button.stories.ts",
"name": "Story One",
"title": "Nested/Button",
},
"second-nested-f--story-one": Object {
"id": "second-nested-f--story-one",
"importPath": "./src/second-nested/F.stories.ts",
"second-nested-g--story-one": Object {
"id": "second-nested-g--story-one",
"importPath": "./src/second-nested/G.stories.ts",
"name": "Story One",
"title": "Second Nested/F",
"title": "Second Nested/G",
},
},
"v": 3,
Expand All @@ -143,15 +149,16 @@ describe('StoryIndexGenerator', () => {
await generator.initialize();

(getStorySortParameter as jest.Mock).mockReturnValueOnce({
order: ['D', 'B', 'Nested', 'A', 'Second Nested'],
order: ['D', 'B', 'Nested', 'A', 'Second Nested', 'First Nested/Deeply'],
});

expect(Object.keys((await generator.getIndex()).stories)).toEqual([
'd--story-one',
'b--story-one',
'nested-button--story-one',
'a--story-one',
'second-nested-f--story-one',
'second-nested-g--story-one',
'first-nested-deeply-f--story-one',
]);
});
});
Expand All @@ -168,7 +175,7 @@ describe('StoryIndexGenerator', () => {
const generator = new StoryIndexGenerator([specifier], options);
await generator.initialize();
await generator.getIndex();
expect(readCsfOrMdxMock).toHaveBeenCalledTimes(6);
expect(readCsfOrMdxMock).toHaveBeenCalledTimes(7);

readCsfOrMdxMock.mockClear();
await generator.getIndex();
Expand Down Expand Up @@ -205,7 +212,7 @@ describe('StoryIndexGenerator', () => {
const generator = new StoryIndexGenerator([specifier], options);
await generator.initialize();
await generator.getIndex();
expect(readCsfOrMdxMock).toHaveBeenCalledTimes(6);
expect(readCsfOrMdxMock).toHaveBeenCalledTimes(7);

generator.invalidate(specifier, './src/B.stories.ts', false);

Expand Down Expand Up @@ -245,7 +252,7 @@ describe('StoryIndexGenerator', () => {
const generator = new StoryIndexGenerator([specifier], options);
await generator.initialize();
await generator.getIndex();
expect(readCsfOrMdxMock).toHaveBeenCalledTimes(6);
expect(readCsfOrMdxMock).toHaveBeenCalledTimes(7);

generator.invalidate(specifier, './src/B.stories.ts', true);

Expand Down Expand Up @@ -284,7 +291,7 @@ describe('StoryIndexGenerator', () => {
const generator = new StoryIndexGenerator([specifier], options);
await generator.initialize();
await generator.getIndex();
expect(readCsfOrMdxMock).toHaveBeenCalledTimes(6);
expect(readCsfOrMdxMock).toHaveBeenCalledTimes(7);

generator.invalidate(specifier, './src/B.stories.ts', true);

Expand Down
2 changes: 1 addition & 1 deletion lib/core-server/src/utils/StoryIndexGenerator.ts
View file
Open in desktop
Expand Up @@ -50,7 +50,7 @@ export class StoryIndexGenerator {
path.join(this.options.workingDir, specifier.directory, specifier.files)
);
const files = await glob(fullGlob);
files.forEach((absolutePath: Path) => {
files.sort().forEach((absolutePath: Path) => {
const ext = path.extname(absolutePath);
const relativePath = path.relative(this.options.workingDir, absolutePath);
if (!['.js', '.jsx', '.ts', '.tsx', '.mdx'].includes(ext)) {
Expand Down
0 ...mockdata__/src/second-nested/F.stories.ts → ...ta__/src/first-nested/deeply/F.stories.js
View file
Open in desktop
File renamed without changes.
6 changes: 6 additions & 0 deletions lib/core-server/src/utils/__mockdata__/src/second-nested/G.stories.ts
View file
Open in desktop
@@ -0,0 +1,6 @@
const component = {};
export default {
component,
};

export const StoryOne = {};
27 changes: 20 additions & 7 deletions lib/core-server/src/utils/stories-json.test.ts
View file
Open in desktop
Expand Up @@ -98,6 +98,19 @@ describe('useStoriesJson', () => {
"story": "Story One",
"title": "D",
},
"first-nested-deeply-f--story-one": Object {
"id": "first-nested-deeply-f--story-one",
"importPath": "./src/first-nested/deeply/F.stories.js",
"kind": "First Nested/Deeply/F",
"name": "Story One",
"parameters": Object {
"__id": "first-nested-deeply-f--story-one",
"docsOnly": false,
"fileName": "./src/first-nested/deeply/F.stories.js",
},
"story": "Story One",
"title": "First Nested/Deeply/F",
},
"nested-button--story-one": Object {
"id": "nested-button--story-one",
"importPath": "./src/nested/Button.stories.ts",
Expand All @@ -111,18 +124,18 @@ describe('useStoriesJson', () => {
"story": "Story One",
"title": "Nested/Button",
},
"second-nested-f--story-one": Object {
"id": "second-nested-f--story-one",
"importPath": "./src/second-nested/F.stories.ts",
"kind": "Second Nested/F",
"second-nested-g--story-one": Object {
"id": "second-nested-g--story-one",
"importPath": "./src/second-nested/G.stories.ts",
"kind": "Second Nested/G",
"name": "Story One",
"parameters": Object {
"__id": "second-nested-f--story-one",
"__id": "second-nested-g--story-one",
"docsOnly": false,
"fileName": "./src/second-nested/F.stories.ts",
"fileName": "./src/second-nested/G.stories.ts",
},
"story": "Story One",
"title": "Second Nested/F",
"title": "Second Nested/G",
},
},
"v": 3,
Expand Down