aberlaas-init 2.18.1 → 2.20.1

package/lib/helper.js

@@ -1,30 +1,121 @@
 import path from 'node:path';
-import Gilmore from 'gilmore';
+import { _ } from 'golgoth';
 import {
   absolute,
+  consoleWarn,
   copy,
-  env,
   firostError,
-  glob,
   isFile,
   move,
   read,
+  readJson,
+  remove,
+  wrap,
   write,
 } from 'firost';
-import { _, pMap } from 'golgoth';
-import helper from 'aberlaas-helper';
+import { hostGitPath, hostGitRoot } from 'aberlaas-helper';
 import { nodeVersion, yarnVersion } from 'aberlaas-versions';
+import Gilmore from 'gilmore';
 
-/**
- * This hold functions shared for both the monorepo and simple init scenarios
- */
-export default {
+export const __ = {
   /**
-   * Return name of the current project, as the name of the current directory
-   * @returns {string} Name of the project
+   * Add config files to the host. Each config files reference the default
+   * aberlaas config for its tool. This pattern allow end-users to use aberlaas
+   * default rules and overwrite them as they see fit
    */
-  getProjectName() {
-    return path.basename(helper.hostRoot());
+  async addConfigFiles() {
+    // Editorconfig
+    await __.copyTemplateToHost('_editorconfig', '.editorconfig');
+
+    // Git
+    await __.copyTemplateToHost('_gitignore', '.gitignore');
+    await remove(hostGitPath('.gitattributes'));
+
+    // README template
+    await __.copyTemplateToHost('_README.template.md', '.README.template.md');
+
+    // Yarn
+    await __.copyTemplateToHost('_yarnrc.yml', '.yarnrc.yml');
+
+    // ESLint
+    await __.copyTemplateToHost('eslint.config.js');
+
+    // Lint-staged
+    await __.copyTemplateToHost('lintstaged.config.js');
+
+    // Vite
+    await __.copyTemplateToHost('vite.config.js');
+
+    // Prettier
+    await __.copyTemplateToHost('prettier.config.js');
+
+    // Stylelint
+    await __.copyTemplateToHost('stylelint.config.js');
+
+    // Renovate
+    await __.copyTemplateToHost(
+      '_github/renovate.json',
+      '.github/renovate.json',
+    );
+
+    // CircleCI
+    await __.addCircleCIConfigFile();
+  },
+
+  /**
+   * Add default files required to have the minimum lib module
+   * @param {string} libPrefixPath Path to the lib files, ./lib by default
+   */
+  async addLibFiles(libPrefixPath = 'lib') {
+    await __.copyTemplateToHost('lib/main.js', `${libPrefixPath}/main.js`);
+    await __.copyTemplateToHost(
+      'lib/__tests__/main.js',
+      `${libPrefixPath}/__tests__/main.js`,
+    );
+  },
+
+  /**
+   * Add MIT license file
+   * @param {string} hostFilepath Path to the LICENSE file, relative to the host
+   */
+  async addLicenseFile(hostFilepath) {
+    // Start by adding a template
+    await __.copyTemplateToHost('LICENSE', hostFilepath);
+
+    // Replace placeholder with real value
+    const licensePath = hostGitPath(hostFilepath);
+    const author = await __.getProjectAuthor();
+    const templateContent = await read(licensePath);
+    const actualContent = _.replace(templateContent, '{author}', author);
+
+    // Write it again
+    await write(actualContent, licensePath);
+  },
+
+  /**
+   * Add default script files from templates/scripts to the host
+   * Excludes documentation-specific scripts (build, build-prod, cms, serve)
+   */
+  async addDefaultScripts() {
+    await __.copyTemplateToHost('scripts/ci');
+    await __.copyTemplateToHost('scripts/compress');
+    await __.copyTemplateToHost('scripts/lint');
+    await __.copyTemplateToHost('scripts/lint-fix');
+    await __.copyTemplateToHost('scripts/release');
+    await __.copyTemplateToHost('scripts/test');
+    await __.copyTemplateToHost('scripts/test-watch');
+    await __.copyTemplateToHost('scripts/hooks/pre-commit');
+  },
+
+  /**
+   * Add documentation-specific scripts from templates/scripts to the host
+   * Only includes: build, build-prod, cms, serve
+   */
+  async addDocsScripts() {
+    await __.copyTemplateToHost('scripts/build');
+    await __.copyTemplateToHost('scripts/build-prod');
+    await __.copyTemplateToHost('scripts/cms');
+    await __.copyTemplateToHost('scripts/serve');
   },
 
   /**
@@ -32,33 +123,48 @@ export default {
    * @returns {string} Name of the author, or __placeholder__ if undefined
    */
   async getProjectAuthor() {
-    const repo = this.__getRepo();
+    const repo = __.getRepo();
     return (await repo.githubRepoOwner()) || '__placeholder__';
   },
 
   /**
-   * Return the version of aberlaas used on the CLI
-   * This should have been set by the top-level entrypoint
+   * Return name of the current project, as the name of the current directory
+   * @returns {string} Name of the project
+   */
+  getProjectName() {
+    return path.basename(hostGitRoot());
+  },
+
+  /**
+   * Return the version of aberlaas installed in the project
+   * Reads from the host package.json devDependencies or dependencies
    * @returns {string} Version number
    **/
-  getAberlaasVersion() {
-    return env('ABERLAAS_VERSION');
+  async getAberlaasVersion() {
+    const packageJsonPath = hostGitPath('package.json');
+    const packageJson = await readJson(packageJsonPath);
+    return (
+      packageJson?.devDependencies?.aberlaas ||
+      packageJson?.dependencies?.aberlaas
+    );
   },
 
+  // === PRIVATE METHODS ===
   /**
    * Copy a config template to the host
    * @param {string} source Path to source file, relative to ./templates folder
-   * @param {string} destination Path to destination file, relative to the host
+   * @param {string} userDestination Path to destination file, relative to the host. Defaults to source if not provided.
    * @returns {boolean} False if can't copy file, true otherwise
    */
-  async copyTemplateToHost(source, destination) {
+  async copyTemplateToHost(source, userDestination) {
+    const destination = userDestination || source;
     const absoluteSource = absolute('../templates/', source);
-    const absoluteDestination = helper.hostPath(destination);
+    const absoluteDestination = hostGitPath(destination);
 
     // Source file does not exist
     if (!(await isFile(absoluteSource))) {
       throw firostError(
-        'ERROR_INIT_COPY_FILE',
+        'ABERLAAS_INIT_COPY_FILE_NOT_FOUND',
         `Unable to locate ${absoluteSource} file`,
       );
     }
@@ -71,9 +177,12 @@ export default {
         return true;
       }
 
-      // Otherwise create a backup
-      const backupDestination = `${absoluteDestination}.backup`;
+      // Otherwise create a backup in ./tmp/backup
+      const backupDestination = hostGitPath(`./tmp/backup/${destination}`);
       await move(absoluteDestination, backupDestination);
+      __.consoleWarn(
+        `Existing ${destination} backed up in ./tmp/backup/${destination}`,
+      );
     }
 
     await copy(absoluteSource, absoluteDestination);
@@ -81,32 +190,14 @@ export default {
     return true;
   },
 
-  /**
-   * Add MIT license file
-   * @param {string} hostFilepath Path to the LICENSE file, relative to the host
-   */
-  async addLicenseFile(hostFilepath) {
-    // Start by adding a template
-    await this.copyTemplateToHost('LICENSE', hostFilepath);
-
-    // Replace placeholder with real value
-    const licensePath = helper.hostPath(hostFilepath);
-    const author = await this.getProjectAuthor();
-    const templateContent = await read(licensePath);
-    const actualContent = _.replace(templateContent, '{author}', author);
-
-    // Write it again
-    await write(actualContent, licensePath);
-  },
-
   /**
    * Add CircleCI Config file
    */
   async addCircleCIConfigFile() {
-    const configFilepath = helper.hostPath('./.circleci/config.yml');
+    const configFilepath = hostGitPath('./.circleci/config.yml');
 
     // Start by adding a template
-    await this.copyTemplateToHost('_circleci/config.yml', configFilepath);
+    await __.copyTemplateToHost('_circleci/config.yml', configFilepath);
 
     // Replace placeholder with real value
     const templateContent = await read(configFilepath);
@@ -118,80 +209,20 @@ export default {
     // Write it again
     await write(actualContent, configFilepath);
   },
-
-  /**
-   * Add script files
-   * @param {string} layoutPrefixPath Path to the subfolder in
-   * ./templates/scripts that hold the script files to copy
-   */
-  async addScripts(layoutPrefixPath) {
-    const templateFolder = absolute('../templates/scripts/', layoutPrefixPath);
-    const templateScripts = await glob('**/*', {
-      directories: false,
-      cwd: templateFolder,
-      absolutePaths: false,
-    });
-
-    await pMap(templateScripts, async (templatePath) => {
-      const sourcePath = `scripts/${layoutPrefixPath}/${templatePath}`;
-      const destinationPath = `scripts/${templatePath}`;
-      await this.copyTemplateToHost(sourcePath, destinationPath);
-    });
-  },
-
-  /**
-   * Add config files to the host. Each config files reference the default
-   * aberlaas config for its tool. This pattern allow end-users to use aberlaas
-   * default rules and overwrite them as they see fit
-   */
-  async addConfigFiles() {
-    // Git
-    await this.copyTemplateToHost('./_gitignore', './.gitignore');
-    await this.copyTemplateToHost('./_gitattributes', './.gitattributes');
-
-    // Yarn
-    await this.copyTemplateToHost('_yarnrc.yml', '.yarnrc.yml');
-
-    // ESLint
-    await this.copyTemplateToHost('eslint.config.js', 'eslint.config.js');
-
-    // Lint-staged
-    await this.copyTemplateToHost(
-      'lintstaged.config.js',
-      'lintstaged.config.js',
-    );
-
-    // Vite
-    await this.copyTemplateToHost('vite.config.js', 'vite.config.js');
-
-    // Prettier
-    await this.copyTemplateToHost('prettier.config.js', 'prettier.config.js');
-
-    // Stylelint
-    await this.copyTemplateToHost('stylelint.config.js', 'stylelint.config.js');
-
-    // Renovate
-    await this.copyTemplateToHost(
-      '_github/renovate.json',
-      '.github/renovate.json',
-    );
-
-    // CircleCI
-    await this.addCircleCIConfigFile();
-  },
-
-  /**
-   * Add default files required to have the minimum lib module
-   * @param {string} libPrefixPath Path to the lib files, ./lib by default
-   */
-  async addLibFiles(libPrefixPath = 'lib') {
-    await this.copyTemplateToHost('lib/main.js', `${libPrefixPath}/main.js`);
-    await this.copyTemplateToHost(
-      'lib/__tests__/main.js',
-      `${libPrefixPath}/__tests__/main.js`,
-    );
-  },
-  __getRepo() {
-    return new Gilmore(helper.hostRoot());
+  getRepo() {
+    return new Gilmore(hostGitRoot());
   },
+  consoleWarn,
 };
+
+// Named exports of public methods, but wrapped in dynamic method so we can
+// still mock the inner methods in tests
+//
+export const addConfigFiles = wrap(__, 'addConfigFiles');
+export const addDefaultScripts = wrap(__, 'addDefaultScripts');
+export const addDocsScripts = wrap(__, 'addDocsScripts');
+export const addLibFiles = wrap(__, 'addLibFiles');
+export const addLicenseFile = wrap(__, 'addLicenseFile');
+export const getAberlaasVersion = wrap(__, 'getAberlaasVersion');
+export const getProjectAuthor = wrap(__, 'getProjectAuthor');
+export const getProjectName = wrap(__, 'getProjectName');

package/lib/layouts/__tests__/libdocs.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 '../libdocs.js';
+import { __ as initHelper } from '../../helper.js';
+import { __, run } from '../libdocs.js';
 
 describe('init > libdocs', () => {
+  const testDirectory = tmpDirectory('aberlaas/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'),
+    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 > libdocs', () => {
           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,16 +98,16 @@ describe('init > libdocs', () => {
             '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('docs/package.json'));
+      const actual = await readJson(hostGitPath('docs/package.json'));
 
       expect(actual).toMatchObject(expected);
     });
@@ -140,16 +147,16 @@ describe('init > libdocs', () => {
           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('lib/package.json'));
+      const actual = await readJson(hostGitPath('lib/package.json'));
 
       expect(actual).toMatchObject(expected);
     });
@@ -157,32 +164,33 @@ describe('init > libdocs', () => {
 
   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('lib/LICENSE'))).toBe(true);
+      expect(await exists(hostGitPath('LICENSE'))).toBe(true);
+      expect(await exists(hostGitPath('lib/LICENSE'))).toBe(true);
     });
   });
 
   describe('run', () => {
+    vi.setConfig({ testTimeout: 10_000 });
     it('should build a libdocs 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',
         'docs/package.json',
         'eslint.config.js',
-        'lerna.json',
         'lib/__tests__/main.js',
         'lib/LICENSE',
         'lib/main.js',
@@ -191,29 +199,18 @@ describe('init > libdocs', () => {
         'lintstaged.config.js',
         '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/__tests__/module.js

@@ -1,22 +1,25 @@
-import { glob, read, readJson, remove, tmpDirectory } from 'firost';
-import helper from 'aberlaas-helper';
+import { glob, read, readJson, remove, tmpDirectory, writeJson } from 'firost';
+import { hostGitPath, hostGitRoot, mockHelperPaths } from 'aberlaas-helper';
 import { nodeVersion, yarnVersion } from 'aberlaas-versions';
-import current from '../module.js';
+import { __ as initHelper } from '../../helper.js';
+import { __, run } from '../module.js';
 
 describe('init > module', () => {
+  const testDirectory = tmpDirectory('aberlaas/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'),
+    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());
   });
 
   describe('createPackageJson', () => {
@@ -83,9 +86,9 @@ describe('init > module', () => {
         },
       ],
     ])('%s', async (_title, expected) => {
-      await current.createPackageJson();
+      await __.createPackageJson();
 
-      const actual = await readJson(helper.hostPath('package.json'));
+      const actual = await readJson(hostGitPath('package.json'));
 
       expect(actual).toMatchObject(expected);
     });
@@ -93,19 +96,20 @@ describe('init > module', () => {
 
   describe('run', () => {
     it('should build a module 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',
         'lib/__tests__/main.js',
@@ -128,11 +132,9 @@ describe('init > module', () => {
     });
 
     it('should write a correct circleCI file', async () => {
-      await current.run();
+      await run();
 
-      const circleciConfig = await read(
-        helper.hostPath('.circleci/config.yml'),
-      );
+      const circleciConfig = await read(hostGitPath('.circleci/config.yml'));
 
       // Should not contain literal template placeholders
       expect(circleciConfig).not.toContain('{nodeVersion}');