@w5s/mrm-preset 1.0.0-alpha.8 → 1.0.0

package/eslint/index.js

@@ -1,91 +1,129 @@
 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 { eslintConfig } = require('../core/eslint.js');
+const project = require('../core/project.js');
+const { vscodeSettings, vscodeRecommendedExtension } = require('../core/vscode.js');
 
 function createESLint({ eslintPreset: eslintPresetDefault = 'eslint:recommended' }) {
   /**
    *
    * @param {{
    *   eslintPreset: string,
-   *   eslintRules: Record<string, any>
    * }} config
    */
-  function task({ eslintPreset, eslintRules }) {
+  function task({ eslintPreset }) {
     const packageFileDefault = packageJson();
+    const hasWorkspaces = pkg.hasWorkspaces(packageFileDefault);
     const hasTypescript = pkg.hasDependency(packageFileDefault, 'typescript', 'dev');
     const hasJSX = true;
     const hasJSON = true;
+    const hasYAML = true;
 
     // Should be added first
     gitIgnore('ESLint', ['.eslintcache']);
-    eslintIgnore([
-      // List of paths to ignore
-      'node_modules/',
-      'coverage/',
-      'build/',
-      '.cache/',
-      '**/tsconfig.json',
-      '.vscode/**',
-      'public/',
-    ]);
 
     // Dependencies
     npm.dependency({
       dev: true,
-      name: ['eslint', '@babel/core', '@babel/eslint-parser', 'prettier'],
+      name: ['eslint', 'prettier'],
       state: 'present',
     });
 
-    // Clean legacy
-    npm.dependency({
-      dev: true,
-      name: ['@typescript-eslint/parser', '@typescript-eslint/eslint-plugin', 'babel-eslint'],
-      state: 'absent',
-    });
-
     // Preset
     npm.dependency({
       dev: true,
       name: eslintPreset,
-      state: !eslintPreset.startsWith('eslint:') ? 'present' : 'absent',
+      state: eslintPreset.startsWith('eslint:') ? 'absent' : 'present',
     });
     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,
       tsx: hasTypescript && hasJSX,
       json: hasJSON,
+      jsonc: hasJSON,
+      json5: hasJSON,
+      yml: hasYAML,
+      yaml: hasYAML,
     };
     const extList = Object.keys(extsMap).filter((ext) => extsMap[ext]);
     const extOption = ` --ext=${extList.join(',')}`;
 
     pkg.withPackageJson((packageFile) => {
+      const ignorePatterns = pkg
+        .listWorkspaceMatchers(packageFile)
+        .map((_) => ` --ignore-pattern='${_}/**'`)
+        .join('');
+
+      // workspaces
       pkg.script(packageFile, {
-        name: project.lint,
-        script: `eslint . --cache${extOption}`,
+        name: `${project.lint}:root`,
+        update: `eslint .${extOption}${hasWorkspaces ? ignorePatterns : ''}`,
         state: 'present',
       });
       pkg.script(packageFile, {
-        name: project.format,
-        script: `eslint . --quiet --cache --fix${extOption}`,
+        name: `${project.format}:root`,
+        update: `eslint .${extOption}${hasWorkspaces ? ignorePatterns : ''} --fix`,
+        state: 'present',
+      });
+
+      // clean
+      pkg.script(packageFile, {
+        name: `${project.lint}:packages`,
+        state: 'absent',
+      });
+      pkg.script(packageFile, {
+        name: `${project.format}:packages`,
+        state: 'absent',
+      });
+      pkg.script(packageFile, {
+        name: `${project.lint}:src`,
+        state: 'absent',
+      });
+      pkg.script(packageFile, {
+        name: `${project.format}:src`,
+        state: 'absent',
+      });
+    });
+    pkg.forEachWorkspace(({ packageFile }) => {
+      const updater = (/** @type {boolean} */ format) => (/** @type {string} */ _) =>
+        _ == null || _ === '' || _.trimStart().startsWith('eslint')
+          ? `eslint .${format ? ' --fix' : ''}${extOption}`
+          : _;
+      pkg.script(packageFile, {
+        name: `${project.lint}:src`,
+        update: updater(),
+        state: 'present',
+      });
+      pkg.script(packageFile, {
+        name: `${project.format}:src`,
+        update: updater(true),
         state: 'present',
       });
     });
 
     // VSCode support
+    vscodeRecommendedExtension({
+      name: 'dbaeumer.vscode-eslint',
+      state: 'present',
+    });
     vscodeSettings({
       state: 'present',
       update: (settings) => ({
@@ -93,14 +131,22 @@ 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',
+                  yaml: 'yaml',
+                  yml: 'yaml',
+                }[ext] || ext)
+            )
+          )
         ),
       }),
     });
@@ -113,9 +159,6 @@ function createESLint({ eslintPreset: eslintPresetDefault = 'eslint:recommended'
       message: 'Enter ESLint preset name',
       type: 'input',
     },
-    eslintRules: {
-      type: 'config',
-    },
   };
 
   return task;

package/githooks/index.js

@@ -1,17 +1,16 @@
-const path = require('path');
+const path = require('node:path');
 const { packageJson, template } = require('mrm-core');
-const project = require('../core/project');
-const pkg = require('../core/pkg');
-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 task() {
   const gitSupported = hasGit();
   const packageFile = packageJson();
   const hasESLint = pkg.hasDependency(packageFile, 'eslint', 'dev');
-  const hasTsc = pkg.hasDependency(packageFile, 'typescript', 'dev');
 
   husky({
     state: gitSupported ? 'present' : 'absent',
@@ -20,14 +19,19 @@ function task() {
     state: gitSupported ? 'present' : 'absent',
     update: (config) => ({
       ...config,
-      '*.json': [...(hasESLint ? ['eslint'] : [])],
-      '*.js?(x)': [...(hasTsc ? ["bash -c 'tsc --noEmit'"] : []), ...(hasESLint ? ['eslint'] : [])],
-      '*.ts?(x)': [...(hasTsc ? ["bash -c 'tsc --noEmit'"] : []), ...(hasESLint ? ['eslint'] : [])],
+      '*.{json,jsonc,json5}': [...(hasESLint ? ['eslint'] : [])],
+      '*.{yml,yaml}': [...(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`,
+    content: `npm exec -- lint-staged`,
     state: gitSupported ? 'present' : 'absent',
   });
   gitHook({

package/gitignore/index.js

@@ -1,4 +1,4 @@
-const { gitIgnoreTemplate } = require('../core/git');
+const { gitIgnoreTemplate } = require('../core/git.js');
 
 function task() {
   gitIgnoreTemplate(['macOS', 'NodeJS', 'VisualStudioCode']);

package/lang/.eslintrc.json

@@ -5,7 +5,5 @@
     "@typescript-eslint/no-unsafe-assignment": "off",
     "@typescript-eslint/no-unsafe-member-access": "off"
   },
-  "ignorePatterns": [
-    "**/templates/*.ts"
-  ]
+  "ignorePatterns": ["**/templates/*.ts"]
 }

package/lang/index.js

@@ -1,11 +1,10 @@
-const path = require('path');
+const path = require('node:path');
 const { json, file, template, packageJson } = require('mrm-core');
-const npm = require('../core/npm');
-const { gitIgnore } = require('../core/git');
-const project = require('../core/project');
-const { eslintIgnore } = require('../core/eslint');
-const { typedoc } = require('../core/typedoc');
-const pkg = require('../core/pkg');
+const npm = require('../core/npm.js');
+const { gitIgnore } = require('../core/git.js');
+const project = require('../core/project.js');
+// const { typedoc } = require('../core/typedoc.js');
+const pkg = require('../core/pkg.js');
 
 /**
  *
@@ -27,7 +26,7 @@ function createLang({ language: languageDefault = 'typescript', tsConfig: tsConf
   task.typescript = () => {
     const tsConfigPreset = tsConfigDefault;
     const packageFile = packageJson();
-    const isApplication = packageFile.get('mrmConfig.packageArchetype') === 'application';
+    const isApplication = pkg.archetype(packageFile) === 'application';
     const hasWorkspaces = pkg.hasWorkspaces(packageFile);
     const tsConfigSettingsName = 'tsconfig.settings.json';
     const tsConfigSettings = json(tsConfigSettingsName);
@@ -35,25 +34,63 @@ function createLang({ language: languageDefault = 'typescript', tsConfig: tsConf
 
     // Should be run first
     gitIgnore('Typescript', ['lib/', '*.tsbuildinfo', 'typings/']);
-    eslintIgnore(['lib/']);
 
+    // const excludeList = ['**/*.test.*', '**/*.spec.*', '**/__tests__/**'];
     if (hasWorkspaces) {
       tsConfig
         .unset('compilerOptions.rootDir')
         .unset('compilerOptions.outDir')
         .unset('include')
         .merge({
-          $schema: 'https://json.schemastore.org/tsconfig',
+          $schema: 'https://json.schemastore.org/tsconfig.json',
           extends: `./${tsConfigSettingsName}`,
         })
         .save();
 
       file('src/index.ts').delete();
       file('src/index.spec.ts').delete();
+
+      pkg.forEachWorkspace(({ projectDir, packageFile: projectPackageFile }) => {
+        const projectTsConfig = json(`${projectDir}/tsconfig.json`);
+        const projectTsConfigBuild = json(`${projectDir}/tsconfig.build.json`);
+        const hasTypecript = projectTsConfig.exists();
+        pkg.script(projectPackageFile, {
+          name: 'build:tsc',
+          state: hasTypecript ? 'present' : 'absent',
+          update: () => 'tsc -b tsconfig.build.json',
+        });
+        pkg.script(projectPackageFile, {
+          name: 'clean:tsc',
+          state: hasTypecript ? 'present' : 'absent',
+          update: () => 'rm -rf lib',
+        });
+        if (hasTypecript && projectPackageFile.get('name') !== '@w5s/ts-config') {
+          projectTsConfig
+            .merge({
+              $schema: 'https://json.schemastore.org/tsconfig.json',
+              extends: '../../tsconfig.settings.json',
+            })
+            .save();
+
+          projectTsConfigBuild
+            .merge({
+              $schema: 'https://json.schemastore.org/tsconfig.json',
+              extends: './tsconfig.json',
+              compilerOptions: {
+                noEmit: false,
+                outDir: 'lib',
+              },
+              include: ['src'],
+            })
+            .save();
+        } else {
+          projectTsConfigBuild.delete();
+        }
+      });
     } else {
       tsConfigSettings
         .merge({
-          $schema: 'https://json.schemastore.org/tsconfig',
+          $schema: 'https://json.schemastore.org/tsconfig.json',
           compilerOptions: {},
           extends: tsConfigPreset,
         })
@@ -65,7 +102,7 @@ function createLang({ language: languageDefault = 'typescript', tsConfig: tsConf
             rootDir: './src',
           },
           extends: `./${tsConfigSettingsName}`,
-          include: ['./src'],
+          include: ['src'],
         })
         .save();
 
@@ -83,7 +120,7 @@ function createLang({ language: languageDefault = 'typescript', tsConfig: tsConf
       if (isApplication) {
         pkg.script(_packageFile, {
           name: project.develop,
-          script:
+          update:
             "NODE_ENV=development ts-node-dev --require='tsconfig-paths/register' -r dotenv/config -- ./src/index.ts dotenv_config_path=.env",
           state: 'present',
         });
@@ -102,29 +139,29 @@ function createLang({ language: languageDefault = 'typescript', tsConfig: tsConf
       state: 'present',
     });
 
-    typedoc({
-      state: 'present',
-      update: (config) => ({
-        // Default values
-        tsconfig: 'tsconfig.json',
-        excludePrivate: true,
-        excludeExternals: true,
-        readme: 'README.md',
-        theme: 'default',
-        // Inherits current
-        ...config,
-        // Force values
-        out: 'public',
-        exclude: [
-          '**/build/**/*',
-          '**/example/**/*',
-          '**/lib/**/*',
-          '**/node_modules/**',
-          '**/__tests__/*.(ts|tsx)',
-          '**/*.(spec|test).(ts|tsx)',
-        ],
-      }),
-    });
+    // typedoc({
+    //   state: isApplication ? 'absent' : 'present',
+    //   update: (config) => ({
+    //     // Default values
+    //     tsconfig: 'tsconfig.json',
+    //     excludePrivate: true,
+    //     excludeExternals: true,
+    //     readme: 'README.md',
+    //     theme: 'default',
+    //     // Inherits current
+    //     ...config,
+    //     // Force values
+    //     out: 'public',
+    //     exclude: [
+    //       '**/build/**/*',
+    //       '**/example/**/*',
+    //       '**/lib/**/*',
+    //       '**/node_modules/**',
+    //       '**/__tests__/*.(ts|tsx)',
+    //       '**/*.(spec|test).(ts|tsx)',
+    //     ],
+    //   }),
+    // });
   };
 
   task.description = 'Setup Programming Language';

package/lang/templates/index.spec.ts

@@ -1,7 +1,8 @@
-import { main } from '.';
+import { describe, it, expect } from 'vitest'
+import { main } from './index.js';
 
 describe('index', () => {
-  test('main', () => {
+  it('main', () => {
     expect(typeof main).toBe('function');
   });
 });

package/lang/templates/index.ts

@@ -2,5 +2,4 @@ export async function main(): Promise<void> {
   // TODO
 }
 
-// eslint-disable-next-line @typescript-eslint/no-floating-promises
-main();
+await main();

package/licenses/index.js

@@ -0,0 +1,26 @@
+const { packageJson } = require('mrm-core');
+const pkg = require('../core/pkg.js');
+const jsonFile = require('../core/jsonFile.js');
+
+function task() {
+  pkg.withPackageJson((packageFile) => {
+    jsonFile.value(packageFile, {
+      path: 'license',
+      state: 'present',
+      default: 'UNLICENSED',
+    });
+  });
+  const license = packageJson().get('license');
+
+  pkg.forEachWorkspace(({ packageFile }) => {
+    jsonFile.value(packageFile, {
+      path: 'license',
+      state: 'present',
+      default: license,
+    });
+  });
+}
+
+task.description = 'Setup License';
+task.parameters = {};
+module.exports = task;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@w5s/mrm-preset",
-  "version": "1.0.0-alpha.8",
+  "version": "1.0.0",
   "description": "Mrm configuration presets",
   "keywords": [
     "mrm",
@@ -13,37 +13,44 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/w5s/project-config.git",
+    "url": "git@github.com:w5s/project-config.git",
     "directory": "packages/mrm-preset"
   },
   "license": "MIT",
   "author": "Julien Polo <julien.polo@gmail.com>",
+  "type": "commonjs",
   "main": "config.json",
   "scripts": {
-    "build": "npm-run-all -p 'build:*'",
-    "build:empty": ":",
+    "build": "concurrently \"npm:build:*\" \":\"",
     "build:tsc": "tsc --noEmit --skipLibCheck",
-    "docs": "md-magic --path '**/*.md' --ignore='node_modules'",
-    "format": "eslint . --fix",
-    "lint": "eslint .",
-    "test": "mkdir _tester; cd _tester; mrm bootstrap --dir ..; mrm configure --dir .."
+    "clean": "concurrently \"npm:clean:*\" \":\"",
+    "docs": "node ../../markdown.mjs",
+    "format": "concurrently \"npm:format:*\" \":\"",
+    "format:src": "eslint . --fix --ext=mjs,cjs,js,jsx,ts,tsx,json,jsonc,json5,yml,yaml",
+    "lint": "concurrently \"npm:lint:*\" \":\"",
+    "lint:src": "eslint . --ext=mjs,cjs,js,jsx,ts,tsx,json,jsonc,json5,yml,yaml",
+    "prepare": "concurrently \"npm:prepare:*\" \":\"",
+    "spellcheck": "cspell --no-progress '**'",
+    "test": "concurrently \"npm:test:*\" \":\"",
+    "test:script": "mkdir _tester; cd _tester; mrm bootstrap --dir ..; mrm configure --dir .."
   },
   "dependencies": {
     "debug": "^4.3.3",
-    "mrm-core": "^6.0.0",
+    "glob": "^8.0.3",
+    "mrm-core": "^7.0.0",
     "semver-intersect": "^1.4.0",
-    "sync-directory": "^4.0.0"
+    "sync-directory": "^6.0.0"
   },
   "devDependencies": {
-    "@types/debug": "^4.1.7",
-    "mrm": "3.0.10"
+    "@types/debug": "4.1.7",
+    "mrm": "4.1.13",
+    "mrm-preset-default": "4.1.11"
   },
   "engines": {
-    "node": ">=12.x",
-    "yarn": ">=1.x"
+    "node": ">=16.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "468c38fd7cd2690ee860d222d360cc10b840dcfd"
+  "gitHead": "20f944de90b5a5c30d6446ced65271ea3fd31c99"
 }

package/postconfigure/index.js

@@ -1,9 +1,17 @@
-const { spawnSync } = require('child_process');
+const { spawnSync } = require('node:child_process');
 const { packageJson } = require('mrm-core');
-const project = require('../core/project');
-const pkg = require('../core/pkg');
+const project = require('../core/project.js');
+const pkg = require('../core/pkg.js');
+const npm = require('../core/npm.js');
 
 function task() {
+  // Remove old deps
+  npm.dependency({
+    dev: true,
+    name: ['is-ci', '@commitlint/cli', 'lint-staged', 'mrm'],
+    state: 'absent',
+  });
+
   const packageFile = packageJson();
   const packageManager = pkg.manager(packageFile);
   const formatResult = spawnSync(packageManager, ['run', project.format]);