@w5s/mrm-preset 1.0.0-alpha.1

package/contributing/index.js

@@ -0,0 +1,26 @@
+const path = require('path');
+const { file } = require('mrm-core');
+
+function task() {
+  // code of conduct
+  const EOL = '\n';
+  const codeOfConduct = 'CODE_OF_CONDUCT.md';
+  const codeOfConductFile = file(codeOfConduct);
+  if (!codeOfConductFile.exists() || !codeOfConductFile.get().includes(`<!-- EditMode: MANUAL -->`)) {
+    const codeOfConductTemplate = file(path.join(__dirname, 'templates', codeOfConduct)).get();
+    codeOfConductFile.save(
+      [
+        `<!--
+Generated by mrm
+  * change EditMode: MANUAL to avoid overwriting by mrm
+-->`,
+        `<!-- EditMode: AUTO -->`,
+        codeOfConductTemplate,
+      ].join(EOL)
+    );
+  }
+}
+
+task.description = 'Setup Contributing';
+task.parameters = {};
+module.exports = task;

package/contributing/templates/CODE_OF_CONDUCT.md

@@ -0,0 +1,134 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by 
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available 
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

package/core/block.js

@@ -0,0 +1,77 @@
+const { file } = require('mrm-core');
+
+/**
+ * Replace a block in file that follows pattern :
+ *
+ * marker(markerBegin)
+ * ...
+ * marker(markerEnd)
+ *
+ * @param {{
+ *   markerBegin?: string,
+ *   markerEnd?: string,
+ *   marker?: (mark: string) => string,
+ *   path: string,
+ *   block: string,
+ *   insertBefore?: 'begin',
+ *   insertAfter?: 'end'
+ * }} options
+ */
+function block({
+  markerBegin = 'BEGIN',
+  markerEnd = 'END',
+  marker = (mark) => {
+    return `# ${mark} generated by mrm`;
+  },
+  path,
+  block: blockName,
+  // @ts-ignore
+  insertBefore = 'begin',
+  insertAfter,
+}) {
+  const EOL = '\n';
+  const beginBlock = marker(markerBegin);
+  const endBlock = marker(markerEnd);
+
+  /**
+   * @param {string} content
+   */
+  function findBlock(content) {
+    const startIndex = content.indexOf(beginBlock);
+    const endIndex = content.indexOf(endBlock) + endBlock.length;
+
+    return {
+      endIndex,
+      exists: startIndex >= 0 && endIndex >= 0,
+      startIndex,
+    };
+  }
+
+  /**
+   * @param {string} fullContent
+   * @param {string} blockContent
+   */
+  function apply(fullContent, blockContent) {
+    const found = findBlock(fullContent);
+    const replaceBlock = beginBlock + EOL + blockContent + EOL + endBlock;
+
+    if (found.exists) {
+      return fullContent.substr(0, found.startIndex) + replaceBlock + fullContent.substr(found.endIndex);
+    }
+
+    // insert
+    if (insertAfter === 'end') {
+      return fullContent + EOL + replaceBlock;
+    }
+
+    // if (insertBefore === 'begin') {
+    return replaceBlock + EOL + fullContent;
+    // }
+  }
+
+  const sourceFile = file(path);
+  const sourceContent = sourceFile.get();
+  sourceFile.save(apply(sourceContent, blockName));
+}
+
+module.exports = block;

package/core/commitlint.js

@@ -0,0 +1,39 @@
+const pkg = require('./pkg');
+const npm = require('./npm');
+const { gitHook } = require('./githooks');
+
+/**
+ * @param {{
+ *   state: 'present'|'absent',
+ *   preset: string,
+ * }} options
+ */
+function commitlint({ state, preset }) {
+  pkg.withPackageJson((packageFile) => {
+    if (state === 'present') {
+      packageFile.merge({
+        commitlint: {
+          extends: [preset],
+        },
+      });
+    } else {
+      packageFile.unset('commitlint');
+    }
+  });
+
+  gitHook({
+    name: 'commit-msg',
+    content: 'npm exec --no -- commitlint --edit $1',
+    state,
+  });
+
+  npm.dependency({
+    dev: true,
+    name: ['@commitlint/cli', preset],
+    state,
+  });
+}
+
+module.exports = {
+  commitlint,
+};

package/core/cspell.js

@@ -0,0 +1,66 @@
+const { json } = require('mrm-core');
+const pkg = require('./pkg');
+const npm = require('./npm');
+/**
+ * @typedef {{
+ *   version: '0.2',
+ *   language: string,
+ *   words?: string[],
+ *   flagWords?: string[],
+ *   ignorePaths?: string[],
+ *   ignoreWords?: string[],
+ *   ignoreRegExpList?: string[],
+ *   import?: string[]
+ * }} CSpellConfig
+ */
+/**
+ * @param {{
+ *   state: 'present'|'absent'
+ *   update?: (config: CSpellConfig) => CSpellConfig
+ * }} options
+ */
+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',
+    words: [],
+    flagWords: [],
+    ignorePaths: [
+      '**/[.]*/**', // ignore hidden directories
+    ],
+  });
+
+  if (hasCSpell) {
+    if (update) {
+      cSpellFile.set(update(cSpellFile.get()));
+    }
+
+    /**
+     * Otherwise save the file with content
+     */
+    cSpellFile.save();
+  } else {
+    cSpellFile.delete();
+  }
+
+  // Dependencies
+  npm.dependency({
+    dev: true,
+    name: ['cspell'],
+    state,
+  });
+}
+
+module.exports = {
+  cspell,
+};

package/core/eslint.js

@@ -0,0 +1,22 @@
+const { packageJson } = require('mrm-core');
+
+/**
+ * @param {import('eslint').Linter.Config} config
+ */
+function eslintConfig(config) {
+  const packageFile = packageJson();
+  packageFile.merge({ eslintConfig: config });
+  packageFile.save();
+}
+exports.eslintConfig = eslintConfig;
+
+/**
+ *
+ * @param {Array<string>} ignorePatterns
+ */
+function eslintIgnore(ignorePatterns) {
+  const packageFile = packageJson();
+  packageFile.merge({ eslintIgnore: ignorePatterns });
+  packageFile.save();
+}
+exports.eslintIgnore = eslintIgnore;

package/core/file.js

@@ -0,0 +1,29 @@
+const { file: mrmFile } = require('mrm-core');
+
+/**
+ *
+ * @param {{
+ *   path: string,
+ *   state: 'file'|'absent',
+ *   update?: (content: string) => string | undefined,
+ * }} options
+ */
+function file({ path, state, update }) {
+  const fileHandler = mrmFile(path);
+  if (state === 'file') {
+    if (update) {
+      const newContent = update(fileHandler.get());
+      if (newContent != null) {
+        fileHandler.save(newContent);
+      }
+    } else if (!fileHandler.exists()) {
+      fileHandler.save('');
+    }
+  } else {
+    fileHandler.delete();
+  }
+}
+
+module.exports = {
+  file,
+};

package/core/git.js

@@ -0,0 +1,73 @@
+const { file, ini } = require('mrm-core');
+const block = require('./block');
+
+/**
+ *
+ */
+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) => {
+            return returnValue.replace(/^git@github.com:/, 'https://github.com/');
+          },
+          /**
+           * 2. filter gitlab URL
+           * @param {string} returnValue
+           */
+          (returnValue) => {
+            return returnValue.replace(/^git@gitlab.com:/, 'https://gitlab.com/');
+          },
+        ].reduce((returnValue, filter) => {
+          return filter(returnValue);
+        }, remoteURL)
+      : remoteURL;
+  } catch (error) {
+    // ignore error
+  }
+
+  return undefined;
+}
+exports.remoteSync = remoteSync;
+
+function hasGit() {
+  return file('.git/config').exists();
+}
+exports.hasGit = hasGit;
+
+/**
+ * @param {string} content
+ */
+function trimStartLine(content) {
+  return content
+    .split(/\n/)
+    .map((line) => {
+      return line.replace(/^\s+/, '');
+    })
+    .filter((_) => _.length > 0)
+    .join('\n');
+}
+
+/**
+ * @param {string} section
+ * @param {string|Array<string>} sectionContent
+ */
+function gitIgnore(section, sectionContent) {
+  const EOL = '\n';
+
+  return block({
+    block: Array.isArray(sectionContent) ? sectionContent.join(EOL) : trimStartLine(sectionContent),
+    marker: (mark) => {
+      return `# ${mark} ### ${section} ###`;
+    },
+    path: '.gitignore',
+  });
+}
+exports.gitIgnore = gitIgnore;

package/core/githooks.js

@@ -0,0 +1,71 @@
+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');
+
+/**
+ * @param {{
+ *   state: 'present'|'absent',
+ * }} options
+ */
+function husky({ state }) {
+  const hasHusky = state === 'present';
+
+  npm.dependency({
+    dev: true,
+    name: ['husky'],
+    state: hasHusky ? 'present' : 'absent',
+  });
+  if (hasHusky) {
+    npm.dependency({
+      dev: true,
+      name: ['is-ci'],
+      state: 'present',
+    });
+  }
+
+  pkg.withPackageJson((packageFile) => {
+    pkg.script(packageFile, {
+      name: `${project.prepare}:husky`,
+      state: hasHusky ? 'present' : 'absent',
+      script: 'is-ci || husky install',
+    });
+  });
+}
+
+/**
+ * @param {{
+ *   name: 'pre-push'|'pre-commit'|'commit-msg',
+ *   state: 'present'|'absent',
+ *   content: string
+ * }} options
+ */
+function gitHook({ name, state, content }) {
+  const hasHusky = Boolean(packageJson().get('devDependencies.husky'));
+  const hasGitHook = hasHusky && state === 'present';
+  const hookDirectory = '.husky';
+  const hookFileName = path.join(hookDirectory, name);
+  if (hasGitHook) {
+    makeDirs(hookDirectory);
+
+    if (!file(hookFileName).exists()) {
+      execSync(`npm exec -- husky add ${hookFileName} ""`, { stdio: 'inherit' });
+    }
+
+    block({
+      path: hookFileName,
+      block: content,
+      insertAfter: 'end',
+    });
+  } else {
+    file(hookFileName).delete();
+  }
+}
+
+module.exports = {
+  husky,
+  gitHook,
+};

package/core/gitlabCI.js

@@ -0,0 +1,8 @@
+const { file } = require('mrm-core');
+
+const FILE_PATH = '.gitlab-ci.yml';
+
+function isSupported() {
+  return file(FILE_PATH).exists();
+}
+exports.isSupported = isSupported;

package/core/jest.js

@@ -0,0 +1,105 @@
+/* eslint-disable no-template-curly-in-string */
+const { packageJson } = require('mrm-core');
+const { vscodeSnippets } = require('./vscode');
+const pkg = require('./pkg');
+const npm = require('./npm');
+const project = require('./project');
+
+/**
+ * @param {{
+ *   state: 'present'|'absent'
+ * }} options
+ */
+function jest({ state }) {
+  const packageFileDefault = packageJson();
+  const hasJest = state === 'present';
+  const hasTypescript = Boolean(packageFileDefault.get('devDependencies.typescript'));
+  const hasWorkspaces = Boolean(packageFileDefault.get('workspaces'));
+
+  pkg.withPackageJson((packageFile) => {
+    if (hasJest) {
+      const ignorePatterns = ['/node_modules/', '/docs/', '/lib/', '/build/', '/.cache/', '/public/'];
+      packageFile.merge({
+        jest: {
+          coveragePathIgnorePatterns: ignorePatterns,
+          testPathIgnorePatterns: ignorePatterns,
+        },
+      });
+      if (hasTypescript) {
+        packageFile.merge({
+          jest: {
+            globals: {
+              'ts-jest': {
+                tsconfig: hasWorkspaces ? 'tsconfig.settings.json' : 'tsconfig.json',
+              },
+            },
+            roots: hasWorkspaces ? ['<rootDir>/packages'] : null,
+            transform: {
+              '^.+\\.tsx?$': 'ts-jest',
+            },
+          },
+        });
+      } else {
+        packageFile.unset('jest.globals.ts-jest').unset('jest.transform.^.+\\.tsx?$');
+      }
+    } else {
+      packageFile.unset('jest');
+    }
+
+    pkg.script(packageFile, {
+      name: project.coverage,
+      script: hasWorkspaces ? pkg.emptyScript : 'jest --coverage',
+      state: !hasJest || hasWorkspaces ? 'default' : 'present',
+    });
+    pkg.script(packageFile, {
+      name: project.test,
+      script: hasWorkspaces ? pkg.emptyScript : 'jest',
+      state: !hasJest || hasWorkspaces ? 'default' : 'present',
+    });
+    pkg.script(packageFile, {
+      name: `${project.test}:watch`,
+      script: pkg.emptyScript,
+      state: 'absent',
+    });
+  });
+  // Dependencies
+  npm.dependency({
+    dev: true,
+    name: ['jest', 'babel-jest', '@babel/core'],
+    state: hasJest ? 'present' : 'absent',
+  });
+  npm.dependency({
+    dev: true,
+    name: ['ts-jest', '@types/jest'],
+    state: hasJest && hasTypescript ? 'present' : 'absent',
+  });
+
+  vscodeSnippets({
+    name: 'jest',
+    snippets: {
+      'Jest Describe Block': {
+        body: ["describe('${1:description}', () => {", '\t$0', '});'],
+        description: 'Jest describe block',
+        prefix: 'describe',
+        scope: 'javascript,typescript',
+      },
+      'Jest Expect': {
+        body: 'expect($0)',
+        description: 'Jest expect assertion',
+        prefix: 'expect',
+        scope: 'javascript,typescript',
+      },
+      'Jest Test Block': {
+        body: ["test('${1:description}', () => {", '\t$0', '});'],
+        description: 'Jest test block',
+        prefix: 'test',
+        scope: 'javascript,typescript',
+      },
+    },
+    state: hasJest ? 'present' : 'absent',
+  });
+}
+
+module.exports = {
+  jest,
+};