chore(migrate-converged): add functionality to execute various v9 package file restructuring tasks

scripts/tasks/eslint.ts

@@ -1,10 +1,18 @@
 import { eslintTask } from 'just-scripts';
 import * as path from 'path';
 import * as constants from './eslint-constants';
+import * as fs from 'fs';
+
+const files = [path.join(process.cwd(), constants.directory)];
+const storiesPath = path.join(process.cwd(), 'stories');
+
+if (fs.existsSync(storiesPath)) {
+ files.push(storiesPath);
+}
 
 export const eslint = eslintTask({
  // TODO: also lint config files?
- files: [path.join(process.cwd(), constants.directory)],
+ files: files,
  extensions: constants.extensions,
  cache: true, // only lint files changed since last lint
  fix: process.argv.includes('--fix'),

tools/generators/migrate-converged-pkg/index.spec.ts

@@ -560,7 +560,7 @@ describe('migrate-converged-pkg generator', () => {
  outDir: '',
  types: ['static-assets', 'environment', 'storybook__addons'],
  },
- include: ['../src/**/*.stories.ts', '../src/**/*.stories.tsx', '*.js'],
+ include: ['../stories/**/*.stories.ts', '../stories/**/*.stories.tsx', '*.js'],
  });
  expect(readJson<TsConfig>(tree, paths.tsconfig.lib).exclude).toEqual(
  expect.arrayContaining(['**/*.stories.ts', '**/*.stories.tsx']),
@@ -578,7 +578,7 @@ describe('migrate-converged-pkg generator', () => {
 
  module.exports = /** @type {Omit<import('../../../../.storybook/main'), 'typescript'|'babel'>} */ ({
  ...rootMain,
- stories: [...rootMain.stories, '../src/**/*.stories.mdx', '../src/**/index.stories.@(ts|tsx)'],
+ stories: [...rootMain.stories, '../stories/**/*.stories.mdx', '../stories/**/index.stories.@(ts|tsx)'],
  addons: [...rootMain.addons],
  webpackFinal: (config, options) => {
  const localConfig = { ...rootMain.webpackFinal(config, options) };
@@ -674,11 +674,10 @@ describe('migrate-converged-pkg generator', () => {
  expect(tree.read(paths.storyOne)?.toString('utf-8')).toMatchSnapshot();
  });
 
- it(`should move existing stories to the src/stories/ComponentName folder`, async () => {
- const { projectConfig, normalizedProjectName } = setup({ createDummyStories: true });
- const componentName = names(normalizedProjectName).className.replace('React', '');
+ it(`should move existing stories to the root stories subfolder`, async () => {
+ const { projectConfig } = setup({ createDummyStories: true });
  const oldStoriesPath = `${projectConfig.root}/src/stories`;
- const newStoriesPath = `${oldStoriesPath}/${componentName}`;
+ const newStoriesPath = `${projectConfig.root}/stories`;
  const storyFiles: string[] = [];
 
  visitNotIgnoredFiles(tree, oldStoriesPath, treePath => {
@@ -956,10 +955,12 @@ describe('migrate-converged-pkg generator', () => {
  bundle-size/
  config/
  coverage/
+ docs/
  e2e/
  etc/
  node_modules/
  src/
+ stories/
  dist/types/
  temp/
  __fixtures__
@@ -969,7 +970,6 @@ describe('migrate-converged-pkg generator', () => {
  *.api.json
  *.log
  *.spec.*
- *.stories.*
  *.test.*
  *.yml
 

tools/generators/migrate-converged-pkg/index.ts

@@ -13,7 +13,6 @@ import {
  updateProjectConfiguration,
  serializeJson,
  offsetFromRoot,
- names,
 } from '@nrwl/devkit';
 import * as path from 'path';
 import * as os from 'os';
@@ -140,6 +139,7 @@ function runMigrationOnProject(tree: Tree, schema: AssertedSchema, _userLog: Use
  setupBabel(tree, options);
 
  updateNxWorkspace(tree, options);
+ moveDocsToSubfolder(tree, options);
 }
 
 // ==== helpers ====
@@ -300,7 +300,7 @@ const templates = {
 
  module.exports = /** @type {Omit<import('../../../../.storybook/main'), 'typescript'|'babel'>} */ ({
  ...rootMain,
- stories: [...rootMain.stories, '../src/**/*.stories.mdx', '../src/**/index.stories.@(ts|tsx)'],
+ stories: [...rootMain.stories, '../stories/**/*.stories.mdx', '../stories/**/index.stories.@(ts|tsx)'],
  addons: [...rootMain.addons],
  webpackFinal: (config, options) => {
  const localConfig = { ...rootMain.webpackFinal(config, options) };
@@ -327,7 +327,7 @@ const templates = {
  allowJs: true,
  checkJs: true,
  },
- include: ['../src/**/*.stories.ts', '../src/**/*.stories.tsx', '*.js'],
+ include: ['../stories/**/*.stories.ts', '../stories/**/*.stories.tsx', '*.js'],
  },
  },
  e2e: {
@@ -348,10 +348,12 @@ const templates = {
  bundle-size/
  config/
  coverage/
+ docs/
  e2e/
  etc/
  node_modules/
  src/
+ stories/
  dist/types/
  temp/
  __fixtures__
@@ -361,7 +363,6 @@ const templates = {
  *.api.json
  *.log
  *.spec.*
- *.stories.*
  *.test.*
  *.yml
 
@@ -640,7 +641,7 @@ function setupStorybook(tree: Tree, options: NormalizedSchema) {
  return json;
  });
 
- moveStories(tree, options);
+ moveStoriesToPackageRoot(tree, options);
  }
 
  if (sbAction === 'remove') {
@@ -711,41 +712,38 @@ function setupStorybook(tree: Tree, options: NormalizedSchema) {
  return tree;
 }
 
-function moveStories(tree: Tree, options: NormalizedSchema) {
- const componentName = names(options.normalizedPkgName).className.replace('React', '');
+function moveStoriesToPackageRoot(tree: Tree, options: NormalizedSchema) {
  const sourceRoot = options.projectConfig.sourceRoot ?? '';
  const oldStoriesPath = joinPathFragments(sourceRoot, 'stories');
- const newStoriesPath = joinPathFragments(oldStoriesPath, componentName);
- const storiesExistInNewPath = tree.exists(newStoriesPath);
+ const storiesExistInNewPath = tree.exists(options.paths.stories);
 
  if (storiesExistInNewPath) {
  return;
  }
 
  visitNotIgnoredFiles(tree, oldStoriesPath, treePath => {
  if (treePath.includes('.stories.') || treePath.includes('.md')) {
- const storyFileName = path.basename(treePath);
- const shouldBeMigratedToIndexFile = storyFileName.toLowerCase() === `${componentName.toLowerCase()}.stories.tsx`;
-
- const newStoryPath = joinPathFragments(
- newStoriesPath,
- shouldBeMigratedToIndexFile ? 'index.stories.tsx' : storyFileName,
- );
+ const newStoryPath = treePath
+ .split('/')
+ .filter(str => str !== 'src')
+ .join('/');
 
  tree.rename(treePath, newStoryPath);
- updateStoryFileImports(tree, options, newStoryPath);
  }
  });
 }
 
-function updateStoryFileImports(tree: Tree, options: NormalizedSchema, storyPath: string) {
- if (!tree.exists(storyPath)) {
- return;
- }
+function moveDocsToSubfolder(tree: Tree, options: NormalizedSchema) {
+ const root = options.projectConfig.root;
+ visitNotIgnoredFiles(tree, root, treePath => {
+ const currPath = treePath.toLowerCase();
+ if ((currPath.includes('.md') && currPath.includes('spec')) || currPath.includes('migration')) {
+ const fileName = path.basename(treePath);
+ const newPath = joinPathFragments(root, 'docs', fileName);
 
- const storyFile = tree.read(storyPath, 'utf8') as string;
- const updatedStoryFile = storyFile.replace('../index', options.name);
- tree.write(storyPath, updatedStoryFile);
+  tree.rename(treePath, newPath);
+  }
+ });
 }
 
 function shouldSetupStorybook(tree: Tree, options: NormalizedSchema) {

tools/utils.ts

@@ -103,6 +103,7 @@ export function getProjectConfig(tree: Tree, options: { packageName: string }) {
  rootJestPreset: '/jest.preset.js',
  rootJestConfig: '/jest.config.js',
  npmConfig: joinPathFragments(projectConfig.root, '.npmignore'),
+ stories: joinPathFragments(projectConfig.root, 'stories'),
  storybook: {
  rootFolder: joinPathFragments(projectConfig.root, '.storybook'),
  tsconfig: joinPathFragments(projectConfig.root, '.storybook/tsconfig.json'),