aberlaas 2.9.0 → 2.11.0

package/commands/init/helper.js

@@ -1,192 +0,0 @@
-import path from 'path';
-import Gilmore from 'gilmore';
-import { copy, error as firostError, isFile, move, read, write } from 'firost';
-import { _ } from 'golgoth';
-import helper from '../../helper.js';
-import nodeConfig from '../../configs/node.cjs';
-
-/**
- * This hold functions shared for both the monorepo and simple init scenarios
- **/
-export default {
-  /**
-   * Return name of the current project, as the name of the current directory
-   * @returns {string} Name of the project
-   **/
-  getProjectName() {
-    return path.basename(helper.hostRoot());
-  },
-
-  /**
-   * Return the name of the current author based on the GitHub project owner
-   * @returns {string} Name of the author, or __placeholder__ if undefined
-   **/
-  async getProjectAuthor() {
-    const repo = this.__getRepo();
-    return (await repo.githubRepoOwner()) || '__placeholder__';
-  },
-
-  /**
-   * 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 copyToHost(source, destination) {
-    const absoluteSource = helper.aberlaasPath(source);
-    const absoluteDestination = helper.hostPath(destination);
-
-    // Source file does not exist
-    if (!(await isFile(absoluteSource))) {
-      throw firostError(
-        'ERROR_INIT_COPY_FILE',
-        `Unable to locate ${absoluteSource} file`,
-      );
-    }
-    // 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);
-    }
-
-    await copy(absoluteSource, absoluteDestination);
-
-    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.copyToHost('templates/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');
-
-    // Start by adding a template
-    await this.copyToHost('templates/_circleci/config.yml', configFilepath);
-
-    // Replace placeholder with real value
-    const templateContent = await read(configFilepath);
-    const actualContent = _.chain(templateContent)
-      .replace('{nodeVersion}', nodeConfig.nodeVersion)
-      .replace('{yarnVersion}', nodeConfig.yarnVersion)
-      .value();
-
-    // Write it again
-    await write(actualContent, configFilepath);
-  },
-
-  /**
-   * Add default script files
-   **/
-  async addScripts() {
-    // 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');
-
-    // Hooks
-    await this.copyToHost(
-      './templates/scripts/hooks/pre-commit',
-      './scripts/hooks/pre-commit',
-    );
-
-    // 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',
-    );
-  },
-
-  /**
-   * 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.copyToHost('./templates/_gitignore', './.gitignore');
-    await this.copyToHost('./templates/_gitattributes', './.gitattributes');
-
-    // Yarn
-    await this.copyToHost('templates/_yarnrc.yml', '.yarnrc.yml');
-
-    // ESLint
-    await this.copyToHost('templates/_eslintrc.cjs', '.eslintrc.cjs');
-    await this.copyToHost('templates/_eslintignore.conf', '.eslintignore');
-
-    // Lint-staged
-    await this.copyToHost(
-      'templates/lintstaged.config.js',
-      'lintstaged.config.js',
-    );
-
-    // Vite
-    await this.copyToHost('templates/vite.config.js', 'vite.config.js');
-
-    // Prettier
-    await this.copyToHost('templates/prettier.config.js', 'prettier.config.js');
-
-    // Stylelint
-    await this.copyToHost(
-      'templates/stylelint.config.js',
-      'stylelint.config.js',
-    );
-
-    // Renovate
-    await this.copyToHost(
-      'templates/_github/renovate.json',
-      '.github/renovate.json',
-    );
-
-    // CircleCI
-    await this.copyToHost(
-      'templates/_circleci/config.yml',
-      '.circleci/config.yml',
-    );
-  },
-
-  /**
-   * Add default files required to have the minimum lib module
-   **/
-  async addLibFiles() {
-    await this.copyToHost('templates/lib/main.js', 'lib/main.js');
-    await this.copyToHost(
-      'templates/lib/__tests__/main.js',
-      'lib/__tests__/main.js',
-    );
-  },
-  __getRepo() {
-    return new Gilmore(helper.hostRoot());
-  },
-};

package/commands/init/index.js

@@ -1,59 +0,0 @@
-import { consoleInfo, run, spinner, write } from 'firost';
-
-import Gilmore from 'gilmore';
-import helper from '../../helper.js';
-import nodeConfig from '../../configs/node.cjs';
-import initMonorepo from './monorepo.js';
-import initModule from './module.js';
-
-export default {
-  /**
-   * Configure git hooks to use scripts/hooks instead of .git/hooks
-   **/
-  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);
-  },
-  /**
-   * Run yarn install to install all deps
-   **/
-  async yarnInstall() {
-    await run('yarn install');
-  },
-  /**
-   * Copy all config files and configure the scripts
-   * @param {object} args Argument object, as passed by minimist
-   **/
-  async run(args = {}) {
-    const isMonorepo = args.monorepo;
-
-    const progress = this.__spinner();
-
-    progress.tick('Configuring Git & Node');
-    await this.configureGit();
-    await this.configureNode();
-
-    progress.tick('Adding default files ');
-
-    // Create a different scaffolding based on if creating a monorepo or not
-    isMonorepo ? await initMonorepo.run() : await initModule.run();
-
-    progress.success('aberlaas project initialized');
-
-    this.__consoleInfo('Synchronizing dependencies');
-    await this.yarnInstall();
-
-    this.__consoleInfo(
-      "Don't forget to run aberlaas setup after pushing your repository",
-    );
-  },
-  __consoleInfo: consoleInfo,
-  __spinner: spinner,
-};

package/commands/init/module.js

@@ -1,111 +0,0 @@
-import { readJson, writeJson } from 'firost';
-
-import helper from '../../helper.js';
-import nodeConfig from '../../configs/node.cjs';
-import initHelper from './helper.js';
-
-export default {
-  /**
-   * Create the top-level package.json
-   **/
-  async createPackageJson() {
-    // Get language and dependency version
-    const { version: aberlaasVersion } = await readJson(
-      helper.aberlaasPath('./package.json'),
-    );
-    const { nodeVersion, yarnVersion } = nodeConfig;
-
-    const name = await this.__getProjectName();
-    const version = '0.0.1';
-
-    const author = await this.__getProjectAuthor();
-    const description = '';
-    const keywords = [];
-    const repository = `${author}/${name}`;
-    const homepage = `https://projects.pixelastic.com/${name}`;
-
-    const type = 'module';
-    const license = 'MIT';
-    const engines = {
-      node: `>=${nodeVersion}`,
-    };
-    const packageManager = `yarn@${yarnVersion}`;
-
-    const files = ['*.js'];
-    const exports = {
-      '.': './main.js',
-    };
-    const main = './main.js';
-
-    const dependencies = {};
-    const devDependencies = {
-      aberlaas: aberlaasVersion,
-    };
-
-    const scripts = {
-      // Docs
-      build: './scripts/docs/build',
-      'build:prod': './scripts/docs/build-prod',
-      cms: './scripts/docs/cms',
-      serve: './scripts/docs/serve',
-      // Lib
-      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',
-    };
-
-    const packageContent = {
-      // Name and version
-      name,
-      version,
-
-      // Metadata
-      author,
-      description,
-      keywords,
-      repository,
-      homepage,
-
-      // Compatibility
-      type,
-      license,
-      engines,
-      packageManager,
-
-      // Exports
-      files,
-      exports,
-      main,
-
-      // Dependencies
-      dependencies,
-      devDependencies,
-
-      // Scripts
-      scripts,
-    };
-
-    await writeJson(packageContent, helper.hostPath('./package.json'), {
-      sort: false,
-    });
-  },
-
-  /**
-   * Scaffold a repo for use in a simple module contexte
-   **/
-  async run() {
-    await this.createPackageJson();
-
-    await initHelper.addLicenseFile('LICENSE');
-    await initHelper.addConfigFiles();
-    await initHelper.addScripts();
-    await initHelper.addLibFiles();
-  },
-  __getProjectName: initHelper.getProjectName.bind(initHelper),
-  __getProjectAuthor: initHelper.getProjectAuthor.bind(initHelper),
-};

package/commands/init/monorepo.js

@@ -1,261 +0,0 @@
-import { readJson, writeJson } from 'firost';
-
-import helper from '../../helper.js';
-import nodeConfig from '../../configs/node.cjs';
-import initHelper from './helper.js';
-
-export default {
-  /**
-   * Create the top-level monorepo root workspace
-   **/
-  async createRootWorkspace() {
-    const aberlaasData = await readJson(helper.aberlaasPath('./package.json'));
-    const sharedProjectData = await this.getSharedProjectData();
-
-    const packageContent = {
-      // Visibility
-      private: true,
-      workspaces: ['docs', 'lib'],
-
-      // Name and version
-      name: `${sharedProjectData.name}-monorepo`,
-      version: '0.0.1',
-
-      // 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 engines = {
-      node: `>=${nodeConfig.nodeVersion}`,
-    };
-
-    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,
-
-      // 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 MIT license files to the repository
-   **/
-  async addLicenseFiles() {
-    // One at the repo root, for GitHub
-    await initHelper.addLicenseFile('LICENSE');
-    // One in ./lib to be released with the module
-    await initHelper.addLicenseFile('lib/LICENSE');
-  },
-  /**
-   * Add config files
-   **/
-  async addConfigFiles() {
-    await initHelper.addConfigFiles();
-
-    // Lerna
-    await initHelper.copyToHost('templates/lerna.json', 'lerna.json');
-  },
-  /**
-   * Add scripts to the repo
-   **/
-  async addScripts() {
-    // Common scripts
-    await initHelper.addScripts('LICENSE');
-
-    // Docs scripts
-    await initHelper.copyToHost(
-      'templates/scripts/docs/build',
-      'scripts/docs/build',
-    );
-    await initHelper.copyToHost(
-      'templates/scripts/docs/build-prod',
-      'scripts/docs/build-prod',
-    );
-    await initHelper.copyToHost(
-      'templates/scripts/docs/cms',
-      'scripts/docs/cms',
-    );
-    await initHelper.copyToHost(
-      'templates/scripts/docs/serve',
-      'scripts/docs/serve',
-    );
-  },
-  /**
-   * 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 homepage = `https://projects.pixelastic.com/${name}`;
-    const repository = `${author}/${name}`;
-    const license = 'MIT';
-    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,
-      homepage,
-      license,
-      name,
-      repository,
-      scripts,
-    };
-  },
-  /**
-   * Scaffold a repo for use in a monorepo module contexte
-   **/
-  async run() {
-    await this.createRootWorkspace();
-    await this.createDocsWorkspace();
-    await this.createLibWorkspace();
-
-    await this.addLicenseFiles();
-    await this.addScripts();
-    await this.addConfigFiles();
-    await initHelper.addLibFiles();
-  },
-  __getProjectName: initHelper.getProjectName,
-  __getProjectAuthor: initHelper.getProjectAuthor.bind(initHelper),
-};

package/commands/lint/circleci.js

@@ -1,81 +0,0 @@
-import ciInfo from 'ci-info';
-import { exists, firostError, run, which } from 'firost';
-import helper from '../../helper.js';
-import lintYml from './yml.js';
-
-export default {
-  configPath: '.circleci/config.yml',
-  /**
-   * Find all relevant files
-   * @returns {Array} Array of files
-   **/
-  async getInputFiles() {
-    return await helper.findHostFiles([this.configPath]);
-  },
-  /**
-   * Check if the code is currently running on CircleCI
-   * @returns {boolean} True if running on CircleCI, false otherwise
-   **/
-  isRunningOnCircleCi() {
-    return ciInfo.CIRCLE;
-  },
-  /**
-   * Check if the circleci binary is available in the $PATH
-   * @returns {boolean} True if available, false otherwise
-   **/
-  async hasCircleCiBin() {
-    const binary = await which('circleci');
-    return !!binary;
-  },
-  /**
-   * Validate the CircleCI config file.
-   * @returns {boolean} True if valid, throws an error if not
-   **/
-  async validateConfig() {
-    await run('circleci config validate', { stdout: false });
-  },
-  /**
-   * Lint the file, both for yml issues and if possible circleci specifics
-   * @returns {boolean} True on success
-   **/
-  async run() {
-    const absoluteConfigPath = helper.hostPath(this.configPath);
-    const hasConfigFile = await exists(absoluteConfigPath);
-    const isRunningOnCircleCi = this.isRunningOnCircleCi();
-
-    // Stop early if no config file, or if running on CircleCI
-    if (!hasConfigFile || isRunningOnCircleCi) {
-      return true;
-    }
-
-    // Lint as yml first
-    await lintYml.run([absoluteConfigPath]);
-
-    // Stop early if no circleci bin available
-    if (!(await this.hasCircleCiBin())) {
-      return true;
-    }
-
-    // Validate the config
-    try {
-      await this.validateConfig();
-    } catch (error) {
-      const errorMessage = `CircleCI config error on ${this.configPath}\n${error.message}`;
-      throw firostError('CircleCiLintError', errorMessage);
-    }
-
-    return true;
-  },
-  /**
-   * Autofix yml issues in file
-   * @returns {boolean} True on success
-   **/
-  async fix() {
-    const absoluteConfigPath = helper.hostPath(this.configPath);
-    // Fix yml issues
-    await lintYml.fix([absoluteConfigPath]);
-
-    // Check for file errors so it still fails if file is invalid
-    await this.run();
-  },
-};