aberlaas 2.8.0 → 2.10.0

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();
-  },
-};

package/commands/lint/css.js

@@ -1,73 +0,0 @@
-import stylelint from 'stylelint';
-import { _ } from 'golgoth';
-import { firostError, firostImport } from 'firost';
-import helper from '../../helper.js';
-import { fix as prettierFix } from './helpers/prettier.js';
-
-export default {
-  /**
-   * Find all relevant files
-   * @param {Array} userPatterns Patterns to narrow the search down
-   * @returns {Array} Array of files
-   **/
-  async getInputFiles(userPatterns) {
-    const filePatterns = _.isEmpty(userPatterns)
-      ? ['./**/*.css']
-      : userPatterns;
-    return await helper.findHostFiles(filePatterns, ['.css']);
-  },
-  /**
-   * Lint all files and display results.
-   * @param {Array} userPatterns Patterns to narrow the search down
-   * @param {string} userConfigFile Custom config file to use
-   * @param {object} userOptions Options to pass to ESLint, including fix
-   * @returns {boolean} True on success
-   **/
-  async run(userPatterns, userConfigFile, userOptions = {}) {
-    // Options
-    const options = { fix: false, ...userOptions };
-
-    // Files
-    const files = await this.getInputFiles(userPatterns);
-    if (_.isEmpty(files)) {
-      return true;
-    }
-
-    // Config
-    const configFile = await helper.configFile(
-      userConfigFile,
-      'stylelint.config.js',
-      'configs/stylelint.js',
-    );
-    const config = await firostImport(configFile);
-
-    const result = await stylelint.lint({
-      config,
-      files,
-      formatter: 'string',
-      ...options,
-    });
-
-    if (result.errored) {
-      throw firostError('ERROR_CSS_LINT', result.output);
-    }
-    return true;
-  },
-  /**
-   * Autofix files in place
-   * @param {Array} userPatterns Patterns to narrow the search down
-   * @param {string} userConfigFile Custom config file to use
-   * @returns {boolean} True on success
-   **/
-  async fix(userPatterns, userConfigFile) {
-    const files = await this.getInputFiles(userPatterns);
-    if (_.isEmpty(files)) {
-      return true;
-    }
-    // Try to pretiffy as much as we can
-    await prettierFix(files);
-    // Still run a lint on it so it can fail if not everything is fixed
-    await this.run(userPatterns, userConfigFile, { fix: true });
-    return true;
-  },
-};

package/commands/lint/helpers/prettier.js

@@ -1,54 +0,0 @@
-import * as prettier from 'prettier';
-import { firostError, read, write } from 'firost';
-import { _, pMap } from 'golgoth';
-import helper from '../../../helper.js';
-
-/**
- * Fix all files using prettier
- * @param {Array} inputFiles Files to auto-fix
- **/
-export async function fix(inputFiles) {
-  // Config file
-  const configFile = await helper.configFile(
-    null,
-    'prettier.config.js',
-    'configs/prettier.js',
-  );
-  const config = await prettier.resolveConfig(configFile);
-
-  const errors = [];
-
-  // Read all files, run them through the formatter and save them back to disk
-  // If any emits error, store the errors and display them all in one output
-  await pMap(
-    inputFiles,
-    async (filepath) => {
-      try {
-        const content = await read(filepath);
-        const options = { ...config, filepath };
-        const result = await prettier.format(content, options);
-        await write(result, filepath);
-      } catch (error) {
-        const message = error.toString();
-        errors.push({ filepath, message });
-      }
-    },
-    { concurrency: 10 },
-  );
-
-  if (!_.isEmpty(errors)) {
-    let formattedErrors = '';
-    _.each(errors, (error) => {
-      formattedErrors = `${formattedErrors}${error.filepath}\n\n${error.message}\n\n`;
-    });
-
-    throw firostError(
-      'LINT_ERROR_FIX_PRETTIER',
-      `Some files could not be automatically fixed:\n\n${formattedErrors}`,
-    );
-  }
-}
-
-export default {
-  fix,
-};

package/commands/lint/index.js

@@ -1,50 +0,0 @@
-import { _, pMap } from 'golgoth';
-import { consoleError, firostError } from 'firost';
-import linterCircleCI from './circleci.js';
-import linterCss from './css.js';
-import linterJson from './json.js';
-import linterJs from './js.js';
-import linterYml from './yml.js';
-
-export default {
-  linters: {
-    circleci: linterCircleCI,
-    css: linterCss,
-    json: linterJson,
-    js: linterJs,
-    yml: linterYml,
-  },
-  /**
-   * Wrapper to lint all supported formats
-   * @param {object} cliArgs CLI Argument object, as created by minimist
-   * @returns {boolean} True on success
-   **/
-  async run(cliArgs = {}) {
-    const allTypesKeys = _.keys(this.linters);
-    const userTypes = _.intersection(_.keys(cliArgs), allTypesKeys);
-    const typesToLint = _.isEmpty(userTypes) ? allTypesKeys : userTypes;
-
-    let hasErrors = false;
-    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, '_');
-
-        await linter[methodName](userPatterns, configFile);
-      } catch (error) {
-        this.__consoleError(error.message);
-        hasErrors = true;
-      }
-    });
-
-    if (hasErrors) {
-      throw firostError('ERROR_LINT', 'Error while linting files');
-    }
-
-    return true;
-  },
-  __consoleError: consoleError,
-};