refactor: union utils and generators (#2343)

Author: anshumanv

.eslintrc.js

@@ -6,7 +6,7 @@ module.exports = {
     plugins: ['node'],
     settings: {
         node: {
-            allowModules: ['@webpack-cli/generators', '@webpack-cli/utils'],
+            allowModules: ['@webpack-cli/generators'],
         },
     },
     env: {

packages/generators/__tests__/addon-generator.test.ts

@@ -18,22 +18,14 @@ describe('addon generator', () => {
     // we call this unwanted path doubleGenPath
     const doubleGenPath = path.join(genPath, genName);
 
-    beforeAll(() => {
-        rimraf.sync(testAssetsPath);
-        fs.mkdirSync(genPath, { recursive: true });
-        // set the working directory to here so that the addon directory is
-        // generated in ./test-assets/test-addon
-        process.chdir(genPath);
-        packageMock = getPackageManager as jest.Mock;
-    });
-
     afterAll(() => {
         rimraf.sync(testAssetsPath);
     });
 
     beforeEach(() => {
         // eslint-disable-next-line @typescript-eslint/no-empty-function
         const Gen = addonGenerator([], '', [], [], () => {});
+
         gen = new Gen(null, null);
         gen.props = {
             name: genName,
@@ -43,9 +35,20 @@ describe('addon generator', () => {
     });
 
     it('schedules install using npm', () => {
+        const defaultCwd = process.cwd();
+
+        rimraf.sync(testAssetsPath);
+        fs.mkdirSync(genPath, { recursive: true });
+
+        // set the working directory to here so that the addon directory is
+        // generated in ./test-assets/test-addon
+        process.chdir(genPath);
+
+        packageMock = getPackageManager as jest.Mock;
         packageMock.mockReturnValue('npm');
 
         gen.install();
+
         expect(installMock.mock.calls.length).toEqual(1);
         expect(installMock.mock.calls[0]).toEqual([
             'npm',
@@ -54,12 +57,24 @@ describe('addon generator', () => {
                 'save-dev': true,
             },
         ]);
+
+        process.chdir(defaultCwd);
     });
 
     it('schedules install using yarn', () => {
+        const defaultCwd = process.cwd();
+
+        rimraf.sync(testAssetsPath);
+        fs.mkdirSync(genPath, { recursive: true });
+        // set the working directory to here so that the addon directory is
+        // generated in ./test-assets/test-addon
+        process.chdir(genPath);
+
+        packageMock = getPackageManager as jest.Mock;
         packageMock.mockReturnValue('yarn');
 
         gen.install();
+
         expect(installMock.mock.calls.length).toEqual(1);
         expect(installMock.mock.calls[0]).toEqual([
             'yarn',
@@ -68,11 +83,26 @@ describe('addon generator', () => {
                 dev: true,
             },
         ]);
+
+        process.chdir(defaultCwd);
     });
 
     it('does not create new directory when current directory matches addon name', () => {
+        const defaultCwd = process.cwd();
+
+        rimraf.sync(testAssetsPath);
+        fs.mkdirSync(genPath, { recursive: true });
+
+        // set the working directory to here so that the addon directory is
+        // generated in ./test-assets/test-addon
+        process.chdir(genPath);
+
+        packageMock = getPackageManager as jest.Mock;
+
         expect(fs.existsSync(genPath)).toBeTruthy();
+
         gen.default();
+
         expect(fs.existsSync(genPath)).toBeTruthy();
         expect(fs.existsSync(doubleGenPath)).toBeFalsy();
 
@@ -81,14 +111,26 @@ describe('addon generator', () => {
         // generator above
         // this is switching the working directory as follows:
         // ./test-assets/test-addon -> ./test-assets
-        process.chdir(testAssetsPath);
         rimraf.sync(genPath);
+
+        process.chdir(defaultCwd);
     });
 
     it('creates a new directory for the generated addon', () => {
-        expect(fs.existsSync(genPath)).toBeFalsy();
+        const defaultCwd = process.cwd();
+
+        rimraf.sync(testAssetsPath);
+        fs.mkdirSync(genPath, { recursive: true });
+
+        // set the working directory to here so that the addon directory is
+        // generated in ./test-assets/test-addon
+        process.chdir(genPath);
+
         gen.default();
+
         expect(fs.existsSync(genPath)).toBeTruthy();
         expect(fs.existsSync(doubleGenPath)).toBeFalsy();
+
+        process.chdir(defaultCwd);
     });
 });

packages/generators/__tests__/utils/languageSupport.test.ts

@@ -1,5 +1,5 @@
-import language, { LangType, getBabelLoader, getTypescriptLoader } from '../../lib/utils/languageSupport';
-import { CustomGenerator } from '../../lib/types';
+import language, { LangType, getBabelLoader, getTypescriptLoader } from '../../src/utils/languageSupport';
+import { CustomGenerator } from '../../src/types';
 
 describe('languageSupport', () => {
     const getMockGenerator = (): CustomGenerator => {

packages/generators/__tests__/utils/plugins.test.ts

@@ -1,4 +1,4 @@
-import { replaceAt, generatePluginName } from '../../lib/utils/plugins';
+import { replaceAt, generatePluginName } from '../../src/utils/plugins';
 
 describe('generate plugin name', () => {
     it('should return webpack Standard Plugin Name for Name : extract-text-webpack-plugin', () => {

packages/generators/__tests__/utils/styleSupport.test.ts

@@ -1,5 +1,5 @@
-import style, { StylingType } from '../../lib/utils/styleSupport';
-import { CustomGenerator } from '../../lib/types';
+import style, { StylingType } from '../../src/utils/styleSupport';
+import { CustomGenerator } from '../../src/types';
 
 describe('styleSupport', () => {
     const getMockGenerator = (): CustomGenerator => {

packages/generators/package.json

@@ -17,11 +17,16 @@
     "plugin-template"
   ],
   "dependencies": {
-    "@webpack-cli/utils": "^1.2.1",
     "colorette": "^1.2.1",
     "log-symbols": "^4.0.0",
     "yeoman-environment": "^2.10.3",
-    "yeoman-generator": "^4.12.0"
+    "yeoman-generator": "^4.12.0",
+    "execa": "^4.1.0",
+    "findup-sync": "^4.0.0",
+    "global-modules": "^2.0.0",
+    "got": "^11.8.0",
+    "jscodeshift": "^0.11.0",
+    "p-each-series": "^2.1.0"
   },
   "peerDependencies": {
     "webpack": "4.x.x || 5.x.x",
@@ -33,7 +38,14 @@
     "@types/yeoman-test": "^2.0.5",
     "rimraf": "^3.0.2",
     "yeoman-assert": "^3.1.1",
-    "yeoman-test": "^2.3.0"
+    "yeoman-test": "^2.3.0",
+    "@types/got": "^9.6.11",
+    "@types/prettier": "^2.1.5"
+  },
+  "peerDependenciesMeta": {
+    "prettier": {
+      "optional": true
+    }
   },
   "gitHead": "fb50f766851f500ca12867a2aa9de81fa6e368f9"
 }

packages/generators/src/addon-generator.ts

@@ -1,7 +1,7 @@
 import fs from 'fs';
 import path from 'path';
 import Generator from 'yeoman-generator';
-import { generatorCopy, generatorCopyTpl } from '@webpack-cli/utils';
+import { generatorCopy, generatorCopyTpl } from './utils/copy-utils';
 
 import { utils } from 'webpack-cli';
 

packages/generators/src/index.ts

@@ -54,3 +54,16 @@ class GeneratorsCommand {
 
 export default GeneratorsCommand;
 export { addonGenerator, initGenerator };
+
+export * from './utils/ast-utils';
+export * from './utils/copy-utils';
+export * from './utils/modify-config-helper';
+export * from './utils/npm-exists';
+export * from './utils/npm-packages-exists';
+export * from './utils/recursive-parser';
+export * from './utils/resolve-packages';
+export * from './utils/run-prettier';
+export * from './utils/scaffold';
+export * from './utils/validate-identifier';
+export * from './utils/prop-types';
+export * from './utils/global-packages-path';

packages/generators/src/loader-generator.ts

@@ -11,9 +11,11 @@ import { toKebabCase } from './utils/helpers';
  */
 export function makeLoaderName(name: string): string {
     name = toKebabCase(name);
+
     if (!/loader$/.test(name)) {
         name += '-loader';
     }
+
     return name;
 }