@w5s/mrm-preset 1.0.0-alpha.9 → 1.0.1

package/README.md

@@ -1,11 +1,11 @@
-<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=# W5s Mrm Preset _(${name})_) -->
+<!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=# W5s Mrm Preset _(${name})_) -->
 # W5s Mrm Preset _(@w5s/mrm-preset)_
 <!-- AUTO-GENERATED-CONTENT:END -->
 
 [![NPM Version][package-version-svg]][package-url]
 [![License][license-image]][license-url]
 
-<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=> ${description}&unknownTxt= ) -->
+<!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=> ${description}&unknownTxt= ) -->
 > Mrm configuration presets
 <!-- AUTO-GENERATED-CONTENT:END -->
 
@@ -19,7 +19,7 @@ Initialize your project using this command :
 
 ```bash
 # from the root of your project
-npm exec --package=@w5s/mrm-preset -- mrm bootstrap --preset @w5s/mrm-preset
+npm exec --package=@w5s/mrm-preset --package=mrm -- mrm bootstrap --preset @w5s/mrm-preset
 ```
 
 This will install in `package.json` the npm scripts
@@ -38,19 +38,19 @@ npm run configure
 ```
 
 ## License
-<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=[${license}][license-url] © ${author}) -->
+<!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=[${license}][license-url] © ${author}) -->
 [MIT][license-url] © Julien Polo <julien.polo@gmail.com>
 <!-- AUTO-GENERATED-CONTENT:END -->
 
 <!-- VARIABLES -->
 
-<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=[package-version-svg]: https://img.shields.io/npm/v/${name}.svg?style=flat-square) -->
+<!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=[package-version-svg]: https://img.shields.io/npm/v/${name}.svg?style=flat-square) -->
 [package-version-svg]: https://img.shields.io/npm/v/@w5s/mrm-preset.svg?style=flat-square
 <!-- AUTO-GENERATED-CONTENT:END -->
-<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=[package-url]: https://www.npmjs.com/package/${name}) -->
+<!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=[package-url]: https://www.npmjs.com/package/${name}) -->
 [package-url]: https://www.npmjs.com/package/@w5s/mrm-preset
 <!-- AUTO-GENERATED-CONTENT:END -->
-<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=[license-image]: https://img.shields.io/badge/license-${license}-green.svg?style=flat-square) -->
+<!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=[license-image]: https://img.shields.io/badge/license-${license}-green.svg?style=flat-square) -->
 [license-image]: https://img.shields.io/badge/license-MIT-green.svg?style=flat-square
 <!-- AUTO-GENERATED-CONTENT:END -->
 [license-url]: ../../LICENSE

package/bootstrap/README.md

@@ -1,5 +1,5 @@
 # Bootstrap task
 
 ```bash
-npm exec -p mrm -p @w5s/mrm-preset -- mrm bootstrap --preset @w5s/mrm-preset
+npm exec --package=mrm --package=@w5s/mrm-preset@latest -- mrm bootstrap --preset @w5s/mrm-preset
 ```

package/bootstrap/index.js

@@ -1,9 +1,8 @@
-/* eslint-disable sort-keys-fix/sort-keys-fix */
-const path = require('path');
-const { packageJson, file } = require('mrm-core');
-const npm = require('../core/npm');
-const pkg = require('../core/pkg');
-const { gitIgnoreTemplate } = require('../core/git');
+const path = require('node:path');
+const { packageJson } = require('mrm-core');
+const npm = require('../core/npm.js');
+const pkg = require('../core/pkg.js');
+const { gitIgnoreTemplate } = require('../core/git.js');
 
 /**
  * @param {{
@@ -14,7 +13,7 @@ const { gitIgnoreTemplate } = require('../core/git');
  * }} config
  * @returns {void}
  */
-function task({ mrmPreset, mrmTask, packageArchetype, packageManager }) {
+function task({ mrmPreset, mrmTask, packageManager }) {
   /**
    * setup package.json from following object
    */
@@ -30,40 +29,23 @@ function task({ mrmPreset, mrmTask, packageArchetype, packageManager }) {
 
   npm.bootstrap(packageManager);
 
-  npm.dependency({
-    dev: true,
-    name: ['mrm', mrmPreset],
-    state: 'present',
-  });
+  // npm.dependency({
+  //   dev: true,
+  //   name: ['mrm', mrmPreset],
+  //   state: 'present',
+  // });
 
   pkg.withPackageJson((packageFile) => {
-    const currentPackageManager = pkg.manager(packageFile);
-
     // Add MRM default scripts
     pkg.script(packageFile, {
       name: 'configure',
-      state: 'default',
-      script: currentPackageManager === 'npm' ? `npm run mrm -- ${mrmTask}` : `yarn mrm ${mrmTask}`,
+      state: 'present',
+      default: `npm run mrm -- ${mrmTask}`,
     });
     pkg.script(packageFile, {
       name: 'mrm',
-      state: 'default',
-      script: `mrm --preset ${mrmPreset}`,
-    });
-  });
-
-  pkg.withPackageJson((packageFile) => {
-    pkg.value(packageFile, {
-      path: 'mrmConfig.packageArchetype',
       state: 'present',
-      update: packageArchetype,
-      default: () => {
-        if (file('lerna.json').exists() || Boolean(packageFile.get('workspaces'))) {
-          return 'workspace';
-        }
-
-        return 'library';
-      },
+      default: `npm exec --package=mrm --package=${mrmPreset}@latest -- mrm --preset ${mrmPreset}`,
     });
   });
 }
@@ -81,12 +63,6 @@ task.parameters = {
     message: 'Default MRM task name ?',
     type: 'input',
   },
-  packageArchetype: {
-    choices: ['library', 'application', 'workspace'],
-    message: 'What Archetype of package ?',
-    name: 'packageArchetype',
-    type: 'input',
-  },
   packageManager: {
     default: 'yarn@berry',
     choices: ['yarn@berry', 'yarn@classic', 'npm'],

package/ci/_gitlab/AutoDevops.gitlab-ci.yml

@@ -1,4 +1,4 @@
-##
+#
 # Follow the following standards
 #
 # @ref https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Auto-DevOps.gitlab-ci.yml
@@ -69,7 +69,6 @@ code_analysis:
   variables:
     CODE_ANALYSIS_HOUR: 7 # 7h UTC => 9h Paris
     # CODE_ANALYSIS_DISABLED: "🛑"
-
 # deploy_production:
 #   extends:
 #     - .autodevops_trigger_deploy

package/ci/_gitlab/AutoDevopsInclude.gitlab-ci.yml

@@ -4,21 +4,19 @@ include:
 
 # Default variables
 variables:
-
-
   # To activate the auto release
-  AUTO_DEVOPS_QUALITY_WHEN: 'always' # 'always'|'never'
-  AUTO_DEVOPS_TEST_WHEN: 'always' # 'always'|'never'
-  AUTO_DEVOPS_RELEASE_WHEN: 'manual' # 'on_success'|'manual'|'never'
-  AUTO_DEVOPS_DEPLOY_ALLOW: 'tag' # 'tag'|'any'
-  AUTO_DEVOPS_DEPLOY_WHEN: 'manual' # 'on_success'|'manual'|'never'
+  AUTO_DEVOPS_QUALITY_WHEN: always # 'always'|'never'
+  AUTO_DEVOPS_TEST_WHEN: always # 'always'|'never'
+  AUTO_DEVOPS_RELEASE_WHEN: manual # 'on_success'|'manual'|'never'
+  AUTO_DEVOPS_DEPLOY_ALLOW: tag # 'tag'|'any'
+  AUTO_DEVOPS_DEPLOY_WHEN: manual # 'on_success'|'manual'|'never'
 
   # Renovate variable
   # RENOVATE_DISABLED: "🛑"
 
-  ##
+  # #
   # Contextual variables
-  ##
+  # #
   # DEPLOY_ENVIRONMENT: production,staging,...
   # RENOVATE: true|false
 
@@ -33,14 +31,14 @@ variables:
       if: '$CI_PIPELINE_SOURCE == "schedule"'
       when: never
     - &autodevops_renovate_skip_rule
-      if: "$RENOVATE"
+      if: $RENOVATE
       when: never
     - &autodevops_default_branch_only_rule
-      if: '$CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
+      if: $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH
       when: never
     - when: on_success
 
-##
+# #
 # Generic trait for a trigger button for release stage
 #
 .autodevops_trigger_release:
@@ -53,7 +51,9 @@ variables:
     - <<: *autodevops_default_branch_only_rule
     - if: "$AUTO_DEVOPS_RELEASE_WHEN == 'never'"
       when: never
-    - if: "$CI_COMMIT_TAG"
+    - if: $CI_COMMIT_TAG
+      when: never
+    - if: $CI_COMMIT_MESSAGE =~ /🔖 /
       when: never
     - if: $CI_COMMIT_MESSAGE =~ /chore\(release\):/
       when: never
@@ -75,7 +75,7 @@ variables:
     - npm config set '//registry.npmjs.org/:_authToken' "${NPM_TOKEN}"
     - npm run release
 
-##
+# #
 # Generic trait for a trigger button for deploy stage.
 # Use DEPLOY_ENVIRONMENT variable to choose environment
 #
@@ -176,7 +176,7 @@ variables:
     CODE_ANALYSIS_HOUR: 7 # 7h UTC => 9h Paris
     # CODE_ANALYSIS_DISABLED: "🛑"
   rules:
-    - if: "$CODE_ANALYSIS_DISABLED"
+    - if: $CODE_ANALYSIS_DISABLED
       when: never
     - if: '$CI_PIPELINE_SOURCE == "schedule"'
       when: always
@@ -226,9 +226,9 @@ variables:
     expire_in: 1 week
     paths:
       - dist
-      - "packages/*/dist"
+      - 'packages/*/dist'
       - lib
-      - "packages/*/lib"
+      - 'packages/*/lib'
       - node_modules
 
 .autodevops_node_docs:
@@ -242,9 +242,9 @@ variables:
 .autodevops_renovate:
   stage: prepare
   rules:
-    - if: "$RENOVATE_DISABLED"
+    - if: $RENOVATE_DISABLED
       when: never
-    - if: "$RENOVATE"
+    - if: $RENOVATE
       when: always
     - when: never
   extends:

package/ci/_gitlab/Renovate.gitlab-ci.yml

@@ -1,20 +1,20 @@
 # https://fotoallerlei.com/blog/post/2020/automatic-dependency-updates-with-renovate-and-gitlab/post
 .renovate:
   variables:
-    RENOVATE_GIT_AUTHOR: "${GITLAB_USER_NAME} <${GITLAB_USER_EMAIL}>"
-    RENOVATE_DRY_RUN: "false"
-    RENOVATE_LOG_LEVEL: "debug"
-    RENOVATE_ALLOWED_POST_UPGRADE: "^pod ,^yarn "
+    RENOVATE_GIT_AUTHOR: '${GITLAB_USER_NAME} <${GITLAB_USER_EMAIL}>'
+    RENOVATE_DRY_RUN: 'false'
+    RENOVATE_LOG_LEVEL: debug
+    RENOVATE_ALLOWED_POST_UPGRADE: '^pod ,^yarn '
     # RENOVATE_DISABLED: "🛑"
   rules:
-    - if: "$RENOVATE_DISABLED"
+    - if: $RENOVATE_DISABLED
       when: never
     - if: '$CI_PIPELINE_SOURCE == "schedule"'
       when: always
     - when: never
   image:
     name: renovate/renovate
-    entrypoint: [""]
+    entrypoint: ['']
   script:
     - >
       renovate

package/ci/github.js

@@ -0,0 +1,53 @@
+const { packageJson } = require('mrm-core');
+const githubCI = require('../core/githubCI.js');
+const pkg = require('../core/pkg.js');
+
+function task() {
+  const state = 'present';
+  const packageManager = pkg.manager(packageJson());
+  const baseBranch = 'main';
+  const packageInstall =
+    packageManager === 'npm'
+      ? `${packageManager} ci`
+      : packageManager === 'yarn'
+      ? `${packageManager} install --frozen-lockfile`
+      : `${packageManager} install`;
+  githubCI.workflow({
+    name: 'node.js.yml',
+    state,
+    update: (config) => ({
+      name: 'Node.js CI',
+      ...config,
+      on: {
+        push: {
+          branches: [baseBranch],
+        },
+        pull_request: {
+          branches: [baseBranch],
+        },
+      },
+      jobs: {
+        ...config.jobs,
+        build: {
+          'runs-on': 'ubuntu-latest',
+          steps: [
+            { uses: 'actions/checkout@v3' },
+            {
+              name: 'Use Node.js',
+              uses: 'actions/setup-node@v3',
+              with: {
+                'node-version': 'lts/*',
+                cache: packageManager,
+              },
+            },
+            { run: packageInstall },
+            { run: `${packageManager} run build` },
+            { run: `${packageManager} validate` },
+          ],
+        },
+      },
+    }),
+  });
+}
+
+module.exports = task;

package/ci/gitlab.js

@@ -1,5 +1,4 @@
-/* eslint-disable global-require, sort-keys-fix/sort-keys-fix */
-const path = require('path');
+const path = require('node:path');
 const { yaml } = require('mrm-core');
 
 /** @type {typeof import('sync-directory')['default']} */

package/ci/index.js

@@ -1,11 +1,16 @@
-const gitlabCI = require('../core/gitlabCI');
-const gitlab = require('./gitlab');
+const gitlabCI = require('../core/gitlabCI.js');
+const githubCI = require('../core/githubCI.js');
+const gitlab = require('./gitlab.js');
+const github = require('./github.js');
 
 function task() {
   // check gitlab support
   if (gitlabCI.isSupported()) {
     gitlab();
   }
+  if (githubCI.isSupported()) {
+    github();
+  }
 }
 
 task.description = 'Setup Continuous Integration';

package/commitlint/index.js

@@ -1,5 +1,6 @@
-const { commitlint } = require('../core/commitlint');
-const { hasGit } = require('../core/git');
+const { vscodeRecommendedExtension } = require('../core/vscode.js');
+const { commitlint } = require('../core/commitlint.js');
+const { hasGit } = require('../core/git.js');
 
 /**
  *
@@ -21,6 +22,11 @@ function createCommitLint({ commitLintPreset: commitLintPresetDefault }) {
       preset: commitLintPreset,
       state: gitPresent ? 'present' : 'absent',
     });
+
+    vscodeRecommendedExtension({
+      name: 'seatonjiang.gitmoji-vscode',
+      state: gitPresent ? 'present' : 'absent',
+    });
   }
 
   task.description = 'Setup CommitLint';

package/config.json

@@ -4,6 +4,7 @@
       "gitignore",
       "project",
       "contributing",
+      "licenses",
       "release",
       "ci",
       "lang",
@@ -11,7 +12,7 @@
       "editorconfig",
       "eslint",
       "cspell",
-      "jest",
+      "vitest",
       "renovate",
       "githooks",
       "postconfigure"

package/contributing/index.js

@@ -1,4 +1,4 @@
-const path = require('path');
+const path = require('node:path');
 const { file } = require('mrm-core');
 
 function task() {

package/core/commitlint.js

@@ -1,6 +1,6 @@
-const pkg = require('./pkg');
-const npm = require('./npm');
-const { gitHook } = require('./githooks');
+const pkg = require('./pkg.js');
+const npm = require('./npm.js');
+const { gitHook } = require('./githooks.js');
 
 /**
  * @param {{
@@ -23,13 +23,13 @@ function commitlint({ state, preset }) {
 
   gitHook({
     name: 'commit-msg',
-    content: 'npm exec --no -- commitlint --edit $1',
+    content: 'npm exec -- commitlint --edit $1',
     state,
   });
 
   npm.dependency({
     dev: true,
-    name: ['@commitlint/cli', preset],
+    name: [preset],
     state,
   });
 }

package/core/cspell.js

@@ -1,6 +1,5 @@
 const { json } = require('mrm-core');
-const pkg = require('./pkg');
-const npm = require('./npm');
+const npm = require('./npm.js');
 /**
  * @typedef {{
  *   version: '0.2',
@@ -22,15 +21,7 @@ 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', {
+  const cSpellFile = json('.cspell.json', {
     version: '0.2',
     language: 'en',
     words: [],

package/core/eslint.js

@@ -1,14 +1,29 @@
 const { packageJson } = require('mrm-core');
-
+const jsonFile = require('./jsonFile.js');
+/**
+ * @typedef {import('eslint').Linter.Config} ESLintConfig
+ */
 /**
- * @param {import('eslint').Linter.Config} config
+ * @param {{
+ *   state: 'present'|'absent',
+ *   update: (config: ESLintConfig) => ESLintConfig
+ * }} config
  */
-function eslintConfig(config) {
+function eslintConfig({ state, update }) {
   const packageFile = packageJson();
-  packageFile.merge({ eslintConfig: config });
+
+  jsonFile.value(packageFile, {
+    path: 'eslintConfig',
+    state,
+    // @ts-ignore
+    update,
+    /** @type {ESLintConfig} */
+    // @ts-ignore
+    default: {},
+  });
+
   packageFile.save();
 }
-exports.eslintConfig = eslintConfig;
 
 /**
  *
@@ -19,4 +34,8 @@ function eslintIgnore(ignorePatterns) {
   packageFile.merge({ eslintIgnore: ignorePatterns });
   packageFile.save();
 }
-exports.eslintIgnore = eslintIgnore;
+
+module.exports = {
+  eslintConfig,
+  eslintIgnore,
+};

package/core/git.js

@@ -1,30 +1,14 @@
 const { file, ini } = require('mrm-core');
-const block = require('./block');
-
+const block = require('./block.js');
+const templateMap = require('./git.ignore.js');
 /**
  *
  */
 function remoteSync() {
   try {
     const gitConfig = ini('.git/config');
-    const remoteURL = gitConfig.get('[remote "origin"]').url;
-
-    return remoteURL
-      ? [
-          /**
-           * 1. filter github URL
-           *
-           * @param {string} returnValue
-           */
-          (returnValue) => returnValue.replace(/^git@github.com:/, 'https://github.com/'),
-          /**
-           * 2. filter gitlab URL
-           *
-           * @param {string} returnValue
-           */
-          (returnValue) => returnValue.replace(/^git@gitlab.com:/, 'https://gitlab.com/'),
-        ].reduce((returnValue, filter) => filter(returnValue), remoteURL)
-      : remoteURL;
+    const remoteURL = gitConfig.get('remote "origin"').url.trim();
+    return remoteURL;
   } catch {
     // ignore error
   }
@@ -68,9 +52,6 @@ exports.gitIgnore = gitIgnore;
  * @param {string[]} flags
  */
 function gitIgnoreTemplate(flags) {
-  // eslint-disable-next-line global-require, import/no-dynamic-require
-  const templateMap = require('./git.ignore');
-
   flags.forEach((flag) => {
     // @ts-ignore
     if (templateMap[flag]) {

package/core/githooks.js

@@ -1,10 +1,12 @@
-const { execSync } = require('child_process');
-const path = require('path');
-const { file, packageJson, makeDirs } = require('mrm-core');
-const project = require('./project');
-const npm = require('./npm');
-const pkg = require('./pkg');
-const block = require('./block');
+const { execSync } = require('node:child_process');
+const path = require('node:path');
+const { file, makeDirs } = require('mrm-core');
+const project = require('./project.js');
+const npm = require('./npm.js');
+const pkg = require('./pkg.js');
+const block = require('./block.js');
+
+const hookDirectory = '.githooks';
 
 /**
  * @param {{
@@ -17,21 +19,14 @@ function husky({ state }) {
   npm.dependency({
     dev: true,
     name: ['husky'],
-    state: hasHusky ? 'present' : 'absent',
+    state: 'absent',
   });
-  if (hasHusky) {
-    npm.dependency({
-      dev: true,
-      name: ['is-ci'],
-      state: 'present',
-    });
-  }
 
   pkg.withPackageJson((packageFile) => {
     pkg.script(packageFile, {
-      name: `${project.prepare}:husky`,
+      name: `${project.prepare}:githooks`,
       state: hasHusky ? 'present' : 'absent',
-      script: 'is-ci || husky install',
+      update: `[ -n "\${CI:-}" ] || npx husky install ${hookDirectory}`,
     });
   });
 }
@@ -44,10 +39,7 @@ function husky({ state }) {
  * }} options
  */
 function gitHook({ name, state, content }) {
-  const packageFileDefault = packageJson();
-  const hasHusky = pkg.hasDependency(packageFileDefault, 'husky', 'dev');
-  const hasGitHook = hasHusky && state === 'present';
-  const hookDirectory = '.husky';
+  const hasGitHook = state === 'present';
   const hookFileName = path.join(hookDirectory, name);
   if (hasGitHook) {
     makeDirs(hookDirectory);

package/core/githubCI.js

@@ -0,0 +1,56 @@
+const { yaml } = require('mrm-core');
+const path = require('node:path');
+const fs = require('node:fs');
+
+const FILE_PATH = '.github/workflows';
+
+function isSupported() {
+  return fs.existsSync(FILE_PATH);
+}
+exports.isSupported = isSupported;
+
+/**
+ * @typedef { string | {
+ *  group: string,
+ *  'cancel-in-progress': boolean,
+ * }} GithubWorkflowConcurrency
+ */
+// TODO: add strict typing
+/**
+ * @typedef {{
+ *  name?: string,
+ *  jobs?: Record<string, any>
+ *  on?: any,
+ *  env?: Record<string, string>,
+ *  permissions?: any,
+ *  defaults?: Record<string, any>,
+ *  concurrency?: GithubWorkflowConcurrency,
+ * }} GithubWorkflowConfig
+ */
+
+/**
+ * @param {{
+ *   state: 'present'|'absent',
+ *   name: string,
+ *   update?: (config: GithubWorkflowConfig) => GithubWorkflowConfig
+ * }} options
+ */
+function workflow({ name, state, update }) {
+  const workflowFile = yaml(path.join(FILE_PATH, name));
+  if (state === 'present') {
+    /** @type {GithubWorkflowConfig} */
+    let value = workflowFile.get() || {
+      jobs: {},
+    };
+    if (update) {
+      value = update(value);
+      // @ts-ignore
+      workflowFile.set(value);
+    }
+
+    workflowFile.save();
+  } else {
+    workflowFile.delete();
+  }
+}
+exports.workflow = workflow;