aberlaas 2.3.0 → 2.5.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) {author}
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/commands/init/index.js

@@ -1,43 +1,189 @@
 import _ from 'golgoth/lodash.js';
-import pMapSeries from 'golgoth/pMapSeries.js';
 import isFile from 'firost/isFile.js';
 import copy from 'firost/copy.js';
+import move from 'firost/move.js';
 import readJson from 'firost/readJson.js';
 import writeJson from 'firost/writeJson.js';
-import exists from 'firost/exists.js';
+import firostError from 'firost/error.js';
 import read from 'firost/read.js';
 import write from 'firost/write.js';
 import run from 'firost/run.js';
 import spinner from 'firost/spinner.js';
 import helper from '../../helper.js';
-import path from 'path';
 import nodeConfig from '../../configs/node.cjs';
 import consoleInfo from 'firost/consoleInfo.js';
 import Gilmore from 'gilmore';
 
 export default {
   /**
-   * Copy a config template to the host
-   * @param {string} source Path to source file, relative to aberlaas
-   * @param {string} destination Path to destination file, relative to the host
-   * @returns {boolean} False if can't copy file, true otherwise
+   * Configure git hooks to use scripts/hooks instead of .git/hooks
    **/
-  async copyToHost(source, destination) {
-    const absoluteSource = helper.aberlaasPath(source);
-    const absoluteDestination = helper.hostPath(destination);
+  async configureGit() {
+    const repo = new Gilmore(helper.hostRoot());
+    await repo.setConfig('core.hooksPath', 'scripts/hooks');
+  },
+  /**
+   * Pin the node version through nvm
+   **/
+  async configureNode() {
+    const nvmrcPath = helper.hostPath('.nvmrc');
+    await write(nodeConfig.nodeVersion, nvmrcPath);
+  },
+  /**
+   * Create the top-level monorepo root workspace
+   **/
+  async createRootWorkspace() {
+    const aberlaasData = await readJson(helper.aberlaasPath('./package.json'));
+    const sharedProjectData = await this.getSharedProjectData();
 
-    // Source file does not exist
-    if (!(await isFile(absoluteSource))) {
-      return false;
-    }
-    // Destination file already exist
-    if (await isFile(absoluteDestination)) {
-      return false;
-    }
+    const packageContent = {
+      // Visibility
+      private: true,
+      workspaces: ['docs', 'lib'],
 
-    await copy(absoluteSource, absoluteDestination);
+      // Name and version
+      name: `${sharedProjectData.name}-monorepo`,
+      version: '0.0.1',
 
-    return true;
+      // Metadata
+      author: sharedProjectData.author,
+      description: `${sharedProjectData.name} monorepo`,
+      repository: sharedProjectData.repository,
+      homepage: sharedProjectData.homepage,
+
+      // Compatibility
+      type: 'module',
+      license: sharedProjectData.license,
+      packageManager: `yarn@${nodeConfig.yarnVersion}`,
+
+      // Exports
+
+      // Dependencies
+      dependencies: {},
+      devDependencies: {
+        aberlaas: aberlaasData.version,
+        lerna: nodeConfig.lernaVersion,
+      },
+
+      // Scripts
+      scripts: {
+        // ==> Docs-specific
+        build: './scripts/docs/build',
+        'build:prod': './scripts/docs/build-prod',
+        cms: './scripts/docs/cms',
+        serve: './scripts/docs/serve',
+        // ==> Lib-specific
+        release: './scripts/lib/release',
+        test: './scripts/lib/test',
+        'test:watch': './scripts/lib/test-watch',
+        // Common
+        ci: './scripts/ci',
+        compress: './scripts/compress',
+        lint: './scripts/lint',
+        'lint:fix': './scripts/lint-fix',
+
+        // Global (called as aliases from any workspace)
+        // ==> Docs-specific
+        'g:build': './scripts/docs/build',
+        'g:build:prod': './scripts/docs/build-prod',
+        'g:cms': './scripts/docs/cms',
+        'g:serve': './scripts/docs/serve',
+        // ==> Lib-specific
+        'g:release': './scripts/lib/release',
+        'g:test': './scripts/lib/test',
+        'g:test:watch': './scripts/lib/test-watch',
+        // Common
+        'g:compress': './scripts/compress',
+        'g:lint': './scripts/lint',
+        'g:lint:fix': './scripts/lint-fix',
+      },
+    };
+    await writeJson(packageContent, helper.hostPath('./package.json'), {
+      sort: false,
+    });
+  },
+  /**
+   * Create the docs workspace
+   **/
+  async createDocsWorkspace() {
+    const sharedProjectData = await this.getSharedProjectData();
+
+    const packageContent = {
+      // Visibility
+      private: true,
+
+      // Name & Version
+      name: `${sharedProjectData.name}-docs`,
+      version: '0.0.1',
+
+      // Metadata
+      author: sharedProjectData.author,
+      description: `${sharedProjectData.name} docs`,
+      repository: sharedProjectData.repository,
+      homepage: sharedProjectData.homepage,
+
+      // Compatibility
+      license: sharedProjectData.license,
+
+      // Exports
+
+      // Dependencies
+      dependencies: {
+        norska: nodeConfig.norskaVersion,
+        'norska-theme-docs': nodeConfig.norskaThemeDocsVersion,
+      },
+      devDependencies: {},
+
+      // Scripts
+      scripts: sharedProjectData.scripts,
+    };
+    await writeJson(packageContent, helper.hostPath('./docs/package.json'), {
+      sort: false,
+    });
+  },
+  /**
+   * Create the lib workspace
+   **/
+  async createLibWorkspace() {
+    const sharedProjectData = await this.getSharedProjectData();
+
+    const packageContent = {
+      // Visibility
+      private: false,
+
+      // Name and version
+      name: sharedProjectData.name,
+      version: '0.0.1',
+
+      // Metadata
+      author: sharedProjectData.author,
+      description: '',
+      keywords: [],
+      repository: sharedProjectData.repository,
+      homepage: sharedProjectData.homepage,
+
+      // Compatibility
+      type: 'module',
+      license: sharedProjectData.license,
+      engines: sharedProjectData.engines,
+
+      // Exports
+      files: ['*.js'],
+      exports: {
+        '.': './main.js',
+      },
+      main: './main.js',
+
+      // Dependencies
+      dependencies: {},
+      devDependencies: {},
+
+      // Scripts
+      scripts: sharedProjectData.scripts,
+    };
+    await writeJson(packageContent, helper.hostPath('./lib/package.json'), {
+      sort: false,
+    });
   },
   /**
    * Add config files to the host. Each config files reference the default
@@ -52,6 +198,9 @@ export default {
     // Yarn
     await this.copyToHost('templates/_yarnrc.yml', '.yarnrc.yml');
 
+    // Lerna
+    await this.copyToHost('templates/lerna.json', 'lerna.json');
+
     // ESLint
     await this.copyToHost('templates/_eslintrc.cjs', '.eslintrc.cjs');
     await this.copyToHost('templates/_eslintignore.conf', '.eslintignore');
@@ -87,198 +236,162 @@ export default {
     );
   },
   /**
-   * Add scripts entry to the host package.json with specified command.
-   * @param {string} scriptName Script name
-   * @param {string} scriptPath Path to the script to run, must be a path
-   * relative to the templates/ directory
-   * @returns {boolean} False if can't add entry, true otherwise
+   * Add default script files
    **/
-  async addPackageScript(scriptName, scriptPath) {
-    const packagePath = helper.hostPath('package.json');
-    const currentPackage = await readJson(packagePath);
-    const currentScripts = _.get(currentPackage, 'scripts', {});
-
-    if (currentScripts[scriptName]) {
-      return false;
-    }
-
-    await this.copyToHost(`./templates/${scriptPath}`, scriptPath);
+  async addScripts() {
+    // Docs
+    await this.copyToHost('templates/scripts/docs/build', 'scripts/docs/build');
+    await this.copyToHost(
+      'templates/scripts/docs/build-prod',
+      'scripts/docs/build-prod',
+    );
+    await this.copyToHost('templates/scripts/docs/cms', 'scripts/docs/cms');
+    await this.copyToHost('templates/scripts/docs/serve', 'scripts/docs/serve');
 
-    const newPackage = _.set(
-      _.clone(currentPackage),
-      `scripts.${scriptName}`,
-      `./${scriptPath}`,
+    // Hooks
+    await this.copyToHost(
+      './templates/scripts/hooks/pre-commit',
+      './scripts/hooks/pre-commit',
     );
-    await writeJson(newPackage, packagePath);
-    return true;
-  },
-  /**
-   * Add default scripts to the package.json scripts entry and copy scripts to
-   * ./scripts if needed
-   **/
-  async addScripts() {
-    const defaultScripts = [
-      { key: 'ci', value: 'scripts/ci' },
-      { key: 'compress', value: 'scripts/compress' },
-      { key: 'lint', value: 'scripts/lint' },
-      { key: 'lint:fix', value: 'scripts/lint-fix' },
-      { key: 'release', value: 'scripts/release' },
-      { key: 'test', value: 'scripts/test' },
-      { key: 'test:watch', value: 'scripts/test-watch' },
-    ];
-
-    await pMapSeries(defaultScripts, async (script) => {
-      await this.addPackageScript(script.key, script.value);
-    });
-  },
-  /**
-   * Update package.json with .main and .files keys to use files in ./lib
-   * directory by default
-   * TODO: Update this to use exports instead of main
-   **/
-  async setDefaultReleaseFiles() {
-    const packagePath = helper.hostPath('package.json');
-    const currentPackage = await readJson(packagePath);
-
-    // Update .main
-    const currentMain = currentPackage.main;
-    const currentMainIsDefault = currentMain === 'index.js';
-    if (!currentMain || currentMainIsDefault) {
-      currentPackage.main = 'lib/main.js';
-      await this.copyToHost('templates/lib/main.js', 'lib/main.js');
-      await this.copyToHost(
-        'templates/lib/__tests__/main.js',
-        'lib/__tests__/main.js',
-      );
-    }
 
-    const currentFiles = currentPackage.files;
-    const currentFilesIsEmpty = _.isEmpty(currentFiles);
-    if (!currentFiles || currentFilesIsEmpty) {
-      currentPackage.files = ['lib/*.js'];
-    }
+    // Lib
+    await this.copyToHost(
+      'templates/scripts/lib/release',
+      'scripts/lib/release',
+    );
+    await this.copyToHost('templates/scripts/lib/test', 'scripts/lib/test');
+    await this.copyToHost(
+      'templates/scripts/lib/test-watch',
+      'scripts/lib/test-watch',
+    );
 
-    await writeJson(currentPackage, packagePath);
+    // Common
+    await this.copyToHost('templates/scripts/ci', 'scripts/ci');
+    await this.copyToHost('templates/scripts/compress', 'scripts/compress');
+    await this.copyToHost('templates/scripts/lint', 'scripts/lint');
+    await this.copyToHost('templates/scripts/lint-fix', 'scripts/lint-fix');
   },
   /**
-   * Add an MIT LICENSE file to the repository
+   * Add MIT license files to the repository
    **/
-  async addLicenseFile() {
-    const licensePath = helper.hostPath('LICENSE');
-
-    if (await exists(licensePath)) {
-      return;
-    }
-
-    const template = await read(helper.aberlaasPath('./templates/LICENSE'));
-    const currentPackage = await readJson(helper.hostPath('package.json'));
+  async addLicenseFiles() {
+    // Add the LICENSE template to the root
+    await this.copyToHost('templates/LICENSE', 'LICENSE');
 
-    const content = _.replace(template, '{author}', currentPackage.author);
+    // Replace placeholder with real value
+    const sharedProjectData = await this.getSharedProjectData();
+    const licensePath = helper.hostPath('LICENSE');
+    const templateContent = await read(licensePath);
+    const actualContent = _.replace(
+      templateContent,
+      '{author}',
+      sharedProjectData.author,
+    );
 
-    await write(content, licensePath);
+    // Write the LICENSE to root and lib
+    await write(actualContent, licensePath);
+    await write(actualContent, helper.hostPath('lib/LICENSE'));
   },
   /**
-   * Sets license to MIT in package.json
+   * Add default files required to have the minimum lib module
    **/
-  async addLicenseField() {
-    const packagePath = helper.hostPath('package.json');
-    const currentPackage = await readJson(packagePath);
-
-    if (currentPackage.license) {
-      return;
-    }
-
-    const newPackage = {
-      ...currentPackage,
-      license: 'MIT',
-    };
-
-    await writeJson(newPackage, packagePath);
+  async addLibFiles() {
+    await this.copyToHost('templates/lib/main.js', 'lib/main.js');
+    await this.copyToHost(
+      'templates/lib/__tests__/main.js',
+      'lib/__tests__/main.js',
+    );
   },
   /**
-   * Sets a default 0.0.1 version if none is defined
+   * Copy a config template to the host
+   * @param {string} source Path to source file, relative to aberlaas
+   * @param {string} destination Path to destination file, relative to the host
+   * @returns {boolean} False if can't copy file, true otherwise
    **/
-  async addDefaultVersion() {
-    const packagePath = helper.hostPath('package.json');
-    const currentPackage = await readJson(packagePath);
+  async copyToHost(source, destination) {
+    const absoluteSource = helper.aberlaasPath(source);
+    const absoluteDestination = helper.hostPath(destination);
 
-    if (currentPackage.version) {
-      return;
+    // Source file does not exist
+    if (!(await isFile(absoluteSource))) {
+      throw firostError(
+        'ERROR_INIT_COPY_FILE',
+        `Unable to locate ${absoluteSource} file`,
+      );
     }
-
-    const newPackage = {
-      ...currentPackage,
-      version: '0.0.1',
-    };
-
-    await writeJson(newPackage, packagePath);
-  },
-  /**
-   * Sets the minimum node version to run this module
-   * Which is the same version it has been tested on
-   **/
-  async addEngineNodeVersion() {
-    const packagePath = helper.hostPath('package.json');
-    const currentPackage = await readJson(packagePath);
-
-    if (_.has(currentPackage, 'engines')) {
-      return;
+    // Destination file already exist
+    if (await isFile(absoluteDestination)) {
+      // Do nothing if content is already the same
+      const sourceContent = await read(absoluteSource);
+      const destinationContent = await read(absoluteDestination);
+      if (sourceContent === destinationContent) {
+        return true;
+      }
+
+      // Otherwise create a backup
+      const backupDestination = `${absoluteDestination}.backup`;
+      await move(absoluteDestination, backupDestination);
     }
 
-    const newPackage = {
-      ...currentPackage,
-      engines: {
-        node: `>=${nodeConfig.nodeVersion}`,
-      },
-    };
+    await copy(absoluteSource, absoluteDestination);
 
-    await writeJson(newPackage, packagePath);
+    return true;
   },
   /**
-   * Sets the dirname as package name if none is defined
+   * Return name of the current project based on the GitHub project name
+   * @returns {string} Name of the project
    **/
-  async addDefaultName() {
-    const packagePath = helper.hostPath('package.json');
-    const currentPackage = await readJson(packagePath);
-
-    if (currentPackage.name) {
-      return;
-    }
-
-    const newPackage = {
-      ...currentPackage,
-      name: path.basename(helper.hostPath()),
-    };
-
-    await writeJson(newPackage, packagePath);
+  async getProjectName() {
+    const repo = new Gilmore(helper.hostRoot());
+    return await repo.githubRepoName();
   },
   /**
-   * Pin the node version through nvm and yarn through yarnrc
-   * This allows us to run the same version locally as we do in CI
+   * Return the name of the current author based on the GitHub project owner
+   * @returns {string} Name of the author
    **/
-  async pinNodeAndYarn() {
-    // Set .nvmrc
-    const nvmrcPath = helper.hostPath('.nvmrc');
-    await write(nodeConfig.nodeVersion, nvmrcPath);
-
-    // Download latest yarn version
-    await this.__run(`yarn set version ${nodeConfig.yarnVersion}`, {
-      stdout: false,
-    });
+  async getProjectAuthor() {
+    const repo = new Gilmore(helper.hostRoot());
+    return await repo.githubRepoOwner();
   },
   /**
-   * Configure git hooks to use scripts/hooks instead of .git/hooks
+   * Returns shared project data, like name, author, scripts, etc
+   * @returns {object} Object of common keys
    **/
-  async configureGitHooks() {
-    // Copy the scripts into ./scripts/hooks
-    await this.copyToHost(
-      './templates/scripts/hooks/pre-commit',
-      './scripts/hooks/pre-commit',
-    );
-
-    // Configure git to use this directory for hooks
-    const repo = new Gilmore(helper.hostRoot());
-    await repo.setConfig('core.hooksPath', 'scripts/hooks');
+  async getSharedProjectData() {
+    const name = await this.getProjectName();
+    const author = await this.getProjectAuthor();
+    const homepage = `https://projects.pixelastic.com/${name}`;
+    const repository = `${author}/${name}`;
+    const license = 'MIT';
+    const engines = {
+      node: `>=${nodeConfig.nodeVersion}`,
+    };
+    const scripts = {
+      // Docs
+      build: 'ABERLAAS_CWD=$INIT_CWD yarn g:build',
+      'build:prod': 'ABERLAAS_CWD=$INIT_CWD yarn g:build:prod',
+      cms: 'ABERLAAS_CWD=$INIT_CWD yarn g:cms',
+      serve: 'ABERLAAS_CWD=$INIT_CWD yarn g:serve',
+
+      // Lib
+      release: 'ABERLAAS_CWD=$INIT_CWD yarn g:release',
+      test: 'ABERLAAS_CWD=$INIT_CWD yarn g:test',
+      'test:watch': 'ABERLAAS_CWD=$INIT_CWD yarn g:test:watch',
+
+      // Common
+      compress: 'ABERLAAS_CWD=$INIT_CWD yarn g:compress',
+      lint: 'ABERLAAS_CWD=$INIT_CWD yarn g:lint',
+      'lint:fix': 'ABERLAAS_CWD=$INIT_CWD yarn g:lint:fix',
+    };
+    return {
+      author,
+      engines,
+      homepage,
+      license,
+      name,
+      repository,
+      scripts,
+    };
   },
   /**
    * Copy all config files and configure the scripts
@@ -286,34 +399,26 @@ export default {
   async run() {
     const progress = spinner();
 
-    progress.tick('Configuring Git');
+    progress.tick('Configuring Git & Node');
     await this.configureGit();
+    await this.configureNode();
 
-    progress.tick('Pinning node and yarn versions');
-    await this.pinNodeAndYarn();
-    await this.addEngineNodeVersion();
+    progress.tick('Configuring workspaces');
+    await this.createRootWorkspace();
+    await this.createDocsWorkspace();
+    await this.createLibWorkspace();
 
-    progress.tick('Adding config files');
+    progress.tick('Adding files');
+    await this.addLicenseFiles();
     await this.addConfigFiles();
-
-    progress.tick('Adding yarn scripts');
     await this.addScripts();
-
-    progress.tick('Updating LICENSE');
-    await this.addLicenseFile();
-    await this.addLicenseField();
-
-    progress.tick('Setting default version');
-    await this.addDefaultVersion();
-
-    progress.tick('Setting default name');
-    await this.addDefaultName();
-
-    progress.tick('Setting default release files');
-    await this.setDefaultReleaseFiles();
+    await this.addLibFiles();
 
     progress.success('aberlaas project initialized');
 
+    this.__consoleInfo('Synchronizing dependencies');
+    await run('yarn install');
+
     this.__consoleInfo(
       "Don't forget to run aberlaas setup after pushing your repository",
     );

package/commands/lint/index.js

@@ -30,9 +30,10 @@ export default {
     await pMap(typesToLint, async (type) => {
       const methodName = cliArgs.fix ? 'fix' : 'run';
       try {
+        const linter = this.linters[type];
+
         const configFile = _.get(cliArgs, `config.${type}`);
         const userPatterns = _.get(cliArgs, '_');
-        const linter = this.linters[type];
 
         await linter[methodName](userPatterns, configFile);
       } catch (error) {

package/commands/test/index.js

@@ -1,4 +1,4 @@
-import { createVitest } from 'vitest/node';
+import { createVitest, registerConsoleShortcuts } from 'vitest/node';
 import helper from '../../helper.js';
 import firostError from 'firost/error.js';
 import _ from 'golgoth/lodash.js';
@@ -22,10 +22,16 @@ export default {
 
     const vitest = await createVitest('test', options);
 
+    // Enable keyboard interaction in watch mode
+    if (options.watch) {
+      registerConsoleShortcuts(vitest);
+    }
+
     // Note: vitest sets process.exitCode to 1 if tests fail
     const initialExitCode = process.exitCode;
     await vitest.start(files);
 
+    // Close vitest if not watching files
     if (!options.watch) {
       await vitest.close();
     }

package/configs/eslint.cjs

@@ -19,8 +19,8 @@ module.exports = {
   ],
   settings: {
     // eslint-plugin-import doesn't currently support the "exports" syntax in
-    // package.json. This allow mapping between custom entrypoints and
-    // files on disk.
+    // package.json. This is supposed to allow mapping between custom
+    // entrypoints and files on disk.
     // For example, it doesn't understand "import * from 'vitest/config';" as
     // "vitest/config/" isn't really an existing filepath, but a mapping defined
     // in vitest package.json
@@ -61,6 +61,11 @@ module.exports = {
         property: 'export',
         message: 'Typo: Use module.exports instead',
       },
+      {
+        object: '_',
+        property: 'contains',
+        message: 'Typo: Use _.includes instead',
+      },
     ],
     'no-unused-vars': [
       'error',

package/configs/node.cjs

@@ -3,4 +3,7 @@
 module.exports = {
   nodeVersion: '18.18.0', // Also see templates/_circleci/config.yml
   yarnVersion: '4.0.2',
+  norskaVersion: '2.9.0',
+  norskaThemeDocsVersion: '5.0.3',
+  lernaVersion: '4.0.0',
 };

package/helper.js

@@ -1,6 +1,5 @@
 import path from 'path';
 import _ from 'golgoth/lodash.js';
-import run from 'firost/run.js';
 import glob from 'firost/glob.js';
 import exists from 'firost/exists.js';
 import findUp from 'find-up';
@@ -151,14 +150,6 @@ export default {
     }
     return false;
   },
-  /**
-   * Run a specific script through yarn run
-   * @param {string} scriptName Name of the script to run
-   * @returns {object} Result of the run, including .sterr and .stdout
-   **/
-  async yarnRun(scriptName) {
-    return await run(`yarn run ${scriptName}`, { cwd: this.hostRoot() });
-  },
   /**
    * Dynamically import a file
    * This is a wrapper around the default import, but bypasses the cache

package/main.js

@@ -1,7 +1,10 @@
 import minimist from 'minimist';
 import consoleError from 'firost/consoleError.js';
 import exit from 'firost/exit.js';
+import env from 'firost/env.js';
+import absolute from 'firost/absolute.js';
 import _ from 'golgoth/lodash.js';
+import path from 'path';
 import commandCi from './commands/ci/index.js';
 import commandCompress from './commands/compress/index.js';
 import commandInit from './commands/init/index.js';
@@ -28,6 +31,30 @@ export default {
       test: commandTest,
     };
   },
+  /**
+   * Converts a list of filepaths to absolute filepaths
+   * Note: We want to be able to call commands like "aberlaas lint" from the
+   * workspace root or any child workspace. We also want to be able to use
+   * relative or absolute filepaths as arguments.
+   * INIT_CWD is always set to the directory where the command was called, but
+   * because scripts in child workspaces are actually calling scripts in the
+   * root workspace, that value is overwritten. This is why we save the original
+   * calling directory in ABERLAAS_CWD, and use that value if available.
+   * @param {Array} filepaths Array of filepaths
+   * @returns {Array} Array of absolute filepaths
+   **/
+  convertFilepathsToAbsolute(filepaths) {
+    const callingDirectory =
+      this.__env('ABERLAAS_CWD') || this.__env('INIT_CWD');
+    return _.map(filepaths, (inputFilepath) => {
+      const filepath =
+        inputFilepath[0] == '/'
+          ? inputFilepath
+          : path.resolve(callingDirectory, inputFilepath);
+
+      return absolute(filepath);
+    });
+  },
   /**
    * Run the command specified on the command-line, along with specific
    * arguments
@@ -49,6 +76,9 @@ export default {
     // Remove the initial method from args passed to the command
     args._ = _.drop(args._, 1);
 
+    // Make all filepaths absolute
+    args._ = this.convertFilepathsToAbsolute(args._);
+
     try {
       await command.run(args);
     } catch (err) {
@@ -56,6 +86,7 @@ export default {
       this.__exit(1);
     }
   },
+  __env: env,
   __consoleError: consoleError,
   __exit: exit,
 };

package/package.json

@@ -2,16 +2,13 @@
   "name": "aberlaas",
   "type": "module",
   "description": "Scaffold your JavaScript projects with tests, lint and release scripts",
-  "version": "2.3.0",
+  "version": "2.5.0",
   "repository": "pixelastic/aberlaas",
   "homepage": "https://projects.pixelastic.com/aberlaas/",
   "author": "Tim Carry (@pixelastic)",
   "license": "MIT",
   "files": [
     "bin/",
-    "lib/",
-    "scripts/",
-    "*.js",
     "commands/ci/*.js",
     "commands/compress/*.js",
     "commands/init/*.js",
@@ -19,61 +16,66 @@
     "commands/lint/helpers/*.js",
     "commands/precommit/*.js",
     "commands/readme/*.js",
-    "commands/release/*.js",
     "commands/setup/*.js",
     "commands/setup/helpers/*.js",
     "commands/test/*.js",
     "configs/",
-    "templates/"
+    "scripts/",
+    "templates/",
+    "*.js"
   ],
   "exports": {
     ".": "./main.js",
+    "./configs/vite": "./configs/vite.js",
     "./configs/lintstaged": "./configs/lintstaged.js",
     "./configs/prettier": "./configs/prettier.js",
     "./configs/stylelint": "./configs/stylelint.js"
   },
+  "main": "./main.js",
   "bin": "bin/aberlaas.js",
   "dependencies": {
     "@octokit/rest": "18.12.0",
     "ci-info": "3.9.0",
     "dedent": "1.5.1",
-    "eslint": "8.56.0",
-    "eslint-config-prettier": "9.0.0",
-    "eslint-plugin-import": "2.29.0",
-    "eslint-plugin-jsdoc": "46.9.0",
-    "eslint-plugin-n": "16.3.1",
-    "eslint-plugin-prettier": "5.0.1",
-    "eslint-plugin-vitest": "0.3.10",
+    "eslint": "8.57.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-jsdoc": "46.10.1",
+    "eslint-plugin-n": "16.6.2",
+    "eslint-plugin-prettier": "5.1.3",
+    "eslint-plugin-vitest": "0.3.22",
     "eslint-plugin-vitest-globals": "1.4.0",
     "find-up": "5.0.0",
     "firost": "3.1.0",
     "front-matter": "4.0.2",
-    "gilmore": "0.1.0",
+    "gilmore": "0.2.0",
     "golgoth": "2.1.0",
     "jest-extended": "4.0.2",
     "lint-staged": "11.2.6",
     "minimist": "1.2.8",
     "np": "7.7.0",
     "parse-github-repo-url": "1.4.1",
-    "prettier": "3.1.0",
+    "prettier": "3.2.5",
     "std-mocks": "1.0.1",
     "stylelint": "13.13.1",
-    "vitest": "1.0.4",
+    "vitest": "1.3.1",
     "yaml-lint": "1.7.0"
   },
   "engines": {
     "node": ">=18"
   },
   "scripts": {
-    "build": "../scripts/docs/build",
-    "build:prod": "../scripts/docs/build-prod",
-    "lint": "../scripts/lib/lint",
-    "lint:fix": "../scripts/lib/lint-fix",
-    "release": "../scripts/release",
-    "serve": "../scripts/docs/serve",
-    "test": "../scripts/lib/test",
-    "test:watch": "../scripts/lib/test-watch",
+    "build": "ABERLAAS_CWD=$INIT_CWD yarn g:build",
+    "build:prod": "ABERLAAS_CWD=$INIT_CWD yarn g:build:prod",
+    "cms": "ABERLAAS_CWD=$INIT_CWD yarn g:cms",
+    "serve": "ABERLAAS_CWD=$INIT_CWD yarn g:serve",
+    "release": "ABERLAAS_CWD=$INIT_CWD yarn g:release",
+    "test": "ABERLAAS_CWD=$INIT_CWD yarn g:test",
+    "test:watch": "ABERLAAS_CWD=$INIT_CWD yarn g:test:watch",
+    "compress": "ABERLAAS_CWD=$INIT_CWD yarn g:compress",
+    "lint": "ABERLAAS_CWD=$INIT_CWD yarn g:lint",
+    "lint:fix": "ABERLAAS_CWD=$INIT_CWD yarn g:lint:fix",
     "postinstall": "./scripts/postinstall"
   },
-  "gitHead": "cca93623a1219558bd311aefde796d75d6790009"
+  "gitHead": "d8c221450f847e80e4b86783b9291f3e02239a45"
 }

package/templates/_gitattributes

@@ -1,3 +1,4 @@
-# Yarn
-/.yarn/releases/** binary
-/.yarn/plugins/** binary
+/.yarn/**            linguist-vendored
+/.yarn/releases/*    binary
+/.yarn/plugins/**/*  binary
+/.pnp.*              binary linguist-generated

package/templates/_gitignore

@@ -10,6 +10,7 @@ tmp/
 
 # Files
 Thumbs.db
+lerna-debug.log
 npm-debug.log
 yarn-error.log
 *~

package/templates/_yarnrc.yml

@@ -4,6 +4,12 @@ defaultSemverRangePrefix: ''
 
 enableGlobalCache: true
 
+# Keep old-school saving of dependencies in node_modules
+# This makes debugging imported modules so much easier
+nodeLinker: node-modules
+
+# Use hardlinks to a global cache
 nmMode: hardlinks-local
 
-nodeLinker: node-modules
+# Make sure each workspace has its own local node_modules
+nmHoistingLimits: workspaces

package/templates/lerna.json

@@ -0,0 +1,6 @@
+{
+  "version": "0.0.1",
+  "useWorkspaces": true,
+  "packages": ["lib", "docs"],
+  "npmClient": "yarn"
+}

package/templates/lib/__tests__/main.js

@@ -1,11 +1,13 @@
 import current from '../main.js';
 
-describe('current', () => {
-  it('should do something', async () => {
-    const input = 'foo';
+describe('main', () => {
+  describe('run', () => {
+    it('should pass', async () => {
+      const input = 'something';
 
-    const actual = current.run(input);
+      const actual = current.run(input);
 
-    expect(actual).toBe(true);
+      expect(actual).toBe('something');
+    });
   });
 });

package/templates/lib/main.js

@@ -1,5 +1,5 @@
 export default {
-  run() {
-    return true;
+  run(input) {
+    return input;
   },
 };

package/templates/scripts/ci

@@ -1,4 +1,6 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 set -e
 
+echo "node $(node --version), yarn $(yarn --version)"
+
 aberlaas ci "$@"

package/templates/scripts/compress

@@ -1,4 +1,4 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 set -e
 
-aberlaas compress "$@"
+aberlaas compress "${@:-$INIT_CWD}"

package/templates/scripts/docs/build

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+echo "TODO: Set a default script"

package/templates/scripts/docs/build-prod

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+echo "TODO: Set a default script"

package/templates/scripts/docs/cms

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+echo "TODO: Set a default script"

package/templates/scripts/docs/serve

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+echo "TODO: Set a default script"

package/templates/scripts/lib/release

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -e
+
+yarn run test
+lerna publish --yes "$@"

package/templates/scripts/lib/test

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+aberlaas test "${@:-./lib}"

package/templates/scripts/lib/test-watch

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+aberlaas test --watch "${@:-./lib}"

package/templates/scripts/lint

@@ -1,4 +1,4 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 set -e
 
-aberlaas lint "$@"
+aberlaas lint "${@:-$INIT_CWD}"

package/templates/scripts/lint-fix

@@ -1,4 +1,4 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 set -e
 
-aberlaas lint "$@" --fix
+aberlaas lint --fix "${@:-$INIT_CWD}"

package/templates/vite.config.js

@@ -1,4 +1,4 @@
-import viteConfig from 'aberlaas/configs/vite.js';
+import config from 'aberlaas/configs/vite';
 export default {
-  ...viteConfig,
+  ...config,
 };

package/templates/scripts/release

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-set -e
-
-aberlaas release "$@"

package/templates/scripts/test

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-set -e
-
-aberlaas test "$@"

package/templates/scripts/test-watch

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-set -e
-
-aberlaas test "$@" --watch