@w5s/mrm-preset 1.0.0-alpha.11 → 1.0.0-alpha.14

package/.turbo/turbo-build.log

@@ -1 +1 @@
-@w5s/mrm-preset:build: cache hit, replaying output 3c115708988953a1
+@w5s/mrm-preset:build: cache hit, replaying output c6b4f1c7f63e49b4

package/.turbo/turbo-docs.log

@@ -1,4 +1,4 @@
-@w5s/mrm-preset:docs: cache hit, replaying output 95ec4e4c5dc4e562
+@w5s/mrm-preset:docs: cache hit, replaying output 744547a9c29d1593
 @w5s/mrm-preset:docs: Starting markdown-magic [ '**/*.md', '!node_modules/**' ]
 @w5s/mrm-preset:docs: ℹ Notice:
 @w5s/mrm-preset:docs:   Missing transforms "BASIC_RULES","JSX_RULES" in _tester/node_modules/eslint-plugin-react/README.md

package/.turbo/turbo-format.log

@@ -0,0 +1 @@
+@w5s/mrm-preset:format: cache hit, replaying output 3dd24b3a1f0380bc

package/.turbo/turbo-lint.log

@@ -1 +1 @@
-@w5s/mrm-preset:lint: cache hit, replaying output 7e471593505748d5
+@w5s/mrm-preset:lint: cache hit, replaying output 55431f2ab0e89fe7

package/.turbo/turbo-spellcheck.log

@@ -0,0 +1,2 @@
+@w5s/mrm-preset:spellcheck: cache hit, replaying output 75ba9a88a70f28ba
+@w5s/mrm-preset:spellcheck: CSpell: Files checked: 49, Issues found: 0 in 0 files

package/.turbo/turbo-test.log

@@ -1,4 +1,4 @@
-@w5s/mrm-preset:test: cache hit, replaying output 3972076d5900fa18
+@w5s/mrm-preset:test: cache hit, replaying output a48676b2c6596bd4
 @w5s/mrm-preset:test: mkdir: _tester: File exists
 @w5s/mrm-preset:test: Running bootstrap...
 @w5s/mrm-preset:test: Running alias configure...
@@ -12,6 +12,7 @@
 @w5s/mrm-preset:test: Running commitlint...
 @w5s/mrm-preset:test: Running editorconfig...
 @w5s/mrm-preset:test: Running eslint...
+@w5s/mrm-preset:test: Update package.json
 @w5s/mrm-preset:test: Running cspell...
 @w5s/mrm-preset:test: Running jest...
 @w5s/mrm-preset:test: Update package.json

package/CHANGELOG.md

@@ -3,6 +3,51 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.0.0-alpha.14](https://github.com/w5s/project-config/compare/@w5s/mrm-preset@1.0.0-alpha.13...@w5s/mrm-preset@1.0.0-alpha.14) (2022-06-10)
+
+
+### Bug Fixes
+
+* add prepare task to turbo configuration ([717d59a](https://github.com/w5s/project-config/commit/717d59a724c1de8cb37f37c23aae8f4cc57fc231))
+* remove --quiet option on format ([268b0a7](https://github.com/w5s/project-config/commit/268b0a76dbd03cfa6729988472948a66e2b749c9))
+
+
+
+
+
+# [1.0.0-alpha.13](https://github.com/w5s/project-config/compare/@w5s/mrm-preset@1.0.0-alpha.12...@w5s/mrm-preset@1.0.0-alpha.13) (2022-06-07)
+
+
+### Bug Fixes
+
+* improve cspell output ([a5721b5](https://github.com/w5s/project-config/commit/a5721b5c8e97817dc68e9444f4443d3cb7893a27))
+
+
+
+
+
+# [1.0.0-alpha.12](https://github.com/w5s/project-config/compare/@w5s/mrm-preset@1.0.0-alpha.11...@w5s/mrm-preset@1.0.0-alpha.12) (2022-06-07)
+
+
+### Bug Fixes
+
+* add spellcheck task to turbo config ([1029c2b](https://github.com/w5s/project-config/commit/1029c2b97b12b44618ce741d045b02712f0ebf18))
+* clean non useful empty script when possible ([2e7e60a](https://github.com/w5s/project-config/commit/2e7e60a400506bbca00db653813668fa47f8f065))
+* correct docs task in turbo ([0fca8c9](https://github.com/w5s/project-config/commit/0fca8c9ca0389b090e6aa2a66d47ab63b1cb138e))
+* remove uneeded @types/jest typing ([475f6bb](https://github.com/w5s/project-config/commit/475f6bbdc101d31460cd8ffb7f5deb3b97176d5c))
+* remove uneeded cspell script ([ba8d38b](https://github.com/w5s/project-config/commit/ba8d38b8053a24a7937c24c270f5d61d3dad71c7))
+
+
+### Features
+
+* configure spellcheck ([4be6a96](https://github.com/w5s/project-config/commit/4be6a96d6d30e1085b73c0befcab1d3fa30475ab))
+* improve eslint mrm support for workspaces ([2dacc2e](https://github.com/w5s/project-config/commit/2dacc2e867ebb74c8de777af2ce9f173426ebc33))
+* improve turbo support for lint and format ([76e19e0](https://github.com/w5s/project-config/commit/76e19e02918aba66a2e6e9c06a7d0bed99500ecc))
+
+
+
+
+
 # [1.0.0-alpha.11](https://github.com/w5s/project-config/compare/@w5s/mrm-preset@1.0.0-alpha.10...@w5s/mrm-preset@1.0.0-alpha.11) (2022-05-20)
 
 

package/core/cspell.js

@@ -1,5 +1,4 @@
 const { json } = require('mrm-core');
-const pkg = require('./pkg');
 const npm = require('./npm');
 /**
  * @typedef {{
@@ -22,14 +21,6 @@ const npm = require('./npm');
 function cspell({ state, update }) {
   const hasCSpell = state === 'present';
 
-  pkg.withPackageJson((packageFile) => {
-    pkg.script(packageFile, {
-      name: 'cspell',
-      script: 'cspell',
-      state,
-    });
-  });
-
   const cSpellFile = json('cSpell.json', {
     version: '0.2',
     language: 'en',

package/core/jest.js

@@ -13,7 +13,6 @@ function jest({ state }) {
   const packageFileDefault = packageJson();
   const hasJest = state === 'present';
   const hasWorkspaces = pkg.hasWorkspaces(packageFileDefault);
-  const hasTypescript = pkg.hasDependency(packageFileDefault, 'typescript', 'dev');
 
   pkg.withPackageJson((packageFile) => {
     if (hasJest) {
@@ -53,17 +52,13 @@ function jest({ state }) {
       state: !hasJest || hasWorkspaces ? 'default' : 'present',
     });
   });
+
   // Dependencies
   npm.dependency({
     dev: true,
     name: ['jest', 'es-jest'],
     state: hasJest ? 'present' : 'absent',
   });
-  npm.dependency({
-    dev: true,
-    name: ['@types/jest'],
-    state: hasJest && hasTypescript ? 'present' : 'absent',
-  });
 
   // vscodeSnippets({
   //   name: 'jest',

package/core/pkg.js

@@ -3,7 +3,9 @@
 
 // @ts-ignore
 const { intersect } = require('semver-intersect');
-const { packageJson, file } = require('mrm-core');
+const { packageJson, file, json } = require('mrm-core');
+const glob = require('glob');
+const path = require('path');
 const jsonFile = require('./jsonFile');
 
 /**
@@ -21,7 +23,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 +63,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);
   }
 }
 
@@ -121,4 +154,6 @@ module.exports = {
   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/turbo.js

@@ -0,0 +1,56 @@
+const { packageJson, json } = require('mrm-core');
+const pkg = require('./pkg');
+const npm = require('./npm');
+const jsonFile = require('./jsonFile');
+
+/**
+ * @typedef {{
+ *   $schema: 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/cspell/index.js

@@ -1,4 +1,6 @@
 const { cspell } = require('../core/cspell');
+const project = require('../core/project');
+const pkg = require('../core/pkg');
 
 function task() {
   cspell({
@@ -20,6 +22,25 @@ function task() {
       ),
     }),
   });
+
+  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',
+    });
+  });
 }
 
 task.description = 'Adds CSpell support';

package/eslint/index.js

@@ -16,6 +16,7 @@ function createESLint({ eslintPreset: eslintPresetDefault = 'eslint:recommended'
    */
   function task({ eslintPreset, eslintRules }) {
     const packageFileDefault = packageJson();
+    const hasWorkspaces = pkg.hasWorkspaces(packageFileDefault);
     const hasTypescript = pkg.hasDependency(packageFileDefault, 'typescript', 'dev');
     const hasJSX = true;
     const hasJSON = true;
@@ -63,6 +64,8 @@ function createESLint({ eslintPreset: eslintPresetDefault = 'eslint:recommended'
 
     /** @type {Record<string, boolean>} */
     const extsMap = {
+      mjs: true,
+      cjs: true,
       js: true,
       jsx: hasJSX,
       ts: hasTypescript,
@@ -73,15 +76,54 @@ function createESLint({ eslintPreset: eslintPresetDefault = 'eslint:recommended'
     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}:src`,
+        script: `eslint .${extOption}`,
+        state: !hasWorkspaces ? 'present' : 'absent',
+      });
+      pkg.script(packageFile, {
+        name: `${project.format}:src`,
+        script: `eslint . --fix${extOption}`,
+        state: !hasWorkspaces ? 'present' : 'absent',
+      });
+    });
+    pkg.forEachWorkspace(({ packageFile }) => {
       pkg.script(packageFile, {
         name: project.lint,
-        script: `eslint . --cache${extOption}`,
-        state: 'present',
+        script: `eslint .${extOption}`,
+        state: 'default',
       });
       pkg.script(packageFile, {
         name: project.format,
-        script: `eslint . --quiet --cache --fix${extOption}`,
-        state: 'present',
+        script: `eslint . -fix${extOption}`,
+        state: 'default',
       });
     });
 
@@ -93,14 +135,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)
+            )
+          )
         ),
       }),
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@w5s/mrm-preset",
-  "version": "1.0.0-alpha.11",
+  "version": "1.0.0-alpha.14",
   "description": "Mrm configuration presets",
   "keywords": [
     "mrm",
@@ -24,12 +24,14 @@
     "build:empty": ":",
     "build:tsc": "tsc --noEmit --skipLibCheck",
     "docs": "md-magic --path '**/*.md' --ignore='node_modules'",
-    "format": "eslint . --fix",
-    "lint": "eslint .",
+    "format": "eslint . --fix --ext=mjs,cjs,js,jsx,ts,tsx,json",
+    "lint": "eslint . --ext=mjs,cjs,js,jsx,ts,tsx,json",
+    "spellcheck": "cspell --no-progress '**'",
     "test": "mkdir _tester; cd _tester; mrm bootstrap --dir ..; mrm configure --dir .."
   },
   "dependencies": {
     "debug": "^4.3.3",
+    "glob": "^8.0.3",
     "mrm-core": "^7.0.0",
     "semver-intersect": "^1.4.0",
     "sync-directory": "^5.0.0"
@@ -45,5 +47,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "123632828a2c65c3ca28b515666582b689fb9dea"
+  "gitHead": "55a9106dcf41315e4a1e0fa73b912853c6cf6f06"
 }

package/project/index.js

@@ -5,6 +5,7 @@ const npm = require('../core/npm');
 const { vscodeTask } = require('../core/vscode');
 const project = require('../core/project');
 const mrmPackageJson = require('../package.json');
+const { turbo } = require('../core/turbo');
 
 /**
  *
@@ -62,7 +63,7 @@ function task() {
   pkg.script(packageFile, {
     name: `${project.build}:empty`,
     script: pkg.emptyScript,
-    state: 'present',
+    state: !useWorkspace ? 'present' : 'absent',
   });
   pkg.script(packageFile, {
     name: `${project.build}:packages`,
@@ -85,13 +86,23 @@ function task() {
   // lint
   pkg.script(packageFile, {
     name: project.lint,
+    script: npmRunAll(project.lint),
+    state: 'present',
+  });
+  pkg.script(packageFile, {
+    name: `${project.lint}:empty`,
     script: pkg.emptyScript,
-    state: 'default',
+    state: !useWorkspace ? 'present' : 'absent',
   });
   pkg.script(packageFile, {
     name: project.format,
+    script: npmRunAll(project.format),
+    state: 'present',
+  });
+  pkg.script(packageFile, {
+    name: `${project.format}:empty`,
     script: pkg.emptyScript,
-    state: 'default',
+    state: !useWorkspace ? 'present' : 'absent',
   });
 
   // test
@@ -105,16 +116,6 @@ function task() {
     script: npmRunAll(project.test),
     state: 'present',
   });
-  pkg.script(packageFile, {
-    name: `${project.prepare}:empty`,
-    script: pkg.emptyScript,
-    state: 'default',
-  });
-  pkg.script(packageFile, {
-    name: `${project.prepare}:packages`,
-    script: turboRun(project.prepare),
-    state: useWorkspace ? 'present' : 'absent',
-  });
   pkg.script(packageFile, {
     name: project.validate,
     script: `${npmRun(project.build)} && ${npmRun(project.lint)} && ${npmRun(project.test)}`,
@@ -136,9 +137,14 @@ function task() {
   });
   pkg.script(packageFile, {
     name: `${project.prepare}:empty`,
-    script: pkg.emptyScript,
+    script: !useWorkspace ? 'present' : 'absent',
     state: 'default',
   });
+  pkg.script(packageFile, {
+    name: `${project.prepare}:packages`,
+    script: turboRun(project.prepare),
+    state: useWorkspace ? 'present' : 'absent',
+  });
 
   // rescue
   pkg.script(packageFile, {
@@ -155,25 +161,7 @@ function task() {
   });
 
   // workspace
-  const turboConfig = json('turbo.json', {
-    $schema: 'https://turborepo.org/schema.json',
-    pipeline: {
-      [project.build]: {
-        dependsOn: ['^build'],
-        outputs: ['lib/**', 'dist/**', '.next/**'],
-      },
-      [project.test]: {},
-      [project.lint]: {},
-      [project.format]: {},
-      [project.clean]: {
-        cache: false,
-      },
-      [project.develop]: {
-        cache: false,
-      },
-    },
-    globalDependencies: ['tsconfig.settings.json'],
-  });
+
   const lernaConfig = json('lerna.json', {
     version: packageFile.get('version'),
   });
@@ -195,12 +183,10 @@ function task() {
       useWorkspaces: useWorkspace,
     });
     lernaConfig.save();
-    turboConfig.save();
     makeDirs('packages');
   } else {
     packageFile.unset('workspaces');
     lernaConfig.delete();
-    turboConfig.delete();
   }
 
   // Engine
@@ -217,6 +203,33 @@ function task() {
   );
   packageFile.save();
 
+  // Turbo config
+  turbo({
+    state: useWorkspace ? 'present' : 'absent',
+    update: (_) => ({
+      ..._,
+      pipeline: {
+        [project.build]: {
+          dependsOn: ['^build'],
+          outputs: ['lib/**', 'dist/**', '.next/**'],
+        },
+        [project.test]: {},
+        [project.lint]: {},
+        [project.prepare]: {},
+        [project.format]: {},
+        [project.docs]: {},
+        [project.spellcheck]: {},
+        [project.clean]: {
+          cache: false,
+        },
+        [project.develop]: {
+          cache: false,
+        },
+      },
+      globalDependencies: ['tsconfig.settings.json'],
+    }),
+  });
+
   // Dependencies
   npm.dependency({
     dev: true,
@@ -225,7 +238,7 @@ function task() {
   });
   npm.dependency({
     dev: true,
-    name: ['lerna', 'turbo'],
+    name: ['lerna'],
     state: useWorkspace ? 'present' : 'absent',
   });