aberlaas-init 2.18.1 → 2.20.1

package/lib/layouts/__tests__/monorepo.js

@@ -1,28 +1,37 @@
-import { exists, glob, readJson, remove, tmpDirectory } from 'firost';
-import helper from 'aberlaas-helper';
 import {
-  lernaVersion,
+  exists,
+  glob,
+  readJson,
+  remove,
+  tmpDirectory,
+  writeJson,
+} from 'firost';
+import { hostGitPath, hostGitRoot, mockHelperPaths } from 'aberlaas-helper';
+import {
   nodeVersion,
   norskaThemeDocsVersion,
   norskaVersion,
   yarnVersion,
 } from 'aberlaas-versions';
-import current from '../monorepo.js';
+import { __ as initHelper } from '../../helper.js';
+import { __, run } from '../monorepo.js';
 
 describe('init > monorepo', () => {
+  const testDirectory = tmpDirectory('aberlaas/init/monorepo');
   beforeEach(async () => {
-    // We need to make the tmp directory outside of this git repo tree, for all
-    // git/yarn related command to work so we put it in a /tmp directory
-    vi.spyOn(helper, 'hostRoot').mockReturnValue(
-      tmpDirectory('aberlaas/init/monorepo'),
+    mockHelperPaths(testDirectory);
+
+    // Create a package.json with aberlaas in devDependencies
+    await writeJson(
+      { devDependencies: { aberlaas: '1.2.3' } },
+      hostGitPath('package.json'),
     );
 
-    vi.spyOn(current, '__getProjectName').mockReturnValue('my-project');
-    vi.spyOn(current, '__getProjectAuthor').mockReturnValue('my-name');
-    vi.spyOn(current, '__getAberlaasVersion').mockReturnValue('1.2.3');
+    vi.spyOn(initHelper, 'getProjectName').mockReturnValue('my-project');
+    vi.spyOn(initHelper, 'getProjectAuthor').mockReturnValue('my-name');
   });
   afterEach(async () => {
-    await remove(helper.hostRoot());
+    await remove(hostGitRoot());
   });
 
   // WORKSPACES
@@ -49,20 +58,18 @@ describe('init > monorepo', () => {
           dependencies: {},
           devDependencies: {
             aberlaas: '1.2.3',
-            lerna: lernaVersion,
           },
           scripts: {
-            build: './scripts/meta/build',
-            release: './scripts/meta/release',
-            lint: './scripts/meta/lint',
-            learn: 'lerna',
+            build: './scripts/build',
+            release: './scripts/release',
+            lint: './scripts/lint',
           },
         },
       ],
     ])('%s', async (_title, expected) => {
-      await current.createRootWorkspace();
+      await __.createRootWorkspace();
 
-      const actual = await readJson(helper.hostPath('package.json'));
+      const actual = await readJson(hostGitPath('package.json'));
 
       expect(actual).toMatchObject(expected);
     });
@@ -91,18 +98,16 @@ describe('init > monorepo', () => {
             'norska-theme-docs': norskaThemeDocsVersion,
           },
           scripts: {
-            build: '../../scripts/local/build',
-            release: '../../scripts/local/release',
-            lint: '../../scripts/local/lint',
+            build: 'cd ../.. && ./scripts/build',
+            release: 'cd ../.. && ./scripts/release',
+            lint: 'cd ../.. && ./scripts/lint',
           },
         },
       ],
     ])('%s', async (_title, expected) => {
-      await current.createDocsWorkspace();
+      await __.createDocsWorkspace();
 
-      const actual = await readJson(
-        helper.hostPath('modules/docs/package.json'),
-      );
+      const actual = await readJson(hostGitPath('modules/docs/package.json'));
 
       expect(actual).toMatchObject(expected);
     });
@@ -142,18 +147,16 @@ describe('init > monorepo', () => {
           dependencies: {},
 
           scripts: {
-            build: '../../scripts/local/build',
-            release: '../../scripts/local/release',
-            lint: '../../scripts/local/lint',
+            build: 'cd ../.. && ./scripts/build',
+            release: 'cd ../.. && ./scripts/release',
+            lint: 'cd ../.. && ./scripts/lint',
           },
         },
       ],
     ])('%s', async (_title, expected) => {
-      await current.createLibWorkspace();
+      await __.createLibWorkspace();
 
-      const actual = await readJson(
-        helper.hostPath('modules/lib/package.json'),
-      );
+      const actual = await readJson(hostGitPath('modules/lib/package.json'));
 
       expect(actual).toMatchObject(expected);
     });
@@ -161,31 +164,31 @@ describe('init > monorepo', () => {
 
   describe('addLicenseFiles', () => {
     it('creates license file in root and ./lib', async () => {
-      await current.addLicenseFiles();
+      await __.addLicenseFiles();
 
-      expect(await exists(helper.hostPath('LICENSE'))).toBe(true);
-      expect(await exists(helper.hostPath('modules/lib/LICENSE'))).toBe(true);
+      expect(await exists(hostGitPath('LICENSE'))).toBe(true);
+      expect(await exists(hostGitPath('modules/lib/LICENSE'))).toBe(true);
     });
   });
 
   describe('run', () => {
     it('should build a monorepo structure', async () => {
-      await current.run();
+      await run();
 
       const actual = await glob('**/*', {
-        cwd: helper.hostPath(),
+        cwd: hostGitPath(),
         absolutePaths: false,
         directories: false,
       });
 
       expect(actual).toEqual([
         '.circleci/config.yml',
-        '.gitattributes',
+        '.editorconfig',
         '.github/renovate.json',
         '.gitignore',
+        '.README.template.md',
         '.yarnrc.yml',
         'eslint.config.js',
-        'lerna.json',
         'LICENSE',
         'lintstaged.config.js',
         'modules/docs/package.json',
@@ -195,29 +198,18 @@ describe('init > monorepo', () => {
         'modules/lib/package.json',
         'package.json',
         'prettier.config.js',
+        'scripts/build',
+        'scripts/build-prod',
+        'scripts/ci',
+        'scripts/cms',
+        'scripts/compress',
         'scripts/hooks/pre-commit',
-        'scripts/local/build',
-        'scripts/local/build-prod',
-        'scripts/local/ci',
-        'scripts/local/cms',
-        'scripts/local/compress',
-        'scripts/local/lint',
-        'scripts/local/lint-fix',
-        'scripts/local/release',
-        'scripts/local/serve',
-        'scripts/local/test',
-        'scripts/local/test-watch',
-        'scripts/meta/build',
-        'scripts/meta/build-prod',
-        'scripts/meta/ci',
-        'scripts/meta/cms',
-        'scripts/meta/compress',
-        'scripts/meta/lint',
-        'scripts/meta/lint-fix',
-        'scripts/meta/release',
-        'scripts/meta/serve',
-        'scripts/meta/test',
-        'scripts/meta/test-watch',
+        'scripts/lint',
+        'scripts/lint-fix',
+        'scripts/release',
+        'scripts/serve',
+        'scripts/test',
+        'scripts/test-watch',
         'stylelint.config.js',
         'vite.config.js',
       ]);

package/lib/layouts/libdocs.js

@@ -1,22 +1,50 @@
 import { writeJson } from 'firost';
-
-import helper from 'aberlaas-helper';
+import { hostGitPath } from 'aberlaas-helper';
 import {
-  lernaVersion,
   nodeVersion,
   norskaThemeDocsVersion,
   norskaVersion,
   yarnVersion,
 } from 'aberlaas-versions';
-import initHelper from '../helper.js';
+import {
+  addConfigFiles,
+  addDefaultScripts,
+  addDocsScripts,
+  addLibFiles,
+  addLicenseFile,
+  getAberlaasVersion,
+  getProjectAuthor,
+  getProjectName,
+} from '../helper.js';
+
+export let __;
+
+/**
+ * Scaffold a repo:
+ * - As a monorepo
+ * - With ./libs and ./docs subfolders
+ */
+export async function run() {
+  await __.createRootWorkspace();
+  await __.createDocsWorkspace();
+  await __.createLibWorkspace();
+  await __.addLicenseFiles();
+
+  await addConfigFiles();
+  await addDefaultScripts();
+  await addDocsScripts();
+  await addLibFiles();
+}
+
+__ = {
+  // Public methods
 
-export default {
   /**
    * Create the top-level workspace
    */
   async createRootWorkspace() {
-    const aberlaasVersion = this.__getAberlaasVersion();
-    const sharedProjectData = await this.getSharedProjectData();
+    const aberlaasVersion = await getAberlaasVersion();
+    const sharedProjectData = await __.getSharedProjectData();
     const engines = {
       node: `>=${nodeVersion}`,
     };
@@ -45,39 +73,36 @@ export default {
       dependencies: {},
       devDependencies: {
         aberlaas: aberlaasVersion,
-        lerna: lernaVersion,
       },
 
       // Scripts
       scripts: {
         // Docs
-        build: './scripts/meta/build',
-        'build:prod': './scripts/meta/build-prod',
-        cms: './scripts/meta/cms',
-        serve: './scripts/meta/serve',
+        build: './scripts/build',
+        'build:prod': './scripts/build-prod',
+        cms: './scripts/cms',
+        serve: './scripts/serve',
 
         // Lib
-        release: './scripts/meta/release',
-        test: './scripts/meta/test',
-        'test:watch': './scripts/meta/test-watch',
-        ci: './scripts/meta/ci',
-        compress: './scripts/meta/compress',
-        lint: './scripts/meta/lint',
-        'lint:fix': './scripts/meta/lint-fix',
-
-        // Typo
-        learn: 'lerna',
+        release: './scripts/release',
+        test: './scripts/test',
+        'test:watch': './scripts/test-watch',
+        ci: './scripts/ci',
+        compress: './scripts/compress',
+        lint: './scripts/lint',
+        'lint:fix': './scripts/lint-fix',
       },
     };
-    await writeJson(packageContent, helper.hostPath('./package.json'), {
+    await writeJson(packageContent, hostGitPath('./package.json'), {
       sort: false,
     });
   },
+
   /**
    * Create the docs workspace
    */
   async createDocsWorkspace() {
-    const sharedProjectData = await this.getSharedProjectData();
+    const sharedProjectData = await __.getSharedProjectData();
 
     const packageContent = {
       // Name & Version
@@ -106,15 +131,16 @@ export default {
       // Scripts
       scripts: sharedProjectData.scripts,
     };
-    await writeJson(packageContent, helper.hostPath('./docs/package.json'), {
+    await writeJson(packageContent, hostGitPath('./docs/package.json'), {
       sort: false,
     });
   },
+
   /**
    * Create the lib workspace
    */
   async createLibWorkspace() {
-    const sharedProjectData = await this.getSharedProjectData();
+    const sharedProjectData = await __.getSharedProjectData();
     const engines = {
       node: `>=${nodeVersion}`,
     };
@@ -154,50 +180,43 @@ export default {
       // Scripts
       scripts: sharedProjectData.scripts,
     };
-    await writeJson(packageContent, helper.hostPath('./lib/package.json'), {
+    await writeJson(packageContent, hostGitPath('./lib/package.json'), {
       sort: false,
     });
   },
+
   /**
    * Add MIT license files to the repository
    */
   async addLicenseFiles() {
     // One at the repo root, for GitHub
-    await initHelper.addLicenseFile('LICENSE');
+    await addLicenseFile('LICENSE');
     // One in ./lib to be released with the module
-    await initHelper.addLicenseFile('lib/LICENSE');
+    await addLicenseFile('lib/LICENSE');
   },
-  /**
-   * Add config files
-   */
-  async addConfigFiles() {
-    await initHelper.addConfigFiles();
 
-    // Lerna
-    await initHelper.copyTemplateToHost('lerna.json', 'lerna.json');
-  },
   /**
    * Returns shared project data, like name, author, scripts, etc
    * @returns {object} Object of common keys
    */
   async getSharedProjectData() {
-    const name = await this.__getProjectName();
-    const author = await this.__getProjectAuthor();
+    const name = await getProjectName();
+    const author = await getProjectAuthor();
     const homepage = `https://projects.pixelastic.com/${name}`;
     const repository = `${author}/${name}`;
     const license = 'MIT';
     const scripts = {
-      build: '../scripts/local/build',
-      'build:prod': '../scripts/local/build-prod',
-      cms: '../scripts/local/cms',
-      serve: '../scripts/local/serve',
-      ci: '../scripts/local/ci',
-      release: '../scripts/local/release',
-      test: '../scripts/local/test',
-      'test:watch': '../scripts/local/test-watch',
-      compress: '../scripts/local/compress',
-      lint: '../scripts/local/lint',
-      'lint:fix': '../scripts/local/lint-fix',
+      build: 'cd .. && ./scripts/build',
+      'build:prod': 'cd .. && ./scripts/build-prod',
+      cms: 'cd .. && ./scripts/cms',
+      serve: 'cd .. && ./scripts/serve',
+      ci: 'cd .. && ./scripts/ci',
+      release: 'cd .. && ./scripts/release',
+      test: 'cd .. && ./scripts/test',
+      'test:watch': 'cd .. && ./scripts/test-watch',
+      compress: 'cd .. && ./scripts/compress',
+      lint: 'cd .. && ./scripts/lint',
+      'lint:fix': 'cd .. && ./scripts/lint-fix',
     };
     return {
       author,
@@ -208,22 +227,8 @@ export default {
       scripts,
     };
   },
-  /**
-   * Scaffold a repo:
-   * - As a monorepo
-   * - With ./libs and ./docs subfolders
-   */
-  async run() {
-    await this.createRootWorkspace();
-    await this.createDocsWorkspace();
-    await this.createLibWorkspace();
-
-    await this.addLicenseFiles();
-    await this.addConfigFiles();
-    await initHelper.addScripts('__libdocs');
-    await initHelper.addLibFiles();
-  },
-  __getProjectName: initHelper.getProjectName,
-  __getProjectAuthor: initHelper.getProjectAuthor.bind(initHelper),
-  __getAberlaasVersion: initHelper.getAberlaasVersion,
+};
+
+export default {
+  run,
 };

package/lib/layouts/module.js

@@ -1,18 +1,41 @@
 import { writeJson } from 'firost';
+import { hostGitPath } from 'aberlaas-helper';
 import { nodeVersion, yarnVersion } from 'aberlaas-versions';
-import helper from 'aberlaas-helper';
-import initHelper from '../helper.js';
+import {
+  addConfigFiles,
+  addDefaultScripts,
+  addLibFiles,
+  addLicenseFile,
+  getAberlaasVersion,
+  getProjectAuthor,
+  getProjectName,
+} from '../helper.js';
 
-export default {
+export let __;
+
+/**
+ * Scaffold a repo:
+ * - With ./lib holding the code
+ */
+export async function run() {
+  await __.createPackageJson();
+
+  await addLicenseFile('LICENSE');
+  await addConfigFiles();
+  await addDefaultScripts();
+  await addLibFiles();
+}
+
+__ = {
   /**
    * Create the package.json
    */
   async createPackageJson() {
-    const aberlaasVersion = this.__getAberlaasVersion();
-    const name = await this.__getProjectName();
+    const aberlaasVersion = await getAberlaasVersion();
+    const name = await getProjectName();
     const version = '0.0.1';
 
-    const author = await this.__getProjectAuthor();
+    const author = await getProjectAuthor();
     const description = '';
     const keywords = [];
     const repository = `${author}/${name}`;
@@ -79,24 +102,12 @@ export default {
       scripts,
     };
 
-    await writeJson(packageContent, helper.hostPath('./package.json'), {
+    await writeJson(packageContent, hostGitPath('./package.json'), {
       sort: false,
     });
   },
+};
 
-  /**
-   * Scaffold a repo:
-   * - With ./lib holding the code
-   */
-  async run() {
-    await this.createPackageJson();
-
-    await initHelper.addLicenseFile('LICENSE');
-    await initHelper.addConfigFiles();
-    await initHelper.addScripts('__module');
-    await initHelper.addLibFiles();
-  },
-  __getProjectName: initHelper.getProjectName,
-  __getProjectAuthor: initHelper.getProjectAuthor.bind(initHelper),
-  __getAberlaasVersion: initHelper.getAberlaasVersion,
+export default {
+  run,
 };