@w5s/mrm-preset 1.0.0-alpha.2 → 1.0.0-alpha.21

package/core/pkg.js

@@ -3,14 +3,31 @@
 
 // @ts-ignore
 const { intersect } = require('semver-intersect');
-const { packageJson, file } = require('mrm-core');
-const jsonFile = require('./jsonFile');
+const { packageJson, file, json } = require('mrm-core');
+const glob = require('glob');
+const path = require('node:path');
+const jsonFile = require('./jsonFile.js');
 
 /**
  * An empty placeholder for npm script
  */
 const emptyScript = ':';
 
+/**
+ * @param {import('mrm-core').Json} packageFile
+ * @returns {'application'|'library'|'workspace'} the archetype value
+ */
+function archetype(packageFile) {
+  if (hasWorkspaces(packageFile)) {
+    return 'workspace';
+  }
+  if (packageFile.get('private') === true || (packageFile.get('main') == null && packageFile.get('exports'))) {
+    return 'application';
+  }
+
+  return 'library';
+}
+
 /**
  * @param {(pkg: import('mrm-core').PackageJson) => void} block
  */
@@ -21,7 +38,38 @@ function withPackageJson(block) {
 }
 
 /**
- * @param {import('mrm-core').PackageJson} packageFile
+ * @param {import("mrm-core").Json} packageFile
+ * @returns {string[]} - The list of workspace matchers
+ */
+function listWorkspaceMatchers(packageFile) {
+  return packageFile.get('workspaces.packages', packageFile.get('workspaces', []));
+}
+
+/**
+ * @param {(workspace: {
+ *   projectDir: string;
+ *   packageFile: import("mrm-core").Json;
+ * }) => void} fn
+ */
+function forEachWorkspace(fn) {
+  const packageRoot = packageJson();
+  const workspacesMatchers = listWorkspaceMatchers(packageRoot);
+
+  for (const workspaceMatcher of workspacesMatchers) {
+    const directories = glob.sync(workspaceMatcher);
+    directories.forEach((directory) => {
+      const packageFile = json(path.join(directory, 'package.json'));
+      fn({
+        projectDir: directory,
+        packageFile,
+      });
+      packageFile.save();
+    });
+  }
+}
+
+/**
+ * @param {import('mrm-core').Json} packageFile
  * @param {{
  *   name: string,
  *   state: 'present'|'absent'|'default',
@@ -30,9 +78,9 @@ function withPackageJson(block) {
  */
 function script(packageFile, { name, state, script: scriptName }) {
   if (state === 'absent') {
-    packageFile.removeScript(name);
-  } else if (state === 'present' || (state === 'default' && !packageFile.getScript(name))) {
-    packageFile.setScript(name, scriptName);
+    packageFile.unset(['scripts', name]);
+  } else if (state === 'present' || (state === 'default' && !packageFile.get(['scripts', name]))) {
+    packageFile.set(['scripts', name], scriptName);
   }
 }
 
@@ -40,7 +88,7 @@ const defaultManager = 'npm';
 
 /**
  * @param {import('mrm-core').PackageJson} packageFile
- * @returns {'yarn'|'npm'}
+ * @returns {'yarn'|'npm'} - The manager used by the package
  */
 function manager(packageFile) {
   if (packageFile.get('packagerManager')) {
@@ -58,9 +106,37 @@ function manager(packageFile) {
   return defaultManager;
 }
 
+/**
+ *
+ * @param {import('mrm-core').Json} packageFile
+ */
+function hasWorkspaces(packageFile) {
+  return Boolean(packageFile.get('workspaces'));
+}
+
 /**
  *
  * @param {import('mrm-core').PackageJson} packageFile
+ * @param {string} packageName
+ * @param {'normal'|'dev'|'peer'=} dependencyType
+ */
+function hasDependency(packageFile, packageName, dependencyType) {
+  return Boolean(
+    packageFile.get(
+      `${
+        dependencyType == null || dependencyType === 'normal'
+          ? 'dependencies'
+          : dependencyType === 'dev'
+          ? 'devDependencies'
+          : 'peerDependencies'
+      }.${packageName}`
+    )
+  );
+}
+
+/**
+ *
+ * @param {import('mrm-core').Json} packageFile
  * @param {Record<string, string>} engineVersionMap
  */
 function engineMinVersion(packageFile, engineVersionMap) {
@@ -72,27 +148,29 @@ function engineMinVersion(packageFile, engineVersionMap) {
     const currentVersion = packageFile.get(`engines.${engineName}`, defaultVersion);
     try {
       return intersect(currentVersion, defaultVersion);
-    } catch (_) {
+    } catch {
       return currentVersion; // leave unchanged
     }
   };
 
   packageFile.merge({
-    engines: Object.keys(engineVersionMap).reduce(
-      (acc, engineName) => ({
-        ...acc,
-        [engineName]: engineConstraint(engineName),
-      }),
-      {}
+    engines: Object.fromEntries(
+      Object.keys(engineVersionMap).map((engineName) => [engineName, engineConstraint(engineName)])
     ),
   });
+  return packageFile.get('engines');
 }
 
 module.exports = {
   ...jsonFile,
   emptyScript,
+  archetype,
   script,
   manager,
   engineMinVersion,
+  hasDependency,
+  hasWorkspaces,
   withPackageJson,
+  forEachWorkspace,
+  listWorkspaceMatchers,
 };

package/core/project.js

@@ -1,3 +1,5 @@
+/** @type {'docs'} */
+const docs = 'docs';
 /** @type {'install'} */
 const install = 'install';
 /** @type {'prepare'} */
@@ -24,6 +26,8 @@ const validate = 'validate';
 const release = 'release';
 /** @type {'rescue'} */
 const rescue = 'rescue';
+/** @type {'spellcheck'} */
+const spellcheck = 'spellcheck';
 
 /**
  * @param {string} taskName
@@ -41,6 +45,7 @@ function post(taskName) {
 
 module.exports = {
   build,
+  docs,
   prepare,
   develop,
   clean,
@@ -55,4 +60,5 @@ module.exports = {
   rescue,
   test,
   validate,
+  spellcheck,
 };

package/core/semanticRelease.js

@@ -1,6 +1,6 @@
-const npm = require('./npm');
-const pkg = require('./pkg');
-const jsonFile = require('./jsonFile');
+const npm = require('./npm.js');
+const pkg = require('./pkg.js');
+const jsonFile = require('./jsonFile.js');
 
 /**
  * @typedef {{
@@ -34,7 +34,7 @@ function semanticRelease({ state, update, preset }) {
     });
   });
 }
-semanticRelease.command = function () {
+semanticRelease.command = function command() {
   return 'semantic-release';
 };
 

package/core/turbo.js

@@ -0,0 +1,57 @@
+const { packageJson, json } = require('mrm-core');
+const pkg = require('./pkg.js');
+const npm = require('./npm.js');
+const jsonFile = require('./jsonFile.js');
+
+/**
+ * @typedef {{
+ *   $schema: string,
+ *   baseBranch?: string,
+ *   pipeline?: Record<string, unknown>,
+ *   globalDependencies?: Array<string>,
+ * }} TurboConfig
+ */
+
+/**
+ * @param {{
+ *   state: 'present'|'absent',
+ *   update: (config: TurboConfig) => TurboConfig
+ * }} options
+ */
+function turbo({ state, update }) {
+  const packageFileDefault = packageJson();
+  const hasWorkspaces = pkg.hasWorkspaces(packageFileDefault);
+  const hasTurbo = state === 'present' && hasWorkspaces;
+
+  const turboFile = json('turbo.json');
+
+  if (hasTurbo) {
+    jsonFile.value(turboFile, {
+      path: undefined,
+      state,
+      update,
+      /** @type {TurboConfig} */
+      default: {
+        $schema: 'https://turborepo.org/schema.json',
+      },
+    });
+
+    /**
+     * Otherwise save the file with content
+     */
+    turboFile.save();
+  } else {
+    turboFile.delete();
+  }
+
+  // Dependencies
+  npm.dependency({
+    dev: true,
+    name: ['turbo'],
+    state: hasTurbo ? 'present' : 'absent',
+  });
+}
+
+module.exports = {
+  turbo,
+};

package/core/typedoc.js

@@ -1,7 +1,7 @@
 const { packageJson, json } = require('mrm-core');
-const pkg = require('./pkg');
-const npm = require('./npm');
-const jsonFile = require('./jsonFile');
+const pkg = require('./pkg.js');
+const npm = require('./npm.js');
+const jsonFile = require('./jsonFile.js');
 
 /**
  * @typedef {{
@@ -23,17 +23,9 @@ const jsonFile = require('./jsonFile');
  */
 function typedoc({ state, update }) {
   const packageFileDefault = packageJson();
-  const hasWorkspaces = Boolean(packageFileDefault.get('workspaces'));
+  const hasWorkspaces = pkg.hasWorkspaces(packageFileDefault);
   const hasTypedoc = state === 'present';
 
-  pkg.withPackageJson((packageFile) => {
-    pkg.script(packageFile, {
-      name: 'typedoc',
-      script: 'typedoc',
-      state: !hasTypedoc || hasWorkspaces ? 'absent' : 'present',
-    });
-  });
-
   const typedocFile = json('typedoc.json');
 
   if (hasTypedoc) {
@@ -44,11 +36,11 @@ function typedoc({ state, update }) {
         ...update(config),
         ...(hasWorkspaces
           ? {
-              'external-modulemap': '.*packages/([^/]+)/.*',
-              entryPoints: ['packages/'],
+              entryPointStrategy: 'packages',
+              entryPoints: undefined,
             }
           : {
-              'external-modulemap': undefined,
+              entryPointStrategy: undefined,
               entryPoints: ['src/index.ts'],
             }),
       }),
@@ -70,11 +62,6 @@ function typedoc({ state, update }) {
     name: ['typedoc'],
     state: hasTypedoc ? 'present' : 'absent',
   });
-  npm.dependency({
-    dev: true,
-    name: ['@strictsoftware/typedoc-plugin-monorepo'],
-    state: hasTypedoc && hasWorkspaces ? 'present' : 'absent',
-  });
 }
 
 module.exports = {

package/core/vscode.js

@@ -31,7 +31,7 @@ function vscodeTask(newTask) {
    * @type {Array<any>}
    */
   const tasks = vscodeTaskFile.get('tasks', []);
-  if (tasks.find((task) => task.script === newTask.script)) {
+  if (tasks.some((task) => task.script === newTask.script)) {
     vscodeTaskFile.set(
       'tasks',
       tasks.map((task) => (task.script === newTask.script ? newTask : task))

package/cspell/index.js

@@ -1,9 +1,8 @@
-const { cspell } = require('../core/cspell');
-const { lintStaged } = require('../core/lintStaged');
-const { hasGit } = require('../core/git');
+const { cspell } = require('../core/cspell.js');
+const project = require('../core/project.js');
+const pkg = require('../core/pkg.js');
 
 function task() {
-  const gitSupported = hasGit();
   cspell({
     state: 'present',
     update: (_) => ({
@@ -24,12 +23,23 @@ function task() {
     }),
   });
 
-  lintStaged({
-    state: gitSupported ? 'present' : 'absent',
-    update: (config) => ({
-      ...config,
-      '*.*': ['cspell --no-must-find-files'],
-    }),
+  pkg.withPackageJson((packageFile) => {
+    const hasWorkspaces = pkg.hasWorkspaces(packageFile);
+    const workspaceMatchers = pkg.listWorkspaceMatchers(packageFile);
+    pkg.script(packageFile, {
+      name: project.spellcheck,
+      script: `cspell --no-progress '**' ${
+        hasWorkspaces ? `${workspaceMatchers.map((_) => `--exclude='${_}/**'`).join(' ')} && turbo run spellcheck` : ''
+      }`,
+      state: 'present',
+    });
+  });
+  pkg.forEachWorkspace(({ packageFile }) => {
+    pkg.script(packageFile, {
+      name: project.spellcheck,
+      script: `cspell --no-progress '**'`,
+      state: 'present',
+    });
   });
 }
 

package/editorconfig/index.js

@@ -1,6 +1,6 @@
 const { ini } = require('mrm-core');
 const createDebug = require('debug');
-const { vscodeRecommendedExtension } = require('../core/vscode');
+const { vscodeRecommendedExtension } = require('../core/vscode.js');
 
 /**
  *
@@ -26,6 +26,7 @@ function createEditorConfig(defaults) {
 
   /**
    * @param {string} section
+   * @param {defaults} existing
    */
   function mergeSection(section, existing = {}) {
     return Object.assign(existing, defaults[section] || {});
@@ -52,6 +53,7 @@ function createEditorConfig(defaults) {
 
 module.exports = createEditorConfig({
   '*': {
+    // eslint-disable-next-line unicorn/text-encoding-identifier-case
     charset: 'utf-8',
     continuation_indent_size: 4,
     curly_bracket_next_line: false,

package/eslint/index.js

@@ -1,21 +1,22 @@
 const { packageJson } = require('mrm-core');
-const pkg = require('../core/pkg');
-const npm = require('../core/npm');
-const { gitIgnore } = require('../core/git');
-const { eslintIgnore, eslintConfig } = require('../core/eslint');
-const project = require('../core/project');
-const { vscodeSettings } = require('../core/vscode');
+const pkg = require('../core/pkg.js');
+const npm = require('../core/npm.js');
+const { gitIgnore } = require('../core/git.js');
+const { eslintIgnore, eslintConfig } = require('../core/eslint.js');
+const project = require('../core/project.js');
+const { vscodeSettings } = require('../core/vscode.js');
 
 function createESLint({ eslintPreset: eslintPresetDefault = 'eslint:recommended' }) {
   /**
    *
    * @param {{
    *   eslintPreset: string,
-   *   eslintRules: Record<string, any>
    * }} config
    */
-  function task({ eslintPreset, eslintRules }) {
-    const hasTypescript = packageJson().get('devDependencies.typescript');
+  function task({ eslintPreset }) {
+    const packageFileDefault = packageJson();
+    const hasWorkspaces = pkg.hasWorkspaces(packageFileDefault);
+    const hasTypescript = pkg.hasDependency(packageFileDefault, 'typescript', 'dev');
     const hasJSX = true;
     const hasJSON = true;
 
@@ -53,15 +54,21 @@ function createESLint({ eslintPreset: eslintPresetDefault = 'eslint:recommended'
       state: !eslintPreset.startsWith('eslint:') ? 'present' : 'absent',
     });
     eslintConfig({
-      extends: [eslintPreset],
-      rules: eslintRules,
-      parserOptions: {
-        project: hasTypescript ? './tsconfig.json' : undefined,
-      },
+      state: 'present',
+      update: (config) => ({
+        ...config,
+        extends: [eslintPreset],
+        parserOptions: {
+          project: hasTypescript ? './tsconfig.json' : undefined,
+          ...config.parserOptions,
+        },
+      }),
     });
 
     /** @type {Record<string, boolean>} */
     const extsMap = {
+      mjs: true,
+      cjs: true,
       js: true,
       jsx: hasJSX,
       ts: hasTypescript,
@@ -69,18 +76,57 @@ function createESLint({ eslintPreset: eslintPresetDefault = 'eslint:recommended'
       json: hasJSON,
     };
     const extList = Object.keys(extsMap).filter((ext) => extsMap[ext]);
-    const extOption = ` --ext ${extList.map((ext) => `.${ext}`).join(',')}`;
+    const extOption = ` --ext=${extList.join(',')}`;
 
     pkg.withPackageJson((packageFile) => {
+      const ignorePatterns = pkg
+        .listWorkspaceMatchers(packageFile)
+        .map((_) => ` --ignore-pattern='${_}/**'`)
+        .join('');
+
+      // workspaces
+      pkg.script(packageFile, {
+        name: `${project.lint}:root`,
+        script: `eslint .${extOption}${ignorePatterns}`,
+        state: hasWorkspaces ? 'present' : 'absent',
+      });
+      pkg.script(packageFile, {
+        name: `${project.format}:root`,
+        script: `eslint .${extOption}${ignorePatterns} --fix`,
+        state: hasWorkspaces ? 'present' : 'absent',
+      });
+      pkg.script(packageFile, {
+        name: `${project.lint}:packages`,
+        script: `turbo run ${project.lint}`,
+        state: hasWorkspaces ? 'present' : 'absent',
+      });
+      pkg.script(packageFile, {
+        name: `${project.format}:packages`,
+        script: `turbo run ${project.format}`,
+        state: hasWorkspaces ? 'present' : 'absent',
+      });
+      // regular package
       pkg.script(packageFile, {
-        name: project.lint,
-        script: `eslint . --cache${extOption}`,
-        state: 'present',
+        name: `${project.lint}:src`,
+        script: `eslint .${extOption}`,
+        state: !hasWorkspaces ? 'present' : 'absent',
       });
       pkg.script(packageFile, {
-        name: project.format,
-        script: `eslint . --quiet --cache --fix${extOption}`,
-        state: 'present',
+        name: `${project.format}:src`,
+        script: `eslint . --fix${extOption}`,
+        state: !hasWorkspaces ? 'present' : 'absent',
+      });
+    });
+    pkg.forEachWorkspace(({ packageFile }) => {
+      pkg.script(packageFile, {
+        name: `${project.lint}:src`,
+        script: `eslint .${extOption}`,
+        state: 'default',
+      });
+      pkg.script(packageFile, {
+        name: `${project.format}:src`,
+        script: `eslint . --fix${extOption}`,
+        state: 'default',
       });
     });
 
@@ -92,14 +138,20 @@ function createESLint({ eslintPreset: eslintPresetDefault = 'eslint:recommended'
         'editor.codeActionsOnSave': settings['editor.codeActionsOnSave'] || {
           'source.fixAll': true,
         },
-        'eslint.validate': extList.map(
-          (ext) =>
-            ({
-              jsx: 'javascriptreact',
-              js: 'javascript',
-              tsx: 'typescriptreact',
-              ts: 'typescript',
-            }[ext] || ext)
+        'eslint.validate': Array.from(
+          new Set(
+            extList.map(
+              (ext) =>
+                ({
+                  cjs: 'javascript',
+                  mjs: 'javascript',
+                  jsx: 'javascriptreact',
+                  js: 'javascript',
+                  tsx: 'typescriptreact',
+                  ts: 'typescript',
+                }[ext] || ext)
+            )
+          )
         ),
       }),
     });
@@ -112,9 +164,6 @@ function createESLint({ eslintPreset: eslintPresetDefault = 'eslint:recommended'
       message: 'Enter ESLint preset name',
       type: 'input',
     },
-    eslintRules: {
-      type: 'config',
-    },
   };
 
   return task;

package/githooks/index.js

@@ -1,62 +1,53 @@
-const path = require('path');
+const path = require('node:path');
 const { packageJson, template } = require('mrm-core');
-const project = require('../core/project');
-const { hasGit } = require('../core/git');
-const { gitHook, husky } = require('../core/githooks');
-const { lintStaged } = require('../core/lintStaged');
-const { file } = require('../core/file');
+const project = require('../core/project.js');
+const pkg = require('../core/pkg.js');
+const { hasGit } = require('../core/git.js');
+const { gitHook, husky } = require('../core/githooks.js');
+const { lintStaged } = require('../core/lintStaged.js');
+const { file } = require('../core/file.js');
 
-function createGitHooks() {
-  function task() {
-    const gitSupported = hasGit();
-    const packageFile = packageJson();
-    const hasESLint = Boolean(packageFile.get('devDependencies.eslint'));
-    const hasJest = Boolean(packageFile.get('devDependencies.jest'));
-    const hasTsc = Boolean(packageFile.get('devDependencies.typescript'));
+function task() {
+  const gitSupported = hasGit();
+  const packageFile = packageJson();
+  const hasESLint = pkg.hasDependency(packageFile, 'eslint', 'dev');
 
-    husky({
-      state: gitSupported ? 'present' : 'absent',
-    });
-    lintStaged({
-      state: gitSupported ? 'present' : 'absent',
-      update: (config) => ({
-        ...config,
-        '*.json': [...(hasESLint ? ['eslint'] : [])],
-        '*.js?(x)': [
-          ...(hasTsc ? ["bash -c 'tsc --noEmit'"] : []),
-          ...(hasESLint ? ['eslint'] : []),
-          ...(hasJest ? ['jest --ci --bail --findRelatedTests'] : []),
-        ],
-        '*.ts?(x)': [
-          ...(hasTsc ? ["bash -c 'tsc --noEmit'"] : []),
-          ...(hasESLint ? ['eslint'] : []),
-          ...(hasJest ? ['jest --ci --bail --findRelatedTests'] : []),
-        ],
-      }),
-    });
-    gitHook({
-      name: 'pre-commit',
-      content: `npm exec --no -- lint-staged`,
-      state: gitSupported ? 'present' : 'absent',
-    });
-    gitHook({
-      name: 'pre-push',
-      content: `npm run ${project.validate}`,
-      state: gitSupported ? 'present' : 'absent',
-    });
+  husky({
+    state: gitSupported ? 'present' : 'absent',
+  });
+  lintStaged({
+    state: gitSupported ? 'present' : 'absent',
+    update: (config) => ({
+      ...config,
+      '*.json': [...(hasESLint ? ['eslint'] : [])],
+      '*.js?(x)': [...(hasESLint ? ['eslint'] : [])],
+      '*.ts?(x)': [
+        // TODO: https://github.com/okonet/lint-staged/issues/825
+        // ...(hasTsc ? ["tsc --noEmit --skipLibCheck"] : []),
+        ...(hasESLint ? ['eslint'] : []),
+      ],
+    }),
+  });
+  gitHook({
+    name: 'pre-commit',
+    content: `npm exec --no -- lint-staged`,
+    state: gitSupported ? 'present' : 'absent',
+  });
+  gitHook({
+    name: 'pre-push',
+    content: `npm run ${project.validate}`,
+    state: gitSupported ? 'present' : 'absent',
+  });
 
-    file({
-      path: 'CODEOWNERS',
-      state: gitSupported ? 'file' : 'absent',
-      update: (content) =>
-        content.length === 0 ? template('', path.join(__dirname, 'templates', 'CODEOWNERS')).apply().get() : undefined,
-    });
-  }
-
-  task.description = 'Setup Git hooks';
-  task.parameters = {};
-
-  return task;
+  file({
+    path: 'CODEOWNERS',
+    state: gitSupported ? 'file' : 'absent',
+    update: (content) =>
+      content.length === 0 ? template('', path.join(__dirname, 'templates', 'CODEOWNERS')).apply().get() : undefined,
+  });
 }
 
-module.exports = createGitHooks();
+task.description = 'Setup Git hooks';
+task.parameters = {};
+
+module.exports = task;