aberlaas-init 2.10.0 → 2.13.0

package/lib/helper.js

@@ -3,13 +3,15 @@ import Gilmore from 'gilmore';
 import {
   absolute,
   copy,
+  env,
   error as firostError,
+  glob,
   isFile,
   move,
   read,
   write,
 } from 'firost';
-import { _ } from 'golgoth';
+import { _, pMap } from 'golgoth';
 import helper from 'aberlaas-helper';
 import { nodeVersion, yarnVersion } from 'aberlaas-versions';
 
@@ -34,6 +36,15 @@ export default {
     return (await repo.githubRepoOwner()) || '__placeholder__';
   },
 
+  /**
+   * Return the version of aberlaas used on the CLI
+   * This should have been set by the top-level entrypoint
+   * @returns {string} Version number
+   **/
+  getAberlaasVersion() {
+    return env('ABERLAAS_VERSION');
+  },
+
   /**
    * Copy a config template to the host
    * @param {string} source Path to source file, relative to ./templates folder
@@ -109,28 +120,23 @@ export default {
   },
 
   /**
-   * Add default script files
+   * Add script files
+   * @param {string} layoutPrefixPath Path to the subfolder in
+   * ./templates/scripts that hold the script files to copy
    */
-  async addScripts() {
-    // Common
-    await this.copyTemplateToHost('scripts/ci', 'scripts/ci');
-    await this.copyTemplateToHost('scripts/compress', 'scripts/compress');
-    await this.copyTemplateToHost('scripts/lint', 'scripts/lint');
-    await this.copyTemplateToHost('scripts/lint-fix', 'scripts/lint-fix');
-
-    // Hooks
-    await this.copyTemplateToHost(
-      './scripts/hooks/pre-commit',
-      './scripts/hooks/pre-commit',
-    );
-
-    // Lib
-    await this.copyTemplateToHost('scripts/lib/release', 'scripts/lib/release');
-    await this.copyTemplateToHost('scripts/lib/test', 'scripts/lib/test');
-    await this.copyTemplateToHost(
-      'scripts/lib/test-watch',
-      'scripts/lib/test-watch',
-    );
+  async addScripts(layoutPrefixPath) {
+    const templateFolder = absolute('../templates/scripts/', layoutPrefixPath);
+    const templateScripts = await glob('**/*', {
+      directories: false,
+      context: templateFolder,
+      absolutePaths: false,
+    });
+
+    await pMap(templateScripts, async (templatePath) => {
+      const sourcePath = `scripts/${layoutPrefixPath}/${templatePath}`;
+      const destinationPath = `scripts/${templatePath}`;
+      await this.copyTemplateToHost(sourcePath, destinationPath);
+    });
   },
 
   /**
@@ -179,12 +185,13 @@ export default {
 
   /**
    * Add default files required to have the minimum lib module
+   * @param {string} libPrefixPath Path to the lib files, ./lib by default
    */
-  async addLibFiles() {
-    await this.copyTemplateToHost('lib/main.js', 'lib/main.js');
+  async addLibFiles(libPrefixPath = 'lib') {
+    await this.copyTemplateToHost('lib/main.js', `${libPrefixPath}/main.js`);
     await this.copyTemplateToHost(
       'lib/__tests__/main.js',
-      'lib/__tests__/main.js',
+      `${libPrefixPath}/__tests__/main.js`,
     );
   },
   __getRepo() {

package/lib/layouts/__tests__/libdocs.js

@@ -0,0 +1,222 @@
+import { exists, glob, readJson, remove, tmpDirectory } from 'firost';
+import helper from 'aberlaas-helper';
+import {
+  lernaVersion,
+  nodeVersion,
+  norskaThemeDocsVersion,
+  norskaVersion,
+  yarnVersion,
+} from 'aberlaas-versions';
+import current from '../libdocs.js';
+
+describe('init > libdocs', () => {
+  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/libdocs'),
+    );
+
+    vi.spyOn(current, '__getProjectName').mockReturnValue('my-project');
+    vi.spyOn(current, '__getProjectAuthor').mockReturnValue('my-name');
+    vi.spyOn(current, '__getAberlaasVersion').mockReturnValue('1.2.3');
+  });
+  afterEach(async () => {
+    await remove(helper.hostRoot());
+  });
+
+  // WORKSPACES
+  describe('createRootWorkspace', () => {
+    it.each([
+      [
+        'should have correct metadata',
+        {
+          name: 'my-project-root',
+          author: 'my-name',
+          description: 'my-project root workspace',
+          repository: 'my-name/my-project',
+          homepage: 'https://projects.pixelastic.com/my-project',
+          license: 'MIT',
+        },
+      ],
+      [
+        'should have root specific data',
+        {
+          private: true,
+          workspaces: ['docs', 'lib'],
+          type: 'module',
+          packageManager: `yarn@${yarnVersion}`,
+          dependencies: {},
+          devDependencies: {
+            aberlaas: '1.2.3',
+            lerna: lernaVersion,
+          },
+          scripts: {
+            build: './scripts/meta/build',
+            release: './scripts/meta/release',
+            lint: './scripts/meta/lint',
+            learn: 'lerna',
+          },
+        },
+      ],
+    ])('%s', async (_title, expected) => {
+      await current.createRootWorkspace();
+
+      const actual = await readJson(helper.hostPath('package.json'));
+
+      expect(actual).toMatchObject(expected);
+    });
+  });
+  describe('createDocsWorkspace', () => {
+    it.each([
+      [
+        'should have correct metadata',
+        {
+          name: 'my-project-docs',
+          version: '0.0.1',
+          author: 'my-name',
+          description: 'my-project docs',
+          repository: 'my-name/my-project',
+          homepage: 'https://projects.pixelastic.com/my-project',
+          license: 'MIT',
+        },
+      ],
+      [
+        'should have docs specific data',
+        {
+          private: true,
+          devDependencies: {},
+          dependencies: {
+            norska: norskaVersion,
+            'norska-theme-docs': norskaThemeDocsVersion,
+          },
+          scripts: {
+            build: '../scripts/local/build',
+            release: '../scripts/local/release',
+            lint: '../scripts/local/lint',
+          },
+        },
+      ],
+    ])('%s', async (_title, expected) => {
+      await current.createDocsWorkspace();
+
+      const actual = await readJson(helper.hostPath('docs/package.json'));
+
+      expect(actual).toMatchObject(expected);
+    });
+  });
+  describe('createLibWorkspace', () => {
+    it.each([
+      [
+        'should have correct metadata',
+        {
+          name: 'my-project',
+          version: '0.0.1',
+          author: 'my-name',
+          description: '',
+          keywords: [],
+          repository: 'my-name/my-project',
+          homepage: 'https://projects.pixelastic.com/my-project',
+          license: 'MIT',
+        },
+      ],
+      [
+        'should have lib specific data',
+        {
+          private: false,
+          type: 'module',
+          sideEffects: false,
+          engines: {
+            node: `>=${nodeVersion}`,
+          },
+
+          files: ['*.js'],
+          exports: { '.': './main.js' },
+          // Some tools have trouble parsing the .exports field, so we keep the
+          // .main field for backward compatibility
+          main: './main.js',
+
+          devDependencies: {},
+          dependencies: {},
+
+          scripts: {
+            build: '../scripts/local/build',
+            release: '../scripts/local/release',
+            lint: '../scripts/local/lint',
+          },
+        },
+      ],
+    ])('%s', async (_title, expected) => {
+      await current.createLibWorkspace();
+
+      const actual = await readJson(helper.hostPath('lib/package.json'));
+
+      expect(actual).toMatchObject(expected);
+    });
+  });
+
+  describe('addLicenseFiles', () => {
+    it('creates license file in root and ./lib', async () => {
+      await current.addLicenseFiles();
+
+      expect(await exists(helper.hostPath('LICENSE'))).toBe(true);
+      expect(await exists(helper.hostPath('lib/LICENSE'))).toBe(true);
+    });
+  });
+
+  describe('run', () => {
+    it('should build a libdocs structure', async () => {
+      await current.run();
+
+      const actual = await glob('**/*', {
+        context: helper.hostPath(),
+        absolutePaths: false,
+        directories: false,
+      });
+
+      expect(actual).toEqual([
+        '.circleci/config.yml',
+        '.gitattributes',
+        '.github/renovate.json',
+        '.gitignore',
+        '.yarnrc.yml',
+        'docs/package.json',
+        'eslint.config.js',
+        'lerna.json',
+        'lib/__tests__/main.js',
+        'lib/LICENSE',
+        'lib/main.js',
+        'lib/package.json',
+        'LICENSE',
+        'lintstaged.config.js',
+        'package.json',
+        'prettier.config.js',
+        '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',
+        'stylelint.config.js',
+        'vite.config.js',
+      ]);
+    });
+  });
+});

package/lib/layouts/__tests__/module.js

@@ -0,0 +1,130 @@
+import { glob, readJson, remove, tmpDirectory } from 'firost';
+import helper from 'aberlaas-helper';
+import { nodeVersion, yarnVersion } from 'aberlaas-versions';
+import current from '../module.js';
+
+describe('init > module', () => {
+  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/module'),
+    );
+
+    vi.spyOn(current, '__getProjectName').mockReturnValue('my-project');
+    vi.spyOn(current, '__getProjectAuthor').mockReturnValue('my-name');
+    vi.spyOn(current, '__getAberlaasVersion').mockReturnValue('1.2.3');
+  });
+  afterEach(async () => {
+    await remove(helper.hostRoot());
+  });
+
+  describe('createPackageJson', () => {
+    it.each([
+      [
+        'should have correct metadata',
+        {
+          name: 'my-project',
+          version: '0.0.1',
+          author: 'my-name',
+          description: '',
+          keywords: [],
+          repository: 'my-name/my-project',
+          homepage: 'https://github.com/my-name/my-project',
+        },
+      ],
+      [
+        'should have correct license',
+        {
+          license: 'MIT',
+        },
+      ],
+      [
+        'should have ESM information',
+        {
+          type: 'module',
+          sideEffects: false,
+        },
+      ],
+      [
+        'should have language and yarn version',
+        {
+          engines: {
+            node: `>=${nodeVersion}`,
+          },
+          packageManager: `yarn@${yarnVersion}`,
+        },
+      ],
+      [
+        'should export the right files',
+        {
+          files: ['lib/*.js'],
+          exports: { '.': './lib/main.js' },
+          main: './lib/main.js',
+        },
+      ],
+      [
+        'should have the right dependencies',
+        {
+          devDependencies: {
+            aberlaas: '1.2.3',
+          },
+          dependencies: {},
+        },
+      ],
+      [
+        'should have scripts',
+        {
+          scripts: {
+            release: './scripts/release',
+            test: './scripts/test',
+            lint: './scripts/lint',
+          },
+        },
+      ],
+    ])('%s', async (_title, expected) => {
+      await current.createPackageJson();
+
+      const actual = await readJson(helper.hostPath('package.json'));
+
+      expect(actual).toMatchObject(expected);
+    });
+  });
+
+  describe('run', () => {
+    it('should build a module structure', async () => {
+      await current.run();
+
+      const actual = await glob('**/*', {
+        context: helper.hostPath(),
+        absolutePaths: false,
+        directories: false,
+      });
+
+      expect(actual).toEqual([
+        '.circleci/config.yml',
+        '.gitattributes',
+        '.github/renovate.json',
+        '.gitignore',
+        '.yarnrc.yml',
+        'eslint.config.js',
+        'lib/__tests__/main.js',
+        'lib/main.js',
+        'LICENSE',
+        'lintstaged.config.js',
+        'package.json',
+        'prettier.config.js',
+        'scripts/ci',
+        'scripts/compress',
+        'scripts/hooks/pre-commit',
+        'scripts/lint',
+        'scripts/lint-fix',
+        'scripts/release',
+        'scripts/test',
+        'scripts/test-watch',
+        'stylelint.config.js',
+        'vite.config.js',
+      ]);
+    });
+  });
+});

package/lib/layouts/__tests__/monorepo.js

@@ -0,0 +1,226 @@
+import { exists, glob, readJson, remove, tmpDirectory } from 'firost';
+import helper from 'aberlaas-helper';
+import {
+  lernaVersion,
+  nodeVersion,
+  norskaThemeDocsVersion,
+  norskaVersion,
+  yarnVersion,
+} from 'aberlaas-versions';
+import current from '../monorepo.js';
+
+describe('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'),
+    );
+
+    vi.spyOn(current, '__getProjectName').mockReturnValue('my-project');
+    vi.spyOn(current, '__getProjectAuthor').mockReturnValue('my-name');
+    vi.spyOn(current, '__getAberlaasVersion').mockReturnValue('1.2.3');
+  });
+  afterEach(async () => {
+    await remove(helper.hostRoot());
+  });
+
+  // WORKSPACES
+  describe('createRootWorkspace', () => {
+    it.each([
+      [
+        'should have correct metadata',
+        {
+          name: 'my-project-monorepo',
+          author: 'my-name',
+          description: 'my-project monorepo',
+          repository: 'my-name/my-project',
+          homepage: 'https://projects.pixelastic.com/my-project',
+          license: 'MIT',
+        },
+      ],
+      [
+        'should have root specific data',
+        {
+          private: true,
+          workspaces: ['modules/*'],
+          type: 'module',
+          packageManager: `yarn@${yarnVersion}`,
+          dependencies: {},
+          devDependencies: {
+            aberlaas: '1.2.3',
+            lerna: lernaVersion,
+          },
+          scripts: {
+            build: './scripts/meta/build',
+            release: './scripts/meta/release',
+            lint: './scripts/meta/lint',
+            learn: 'lerna',
+          },
+        },
+      ],
+    ])('%s', async (_title, expected) => {
+      await current.createRootWorkspace();
+
+      const actual = await readJson(helper.hostPath('package.json'));
+
+      expect(actual).toMatchObject(expected);
+    });
+  });
+  describe('createDocsWorkspace', () => {
+    it.each([
+      [
+        'should have correct metadata',
+        {
+          name: 'my-project-docs',
+          version: '0.0.1',
+          author: 'my-name',
+          description: 'my-project docs',
+          repository: 'my-name/my-project',
+          homepage: 'https://projects.pixelastic.com/my-project',
+          license: 'MIT',
+        },
+      ],
+      [
+        'should have docs specific data',
+        {
+          private: true,
+          devDependencies: {},
+          dependencies: {
+            norska: norskaVersion,
+            'norska-theme-docs': norskaThemeDocsVersion,
+          },
+          scripts: {
+            build: '../../scripts/local/build',
+            release: '../../scripts/local/release',
+            lint: '../../scripts/local/lint',
+          },
+        },
+      ],
+    ])('%s', async (_title, expected) => {
+      await current.createDocsWorkspace();
+
+      const actual = await readJson(
+        helper.hostPath('modules/docs/package.json'),
+      );
+
+      expect(actual).toMatchObject(expected);
+    });
+  });
+  describe('createLibWorkspace', () => {
+    it.each([
+      [
+        'should have correct metadata',
+        {
+          name: 'my-project',
+          version: '0.0.1',
+          author: 'my-name',
+          description: '',
+          keywords: [],
+          repository: 'my-name/my-project',
+          homepage: 'https://projects.pixelastic.com/my-project',
+          license: 'MIT',
+        },
+      ],
+      [
+        'should have lib specific data',
+        {
+          private: false,
+          type: 'module',
+          sideEffects: false,
+          engines: {
+            node: `>=${nodeVersion}`,
+          },
+
+          files: ['*.js'],
+          exports: { '.': './main.js' },
+          // Some tools have trouble parsing the .exports field, so we keep the
+          // .main field for backward compatibility
+          main: './main.js',
+
+          devDependencies: {},
+          dependencies: {},
+
+          scripts: {
+            build: '../../scripts/local/build',
+            release: '../../scripts/local/release',
+            lint: '../../scripts/local/lint',
+          },
+        },
+      ],
+    ])('%s', async (_title, expected) => {
+      await current.createLibWorkspace();
+
+      const actual = await readJson(
+        helper.hostPath('modules/lib/package.json'),
+      );
+
+      expect(actual).toMatchObject(expected);
+    });
+  });
+
+  describe('addLicenseFiles', () => {
+    it('creates license file in root and ./lib', async () => {
+      await current.addLicenseFiles();
+
+      expect(await exists(helper.hostPath('LICENSE'))).toBe(true);
+      expect(await exists(helper.hostPath('modules/lib/LICENSE'))).toBe(true);
+    });
+  });
+
+  describe('run', () => {
+    it('should build a monorepo structure', async () => {
+      await current.run();
+
+      const actual = await glob('**/*', {
+        context: helper.hostPath(),
+        absolutePaths: false,
+        directories: false,
+      });
+
+      expect(actual).toEqual([
+        '.circleci/config.yml',
+        '.gitattributes',
+        '.github/renovate.json',
+        '.gitignore',
+        '.yarnrc.yml',
+        'eslint.config.js',
+        'lerna.json',
+        'LICENSE',
+        'lintstaged.config.js',
+        'modules/docs/package.json',
+        'modules/lib/__tests__/main.js',
+        'modules/lib/LICENSE',
+        'modules/lib/main.js',
+        'modules/lib/package.json',
+        'package.json',
+        'prettier.config.js',
+        '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',
+        'stylelint.config.js',
+        'vite.config.js',
+      ]);
+    });
+  });
+});