aberlaas-init 2.10.0 → 2.13.0

package/lib/{monorepo.js → layouts/libdocs.js}

@@ -2,20 +2,20 @@ import { writeJson } from 'firost';
 
 import helper from 'aberlaas-helper';
 import {
-  aberlaasVersion,
   lernaVersion,
   nodeVersion,
   norskaThemeDocsVersion,
   norskaVersion,
   yarnVersion,
 } from 'aberlaas-versions';
-import initHelper from './helper.js';
+import initHelper from '../helper.js';
 
 export default {
   /**
-   * Create the top-level monorepo root workspace
+   * Create the top-level workspace
    */
   async createRootWorkspace() {
+    const aberlaasVersion = this.__getAberlaasVersion();
     const sharedProjectData = await this.getSharedProjectData();
 
     const packageContent = {
@@ -24,12 +24,11 @@ export default {
       workspaces: ['docs', 'lib'],
 
       // Name and version
-      name: `${sharedProjectData.name}-monorepo`,
-      version: '0.0.1',
+      name: `${sharedProjectData.name}-root`,
 
       // Metadata
       author: sharedProjectData.author,
-      description: `${sharedProjectData.name} monorepo`,
+      description: `${sharedProjectData.name} root workspace`,
       repository: sharedProjectData.repository,
       homepage: sharedProjectData.homepage,
 
@@ -38,8 +37,6 @@ export default {
       license: sharedProjectData.license,
       packageManager: `yarn@${yarnVersion}`,
 
-      // Exports
-
       // Dependencies
       dependencies: {},
       devDependencies: {
@@ -49,35 +46,23 @@ export default {
 
       // 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',
+        // Docs
+        build: './scripts/meta/build',
+        'build:prod': './scripts/meta/build-prod',
+        cms: './scripts/meta/cms',
+        serve: './scripts/meta/serve',
+
+        // Lib
+        release: './scripts/meta/release',
+        test: './scripts/meta/test',
+        'test:watch': './scripts/meta/test-watch',
+        ci: './scripts/meta/ci',
+        compress: './scripts/meta/compress',
+        lint: './scripts/meta/lint',
+        'lint:fix': './scripts/meta/lint-fix',
+
+        // Typo
+        learn: 'lerna',
       },
     };
     await writeJson(packageContent, helper.hostPath('./package.json'), {
@@ -107,8 +92,6 @@ export default {
       // Compatibility
       license: sharedProjectData.license,
 
-      // Exports
-
       // Dependencies
       dependencies: {
         norska: norskaVersion,
@@ -149,6 +132,7 @@ export default {
 
       // Compatibility
       type: 'module',
+      sideEffects: false,
       license: sharedProjectData.license,
       engines,
 
@@ -188,28 +172,6 @@ export default {
     // Lerna
     await initHelper.copyTemplateToHost('lerna.json', 'lerna.json');
   },
-  /**
-   * Add scripts to the repo
-   */
-  async addScripts() {
-    // Common scripts
-    await initHelper.addScripts('LICENSE');
-
-    // Docs scripts
-    await initHelper.copyTemplateToHost(
-      'scripts/docs/build',
-      'scripts/docs/build',
-    );
-    await initHelper.copyTemplateToHost(
-      'scripts/docs/build-prod',
-      'scripts/docs/build-prod',
-    );
-    await initHelper.copyTemplateToHost('scripts/docs/cms', 'scripts/docs/cms');
-    await initHelper.copyTemplateToHost(
-      'scripts/docs/serve',
-      'scripts/docs/serve',
-    );
-  },
   /**
    * Returns shared project data, like name, author, scripts, etc
    * @returns {object} Object of common keys
@@ -221,21 +183,17 @@ export default {
     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',
+      build: '../scripts/local/build',
+      'build:prod': '../scripts/local/build-prod',
+      cms: '../scripts/local/cms',
+      serve: '../scripts/local/serve',
+      ci: '../scripts/local/ci',
+      release: '../scripts/local/release',
+      test: '../scripts/local/test',
+      'test:watch': '../scripts/local/test-watch',
+      compress: '../scripts/local/compress',
+      lint: '../scripts/local/lint',
+      'lint:fix': '../scripts/local/lint-fix',
     };
     return {
       author,
@@ -247,7 +205,9 @@ export default {
     };
   },
   /**
-   * Scaffold a repo for use in a monorepo module contexte
+   * Scaffold a repo:
+   * - As a monorepo
+   * - With ./libs and ./docs subfolders
    */
   async run() {
     await this.createRootWorkspace();
@@ -255,10 +215,11 @@ export default {
     await this.createLibWorkspace();
 
     await this.addLicenseFiles();
-    await this.addScripts();
     await this.addConfigFiles();
+    await initHelper.addScripts('__libdocs');
     await initHelper.addLibFiles();
   },
   __getProjectName: initHelper.getProjectName,
   __getProjectAuthor: initHelper.getProjectAuthor.bind(initHelper),
+  __getAberlaasVersion: initHelper.getAberlaasVersion,
 };

package/lib/{module.js → layouts/module.js}

@@ -1,14 +1,14 @@
 import { writeJson } from 'firost';
-
-import { aberlaasVersion, nodeVersion, yarnVersion } from 'aberlaas-versions';
+import { nodeVersion, yarnVersion } from 'aberlaas-versions';
 import helper from 'aberlaas-helper';
-import initHelper from './helper.js';
+import initHelper from '../helper.js';
 
 export default {
   /**
-   * Create the top-level package.json
+   * Create the package.json
    */
   async createPackageJson() {
+    const aberlaasVersion = this.__getAberlaasVersion();
     const name = await this.__getProjectName();
     const version = '0.0.1';
 
@@ -16,20 +16,21 @@ export default {
     const description = '';
     const keywords = [];
     const repository = `${author}/${name}`;
-    const homepage = `https://projects.pixelastic.com/${name}`;
+    const homepage = `https://github.com/${repository}`;
 
     const type = 'module';
+    const sideEffects = false;
     const license = 'MIT';
     const engines = {
       node: `>=${nodeVersion}`,
     };
     const packageManager = `yarn@${yarnVersion}`;
 
-    const files = ['*.js'];
+    const files = ['lib/*.js'];
     const exports = {
-      '.': './main.js',
+      '.': './lib/main.js',
     };
-    const main = './main.js';
+    const main = './lib/main.js';
 
     const dependencies = {};
     const devDependencies = {
@@ -37,20 +38,13 @@ export default {
     };
 
     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',
+      test: './scripts/test',
+      'test:watch': './scripts/test-watch',
+      release: './scripts/release',
     };
 
     const packageContent = {
@@ -67,6 +61,7 @@ export default {
 
       // Compatibility
       type,
+      sideEffects,
       license,
       engines,
       packageManager,
@@ -90,16 +85,18 @@ export default {
   },
 
   /**
-   * Scaffold a repo for use in a simple module contexte
+   * Scaffold a repo:
+   * - With ./lib holding the code
    */
   async run() {
     await this.createPackageJson();
 
     await initHelper.addLicenseFile('LICENSE');
     await initHelper.addConfigFiles();
-    await initHelper.addScripts();
+    await initHelper.addScripts('__module');
     await initHelper.addLibFiles();
   },
-  __getProjectName: initHelper.getProjectName.bind(initHelper),
+  __getProjectName: initHelper.getProjectName,
   __getProjectAuthor: initHelper.getProjectAuthor.bind(initHelper),
+  __getAberlaasVersion: initHelper.getAberlaasVersion,
 };

package/lib/layouts/monorepo.js

@@ -0,0 +1,236 @@
+import { writeJson } from 'firost';
+
+import helper from 'aberlaas-helper';
+import {
+  lernaVersion,
+  nodeVersion,
+  norskaThemeDocsVersion,
+  norskaVersion,
+  yarnVersion,
+} from 'aberlaas-versions';
+import initHelper from '../helper.js';
+
+export default {
+  /**
+   * Scaffold a repo:
+   * - As a monorepo
+   * - With ./modules holding all modules, including ./lib and ./docs
+   */
+  async createRootWorkspace() {
+    const aberlaasVersion = this.__getAberlaasVersion();
+    const sharedProjectData = await this.getSharedProjectData();
+
+    const packageContent = {
+      // Visibility
+      private: true,
+      workspaces: ['modules/*'],
+
+      // Name and version
+      name: `${sharedProjectData.name}-monorepo`,
+
+      // Metadata
+      author: sharedProjectData.author,
+      description: `${sharedProjectData.name} monorepo`,
+      repository: sharedProjectData.repository,
+      homepage: sharedProjectData.homepage,
+
+      // Compatibility
+      type: 'module',
+      license: sharedProjectData.license,
+      packageManager: `yarn@${yarnVersion}`,
+
+      // Dependencies
+      dependencies: {},
+      devDependencies: {
+        aberlaas: aberlaasVersion,
+        lerna: lernaVersion,
+      },
+
+      // Scripts
+      scripts: {
+        // Docs
+        build: './scripts/meta/build',
+        'build:prod': './scripts/meta/build-prod',
+        cms: './scripts/meta/cms',
+        serve: './scripts/meta/serve',
+
+        // Lib
+        release: './scripts/meta/release',
+        test: './scripts/meta/test',
+        'test:watch': './scripts/meta/test-watch',
+        ci: './scripts/meta/ci',
+        compress: './scripts/meta/compress',
+        lint: './scripts/meta/lint',
+        'lint:fix': './scripts/meta/lint-fix',
+
+        // Typo
+        learn: 'lerna',
+      },
+    };
+    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
+      // "type": "module", // TODO: Uncomment once norska is ESM-compliant
+      license: sharedProjectData.license,
+
+      // Dependencies
+      dependencies: {
+        norska: norskaVersion,
+        'norska-theme-docs': norskaThemeDocsVersion,
+      },
+      devDependencies: {},
+
+      // Scripts
+      scripts: sharedProjectData.scripts,
+    };
+    await writeJson(
+      packageContent,
+      helper.hostPath('./modules/docs/package.json'),
+      {
+        sort: false,
+      },
+    );
+  },
+  /**
+   * Create the lib workspace
+   */
+  async createLibWorkspace() {
+    const sharedProjectData = await this.getSharedProjectData();
+    const engines = {
+      node: `>=${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',
+      sideEffects: false,
+      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('./modules/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('modules/lib/LICENSE');
+  },
+  /**
+   * Add config files
+   */
+  async addConfigFiles() {
+    await initHelper.addConfigFiles();
+
+    // Lerna
+    await initHelper.copyTemplateToHost('lerna.json', 'lerna.json');
+  },
+  /**
+   * 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 = {
+      build: '../../scripts/local/build',
+      'build:prod': '../../scripts/local/build-prod',
+      cms: '../../scripts/local/cms',
+      serve: '../../scripts/local/serve',
+      ci: '../../scripts/local/ci',
+      release: '../../scripts/local/release',
+      test: '../../scripts/local/test',
+      'test:watch': '../../scripts/local/test-watch',
+      compress: '../../scripts/local/compress',
+      lint: '../../scripts/local/lint',
+      'lint:fix': '../../scripts/local/lint-fix',
+    };
+    return {
+      author,
+      homepage,
+      license,
+      name,
+      repository,
+      scripts,
+    };
+  },
+  /**
+   * Scaffold a repo:
+   * - As a monorepo
+   * - With ./libs and ./docs subfolders
+   */
+  async run() {
+    await this.createRootWorkspace();
+    await this.createDocsWorkspace();
+    await this.createLibWorkspace();
+
+    await this.addLicenseFiles();
+    await this.addConfigFiles();
+    await initHelper.addScripts('__monorepo');
+    await initHelper.addLibFiles('./modules/lib');
+  },
+  __getProjectName: initHelper.getProjectName,
+  __getProjectAuthor: initHelper.getProjectAuthor.bind(initHelper),
+  __getAberlaasVersion: initHelper.getAberlaasVersion,
+};

package/lib/main.js

@@ -1,10 +1,11 @@
-import { consoleInfo, run, spinner, write } from 'firost';
+import { consoleInfo, error as firostError, run, spinner, write } from 'firost';
 
 import Gilmore from 'gilmore';
 import helper from 'aberlaas-helper';
 import { nodeVersion } from 'aberlaas-versions';
-import initMonorepo from './monorepo.js';
-import initModule from './module.js';
+import moduleLayout from './layouts/module.js';
+import libdocsLayout from './layouts/libdocs.js';
+import monorepoLayout from './layouts/monorepo.js';
 
 export default {
   /**
@@ -27,13 +28,32 @@ export default {
   async yarnInstall() {
     await run('yarn install');
   },
+  /**
+   * Returns the correct layout object, based on args
+   * @param {object} args Arguments, as passed by minimist
+   * @returns {object} Object with a .run() method
+   **/
+  getLayout(args) {
+    if (args.monorepo && args.libdocs) {
+      throw firostError(
+        'ABERLAAS_INIT_LAYOUT_INCOMPATIBLE',
+        "You can't specific both --monorepo and --libdocs",
+      );
+    }
+
+    if (args.monorepo) {
+      return this.__monorepoLayout();
+    }
+    if (args.libdocs) {
+      return this.__libdocsLayout();
+    }
+    return this.__moduleLayout();
+  },
   /**
    * 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');
@@ -43,7 +63,8 @@ export default {
     progress.tick('Adding default files ');
 
     // Create a different scaffolding based on if creating a monorepo or not
-    isMonorepo ? await initMonorepo.run() : await initModule.run();
+    const layout = this.getLayout(args);
+    await layout.run();
 
     progress.success('aberlaas project initialized');
 
@@ -56,4 +77,14 @@ export default {
   },
   __consoleInfo: consoleInfo,
   __spinner: spinner,
+  // Why the old-school getters? So we can mock which layout is returned
+  __moduleLayout() {
+    return moduleLayout;
+  },
+  __libdocsLayout() {
+    return libdocsLayout;
+  },
+  __monorepoLayout() {
+    return monorepoLayout;
+  },
 };

package/package.json

@@ -2,13 +2,14 @@
   "name": "aberlaas-init",
   "type": "module",
   "description": "aberlaas init command: Setup the repository with all needed config",
-  "version": "2.10.0",
+  "version": "2.13.0",
   "repository": "pixelastic/aberlaas",
   "homepage": "https://projects.pixelastic.com/aberlaas/",
   "author": "Tim Carry (@pixelastic)",
   "license": "MIT",
   "files": [
     "lib/*.js",
+    "lib/layouts/",
     "templates/"
   ],
   "exports": {
@@ -34,10 +35,10 @@
     "lint:fix": "../../scripts/local/lint-fix"
   },
   "dependencies": {
-    "aberlaas-helper": "^2.10.0",
-    "aberlaas-versions": "^2.10.0",
-    "firost": "4.3.0",
+    "aberlaas-helper": "^2.13.0",
+    "aberlaas-versions": "^2.13.0",
+    "firost": "4.8.0",
     "gilmore": "1.0.0"
   },
-  "gitHead": "bcdaf87c198a588e02b5539c222f611e356d3079"
+  "gitHead": "a8a1ee486fa1faeac6b7a524e7a6e41d5503dbc0"
 }

package/templates/_yarnrc.yml

@@ -12,4 +12,5 @@ nodeLinker: node-modules
 nmMode: hardlinks-local
 
 # Make sure each workspace has its own local node_modules
+# This greatly limit dependency leaking between modules
 nmHoistingLimits: workspaces

package/templates/scripts/__libdocs/local/build

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -e
+
+cd ..
+./scripts/meta/build "$@"

package/templates/scripts/__libdocs/local/build-prod

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -e
+
+cd ..
+./scripts/meta/build-prod "$@"

package/templates/scripts/__libdocs/local/ci

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -e
+
+cd ..
+./scripts/meta/ci "$@"

package/templates/scripts/__libdocs/local/cms

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+echo "TODO: Should load the CMS UI"

package/templates/scripts/__libdocs/local/compress

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -e
+
+cd ..
+./scripts/meta/compress "$@"

package/templates/scripts/__libdocs/local/lint

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -e
+
+cd ..
+./scripts/meta/lint "$@"