@w5s/mrm-preset 1.0.0-alpha.1

package/.eslintignore

@@ -0,0 +1 @@
+_tester

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+
+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.1 (2022-02-12)
+
+
+### Bug Fixes
+
+* correct generate cspell.json ([e638b75](https://github.com/w5s/project-config/commit/e638b75ead5d3ffd34b0c74b95b237d29b542406))
+
+
+### Features
+
+* add cspell check on lint-staged in mrm ([d8a744f](https://github.com/w5s/project-config/commit/d8a744f1f297c2308cd15ce1f19958f9302eee5d))
+* add mrm-preset package ([1409046](https://github.com/w5s/project-config/commit/1409046e772755148f9885ce39c8f86afef4e50d))

package/README.md

@@ -0,0 +1,56 @@
+<!-- AUTO-GENERATED-CONTENT:START (PKGJSON: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= ) -->
+> Mrm configuration presets
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+## Getting Started - App Installation
+
+## Usage
+
+### 1. Install Preset
+
+Initialize your project using this command :
+
+```bash
+# from the root of your project
+npm exec -p mrm -p @w5s/mrm-preset -- mrm bootstrap --preset @w5s/mrm-preset
+```
+
+This will install in `package.json` the npm scripts
+
+- `mrm` : alias to mrm using `@w5s/mrm-preset` by default
+
+- `configure` : runs `npm run mrm -- configure`
+
+### 2. Configure project
+
+After initialization and after any upgrade of `@w5s/mrm-preset`
+
+```bash
+# from the root of your project
+npm run configure
+```
+
+## License
+<!-- AUTO-GENERATED-CONTENT:START (PKGJSON: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) -->
+[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}) -->
+[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) -->
+[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

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

package/bootstrap/index.js

@@ -0,0 +1,97 @@
+/* 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');
+
+/**
+ * @param {{
+ *   mrmPreset: string,
+ *   mrmTask: string,
+ *   packageArchetype: 'application'|'library'|'workspace',
+ *   packageManager: 'npm'|'yarn'
+ * }} config
+ * @returns {void}
+ */
+function task({ mrmPreset, mrmTask, packageArchetype, packageManager }) {
+  /**
+   * setup package.json from following object
+   */
+
+  const packageFile = packageJson({
+    name: path.basename(process.cwd()),
+    version: '1.0.0-alpha.0',
+    private: true,
+    license: 'PRIVATE',
+    description: '',
+  });
+
+  packageFile.merge({
+    scripts: {
+      configure: `npm run mrm -- ${mrmTask}`,
+      mrm: `mrm --preset ${mrmPreset}`,
+    },
+  });
+  pkg.value(packageFile, {
+    path: 'packageManager',
+    state: 'present',
+    update: packageManager,
+    default: () => {
+      if (file('yarn.lock').exists()) {
+        return 'yarn';
+      }
+
+      // return 'npm';
+      return undefined;
+    },
+  });
+  pkg.value(packageFile, {
+    path: 'mrmConfig.packageArchetype',
+    state: 'present',
+    update: packageArchetype,
+    default: () => {
+      if (file('lerna.json').exists() || Boolean(packageFile.get('workspaces'))) {
+        return 'workspace';
+      }
+
+      return 'library';
+    },
+  });
+  packageFile.save();
+
+  npm.dependency({
+    dev: true,
+    name: ['mrm', mrmPreset],
+    yarn: packageManager === 'yarn',
+    state: 'present',
+  });
+}
+
+task.description = 'Bootstrap a new project.';
+// TODO: parameters to improve with strict choices and description (see Inquirer.js)
+task.parameters = {
+  mrmPreset: {
+    default: '@w5s/mrm-preset',
+    message: 'Default MRM preset name ?',
+    type: 'input',
+  },
+  mrmTask: {
+    default: 'configure',
+    message: 'Default MRM task name ?',
+    type: 'input',
+  },
+  packageArchetype: {
+    choices: ['library', 'application', 'workspace'],
+    message: 'What Archetype of package ?',
+    name: 'packageArchetype',
+    type: 'input',
+  },
+  packageManager: {
+    default: 'yarn',
+    choices: ['yarn', 'npm'],
+    message: 'Which default package manager ?',
+    name: 'packageManager',
+    type: 'input',
+  },
+};
+module.exports = task;

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

@@ -0,0 +1,77 @@
+##
+# Follow the following standards
+#
+# @ref https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Auto-DevOps.gitlab-ci.yml
+# @ref https://github.com/SocialGouv/gitlab-ci-yml/
+#
+include:
+  - /.gitlab/AutoDevopsInclude.gitlab-ci.yml
+
+workflow:
+  rules:
+    # Skip GitHub pull requests pipelines
+    - if: $CI_PIPELINE_SOURCE == 'external_pull_request_event'
+      when: never
+    # Otherwise include the job and set to run normally
+    - when: always
+
+stages:
+  - prepare
+  - build
+  - code_quality
+  - registration
+  - release
+  - deploy # Dummy stage, prefer staging, canary and production
+  - staging
+  - canary
+  - production
+  - incremental rollout 10%
+  - incremental rollout 25%
+  - incremental rollout 50%
+  - incremental rollout 100%
+  - performance
+  - cleanup
+
+variables:
+  GIT_STRATEGY: fetch
+  GIT_DEPTH: 5
+
+#
+# Jobs
+#
+install:
+  extends: .autodevops_install
+
+lint:
+  extends: .autodevops_lint
+
+test:
+  extends: .autodevops_test
+
+build:
+  extends: .autodevops_build
+
+release:
+  extends: .autodevops_trigger_release
+
+# register_image:
+#   extends: .autodevops_register_image
+
+renovate:
+  extends: .autodevops_renovate
+
+pages:
+  extends: .autodevops_pages
+
+code_analysis:
+  extends:
+    - .autodevops_code_analysis
+  variables:
+    CODE_ANALYSIS_HOUR: 7 # 7h UTC => 9h Paris
+    # CODE_ANALYSIS_DISABLED: "🛑"
+
+# deploy_production:
+#   extends:
+#     - .autodevops_trigger_deploy
+#   variables:
+#     DEPLOY_ENVIRONMENT: production

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

@@ -0,0 +1,251 @@
+#
+include:
+  - /.gitlab/Renovate.gitlab-ci.yml
+
+# 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'
+
+  # Renovate variable
+  # RENOVATE_DISABLED: "🛑"
+
+  ##
+  # Contextual variables
+  ##
+  # DEPLOY_ENVIRONMENT: production,staging,...
+  # RENOVATE: true|false
+
+#
+# AutoDevops jobs
+#
+
+# Trait to refactor common reusable rules
+.autodevops_base_rules:
+  rules:
+    - &autodevops_schedule_skip_rule
+      if: '$CI_PIPELINE_SOURCE == "schedule"'
+      when: never
+    - &autodevops_renovate_skip_rule
+      if: "$RENOVATE"
+      when: never
+    - &autodevops_default_branch_only_rule
+      if: '$CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
+      when: never
+    - when: on_success
+
+##
+# Generic trait for a trigger button for release stage
+#
+.autodevops_trigger_release:
+  stage: release
+  extends:
+    - .autodevops_node_install
+    - .autodevops_node_image
+  rules:
+    - <<: *autodevops_schedule_skip_rule
+    - <<: *autodevops_default_branch_only_rule
+    - if: "$AUTO_DEVOPS_RELEASE_WHEN == 'never'"
+      when: never
+    - if: "$CI_COMMIT_TAG"
+      when: never
+    - if: $CI_COMMIT_MESSAGE =~ /chore\(release\):/
+      when: never
+    - if: "$AUTO_DEVOPS_RELEASE_WHEN != 'manual'"
+      when: on_success
+    - when: manual
+  needs:
+    - job: install
+      artifacts: true
+    - job: build
+      artifacts: true
+  # Blocking job : https://gitlab.com/gitlab-org/gitlab/-/issues/17768#note_214977686
+  allow_failure: false
+  script:
+    - git config --global user.email "${CI_EMAIL}"
+    - git config --global user.name "${CI_USERNAME}"
+    - git remote set-url origin "https://gitlab-ci-token:$GITLAB_TOKEN@$CI_SERVER_HOST/$CI_PROJECT_PATH.git"
+    - git checkout -B "$CI_COMMIT_REF_NAME" "$CI_COMMIT_SHA"
+    - 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
+#
+# Example:
+# .my_job:
+#   extends: .autodevops_trigger_deploy
+#   variables:
+#     DEPLOY_ENVIRONMENT: "my-prod"
+#
+.autodevops_trigger_deploy:
+  stage: deploy
+  rules:
+    - <<: *autodevops_schedule_skip_rule
+    # Tag based deployment
+    - if: "$AUTO_DEVOPS_DEPLOY_WHEN == 'never'"
+      when: never
+    - if: $AUTO_DEVOPS_DEPLOY_ALLOW == 'tag' && $CI_COMMIT_TAG == null
+      when: never
+    - if: $AUTO_DEVOPS_DEPLOY_ALLOW == 'tag' && $CI_COMMIT_TAG != null && $AUTO_DEVOPS_DEPLOY_WHEN == 'manual'
+      when: manual
+    - if: $AUTO_DEVOPS_DEPLOY_ALLOW == 'tag' && $CI_COMMIT_TAG != null && $AUTO_DEVOPS_DEPLOY_WHEN == 'on_success'
+      when: on_success
+    # Default branch based deployment
+    - <<: *autodevops_default_branch_only_rule
+    - if: $AUTO_DEVOPS_DEPLOY_WHEN != 'manual'
+      when: on_success
+    - when: manual
+
+.autodevops_install:
+  stage: prepare
+  extends:
+    - .autodevops_node_install
+  interruptible: true
+  rules:
+    - <<: *autodevops_schedule_skip_rule
+    - when: on_success
+
+.autodevops_lint:
+  stage: code_quality
+  rules:
+    - <<: *autodevops_schedule_skip_rule
+    - if: "$AUTO_DEVOPS_QUALITY_WHEN == 'never'"
+      when: never
+    - when: always
+  extends:
+    - .autodevops_node_install
+    - .autodevops_node_image
+  needs:
+    - job: install
+      artifacts: true
+    - job: build
+      artifacts: true
+  script:
+    - yarn lint
+
+.autodevops_test:
+  stage: code_quality
+  rules:
+    - <<: *autodevops_schedule_skip_rule
+    - if: "$AUTO_DEVOPS_TEST_WHEN == 'never'"
+      when: never
+    - when: always
+  extends:
+    - .autodevops_node_install
+    - .autodevops_node_image
+  needs:
+    - job: install
+      artifacts: true
+    - job: build
+      artifacts: true
+  script:
+    - yarn test
+
+.autodevops_build:
+  stage: build
+  extends:
+    - .autodevops_node_build
+  rules:
+    - <<: *autodevops_schedule_skip_rule
+    - when: on_success
+  needs:
+    - job: install
+      artifacts: true
+
+.autodevops_pages:
+  extends:
+    - .autodevops_node_docs
+    - .autodevops_trigger_deploy
+  artifacts:
+    paths:
+      - public
+
+.autodevops_code_analysis:
+  stage: code_quality
+  extends:
+    - .autodevops_node_install
+  variables:
+    CODE_ANALYSIS_HOUR: 7 # 7h UTC => 9h Paris
+    # CODE_ANALYSIS_DISABLED: "🛑"
+  rules:
+    - if: "$CODE_ANALYSIS_DISABLED"
+      when: never
+    - if: '$CI_PIPELINE_SOURCE == "schedule"'
+      when: always
+    - when: never
+  script:
+    - >
+      if [ `date +%H` -eq $CODE_ANALYSIS_HOUR ]; then
+        npm run code-analysis;
+      else
+        echo "Code Analysis skipped H=$(date +%H)";
+      fi
+
+# .autodevops_register_image:
+#   extends:
+#     - .base_register_stage
+#   stage: registration
+#   needs:
+#     - job: Build
+#       artifacts: true
+#   variables:
+#     CONTEXT: .
+#     IMAGE_NAME: $CI_REGISTRY_IMAGE
+
+.autodevops_node_image:
+  image: node:lts-alpine
+
+.autodevops_node_install:
+  extends:
+    - .autodevops_node_image
+  before_script:
+    - yarn install --frozen-lockfile --prefer-offline
+  script:
+    - echo 'Installation Successful'
+  retry:
+    max: 2
+    when:
+      - runner_system_failure
+      - stuck_or_timeout_failure
+
+.autodevops_node_build:
+  extends:
+    - .autodevops_node_image
+    - .autodevops_node_install
+  script:
+    - npm run build
+  artifacts:
+    expire_in: 1 week
+    paths:
+      - dist
+      - "packages/*/dist"
+      - lib
+      - "packages/*/lib"
+      - node_modules
+
+.autodevops_node_docs:
+  extends:
+    - .autodevops_node_image
+    - .autodevops_node_install
+  script:
+    # We use NPM because supports `--if-present`
+    - npm run docs --if-present
+
+.autodevops_renovate:
+  stage: prepare
+  rules:
+    - if: "$RENOVATE_DISABLED"
+      when: never
+    - if: "$RENOVATE"
+      when: always
+    - when: never
+  extends:
+    - .renovate

package/ci/_gitlab/README.md

@@ -0,0 +1,20 @@
+# Documentation
+
+## Setup Renovate
+
+1. Open the project on gitlab website
+2. Go to CI/CD > Schedules
+3. Configure job
+    * Set `Interval pattern` to `0 * * * *`
+    * Add variables `RENOVATE` to `ON`
+
+## Setup NPM Release
+
+1. Open the project on gitlab website -OR- open the organization for global settings
+2. Configure GitLab CI environment variables to allow script to push (tags for example)
+    1. Set `CI_EMAIL` to a valid email.
+    2. Set `CI_USERNAME` to a valid name.
+3. Configure GitLab CI environment variables to allow publishing on NPM registry
+    1. Open [https://npmjs.com](https://npmjs.com)
+    2. Go to the "Access token" section and generate a new 'Read & Write Token'
+    3. Add the `NPM_TOKEN` environment variable containing the created token

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

@@ -0,0 +1,30 @@
+# 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_DISABLED: "🛑"
+  rules:
+    - if: "$RENOVATE_DISABLED"
+      when: never
+    - if: '$CI_PIPELINE_SOURCE == "schedule"'
+      when: always
+    - when: never
+  image:
+    name: renovate/renovate
+    entrypoint: [""]
+  script:
+    - >
+      renovate
+      --platform "gitlab"
+      --endpoint "${CI_API_V4_URL}"
+      --git-author "${RENOVATE_GIT_AUTHOR}"
+      --dry-run "${RENOVATE_DRY_RUN}"
+      --log-file-level "${RENOVATE_LOG_LEVEL}"
+      --allow-post-upgrade-command-templating
+      --allowed-post-upgrade-commands "${RENOVATE_ALLOWED_POST_UPGRADE}"
+      "${CI_PROJECT_PATH}"
+  tags:
+    - renovate

package/ci/gitlab.js

@@ -0,0 +1,38 @@
+/* eslint-disable global-require, sort-keys-fix/sort-keys-fix */
+const path = require('path');
+const { yaml } = require('mrm-core');
+
+/** @type {typeof import('sync-directory')['default']} */
+const syncDirectory = /** @type {any} */ (require('sync-directory'));
+
+function task() {
+  const gitlabCIConfig = yaml('.gitlab-ci.yml');
+  const gitlabCILib = '.gitlab';
+  const state = 'present';
+
+  if (state === 'present') {
+    syncDirectory(path.join(__dirname, '_gitlab'), path.resolve(gitlabCILib));
+  }
+
+  // Default include and stages
+  const autoDevopsPath = `${gitlabCILib}/AutoDevops.gitlab-ci.yml`;
+  const hasInclude = (/** @type {string} */ includePath) =>
+    gitlabCIConfig.get('include', []).some(
+      /**
+       * @param {string|{local: string}} include
+       */
+      (include) => {
+        return (typeof include === 'string' ? include : include.local) === includePath;
+      }
+    );
+  const addInclude = (/** @type {string} */ includePath) =>
+    gitlabCIConfig.set('include', gitlabCIConfig.get('include', []).concat([{ local: includePath }]));
+
+  if (!hasInclude(autoDevopsPath)) {
+    addInclude(autoDevopsPath);
+  }
+
+  gitlabCIConfig.save();
+}
+
+module.exports = task;

package/ci/index.js

@@ -0,0 +1,14 @@
+const gitlabCI = require('../core/gitlabCI');
+const gitlab = require('./gitlab');
+
+function task() {
+  // check gitlab support
+  if (gitlabCI.isSupported()) {
+    gitlab();
+  }
+}
+
+task.description = 'Setup Continuous Integration';
+task.parameters = {};
+
+module.exports = task;

package/commitlint/index.js

@@ -0,0 +1,40 @@
+const { commitlint } = require('../core/commitlint');
+const { hasGit } = require('../core/git');
+
+/**
+ *
+ * @param {{
+ *   commitLintPreset?: string
+ * }} config
+ */
+function createCommitLint({ commitLintPreset: commitLintPresetDefault }) {
+  /**
+   *
+   * @param {{
+   *   commitLintPreset: string
+   * }} parameters
+   */
+  function task({ commitLintPreset }) {
+    const gitPresent = hasGit();
+
+    commitlint({
+      preset: commitLintPreset,
+      state: gitPresent ? 'present' : 'absent',
+    });
+  }
+
+  task.description = 'Setup CommitLint';
+  task.parameters = {
+    commitLintPreset: {
+      default: commitLintPresetDefault,
+      message: 'Enter CommitLint preset name',
+      type: 'input',
+    },
+  };
+
+  return task;
+}
+
+module.exports = createCommitLint({
+  commitLintPreset: '@w5s/commitlint-config',
+});

package/config.json

@@ -0,0 +1,20 @@
+{
+  "aliases": {
+    "configure": [
+      "gitignore",
+      "project",
+      "contributing",
+      "release",
+      "ci",
+      "lang",
+      "commitlint",
+      "editorconfig",
+      "eslint",
+      "cspell",
+      "jest",
+      "renovate",
+      "githooks",
+      "postconfigure"
+    ]
+  }
+}