@w5s/mrm-preset 1.0.0-alpha.1

package/core/vscode.js

@@ -0,0 +1,92 @@
+const { json } = require('mrm-core');
+
+/**
+ * @param {Array<string>} recommendations
+ */
+function vscodeRecommendedExtension(recommendations) {
+  const packageFile = json('.vscode/extensions.json');
+  packageFile.merge({
+    recommendations,
+  });
+  packageFile.save();
+}
+exports.vscodeRecommendedExtension = vscodeRecommendedExtension;
+
+/**
+ * @param {{
+ *   type: string,
+ *   script: string;
+ *   group: {
+ *     kind: string,
+ *     isDefault: boolean
+ *   }
+ * }} newTask
+ */
+function vscodeTask(newTask) {
+  const vscodeTaskFile = json('.vscode/tasks.json', {
+    tasks: [],
+    version: '2.0.0',
+  });
+  /**
+   * @type {Array<any>}
+   */
+  const tasks = vscodeTaskFile.get('tasks', []);
+  if (
+    tasks.find((task) => {
+      return task.script === newTask.script;
+    })
+  ) {
+    vscodeTaskFile.set(
+      'tasks',
+      tasks.map((task) => {
+        return task.script === newTask.script ? newTask : task;
+      })
+    );
+  } else {
+    vscodeTaskFile.set('tasks', [newTask].concat(tasks));
+  }
+  vscodeTaskFile.save();
+}
+exports.vscodeTask = vscodeTask;
+
+/**
+ * @param {{
+ *   name: string,
+ *   state: 'present'|'absent',
+ *   snippets: {
+ *     [key: string]: {
+ *       scope: string,
+ *       prefix: string,
+ *       body: string|string[],
+ *       description?: string,
+ *     }
+ *   }
+ * }} snippets
+ */
+function vscodeSnippets({ name = 'mrm', state = 'present', snippets }) {
+  const snippetFile = json(`.vscode/${name}.code-snippets`);
+  if (state === 'present') {
+    snippetFile.merge(snippets);
+    snippetFile.save();
+  } else {
+    snippetFile.delete();
+  }
+}
+exports.vscodeSnippets = vscodeSnippets;
+
+/**
+ * @param {{
+ *   state: 'present'|'absent',
+ *   update: (settings: Record<string, any>) => Record<string, any>
+ * }} parameters
+ */
+function vscodeSettings({ state = 'present', update }) {
+  const settingFile = json('.vscode/settings.json');
+  if (state === 'present') {
+    settingFile.set(update(settingFile.get() || {}));
+    settingFile.save();
+  } else {
+    settingFile.delete();
+  }
+}
+exports.vscodeSettings = vscodeSettings;

package/core/workspace.js

@@ -0,0 +1,6 @@
+const { packageJson } = require('mrm-core');
+
+function useWorkspaces() {
+  return packageJson().get('mrmConfig.packageArchetype') === 'workspace';
+}
+exports.useWorkspaces = useWorkspaces;

package/cspell/index.js

@@ -0,0 +1,38 @@
+const { cspell } = require('../core/cspell');
+const { lintStaged } = require('../core/lintStaged');
+const { hasGit } = require('../core/git');
+
+function task() {
+  const gitSupported = hasGit();
+  cspell({
+    state: 'present',
+    update: (_) => ({
+      ..._,
+      ignorePaths: Array.from(
+        new Set([
+          '**/build/**',
+          '**/lib/**',
+          '**/node_modules/**',
+          '**/package.json',
+          '**/package-lock.json',
+          '**/yarn.lock',
+          '**/*.log',
+          '**/CHANGELOG.md',
+          ...(_.ignorePaths || []),
+        ])
+      ),
+    }),
+  });
+
+  lintStaged({
+    state: gitSupported ? 'present' : 'absent',
+    update: (config) => ({
+      ...config,
+      '*.*': ['cspell --no-must-find-files'],
+    }),
+  });
+}
+
+task.description = 'Adds CSpell support';
+
+module.exports = task;

package/editorconfig/index.js

@@ -0,0 +1,107 @@
+const { ini } = require('mrm-core');
+const createDebug = require('debug');
+const { vscodeRecommendedExtension } = require('../core/vscode');
+
+/**
+ *
+ * @param {Record<string, Partial<{
+ *   charset: string,
+ *   continuation_indent_size: number,
+ *   curly_bracket_next_line: boolean,
+ *   end_of_line: 'lf'|'crlf',
+ *   indent_brace_style: 'Stroustrup',
+ *   indent_size: number,
+ *   indent_style: 'tab'|'space',
+ *   insert_final_newline: boolean|'ignore',
+ *   max_line_length: number,
+ *   quote_type: 'single'|'double',
+ *   root: boolean,
+ *   spaces_around_brackets: 'outside',
+ *   spaces_around_operators: boolean,
+ *   trim_trailing_whitespace: boolean,
+ * }>>} defaults
+ */
+function createEditorConfig(defaults) {
+  const debug = createDebug('mrm-editorconfig');
+
+  /**
+   * @param {string} section
+   */
+  function mergeSection(section, existing = {}) {
+    return Object.assign(existing, defaults[section] || {});
+  }
+
+  function task() {
+    const editorConfigFile = ini('.editorconfig', 'http://editorconfig.org');
+
+    Object.keys(defaults).forEach((name) => {
+      const values = mergeSection(name, editorConfigFile.get(name));
+      debug('section %s: %o', name, values);
+      editorConfigFile.set(name, values);
+    });
+
+    editorConfigFile.save();
+
+    vscodeRecommendedExtension(['editorconfig.editorconfig']);
+  }
+
+  task.description = 'Adds EditorConfig file';
+
+  return task;
+}
+
+module.exports = createEditorConfig({
+  '*': {
+    charset: 'utf-8',
+    continuation_indent_size: 4,
+    curly_bracket_next_line: false,
+    end_of_line: 'lf',
+    indent_brace_style: 'Stroustrup',
+    indent_size: 2,
+    indent_style: 'space',
+    insert_final_newline: true,
+    spaces_around_brackets: 'outside',
+    spaces_around_operators: true,
+    trim_trailing_whitespace: true,
+  },
+  '*.json': {
+    indent_size: 2,
+    indent_style: 'space',
+    insert_final_newline: 'ignore',
+  },
+  '*.yml': {
+    indent_size: 2,
+    indent_style: 'space',
+  },
+  '*.{bat,reg,ps1,vbs,cs,,fs,ahk}': {
+    end_of_line: 'crlf',
+  },
+  '*.{css,scss,less}': {
+    indent_size: 2,
+    indent_style: 'space',
+    max_line_length: 120,
+    quote_type: 'single',
+  },
+  '*.{js,jsx,ts,tsx,js.hbs}': {
+    indent_size: 2,
+    indent_style: 'space',
+    max_line_length: 120,
+    quote_type: 'single',
+  },
+  '*.{md,mdwn,mdown,markdown,apib}': {
+    indent_size: 4,
+    indent_style: 'space',
+    insert_final_newline: true,
+    trim_trailing_whitespace: false,
+  },
+  '*.{py,robot}': {
+    indent_size: 4,
+    indent_style: 'space',
+  },
+  Makefile: {
+    indent_style: 'tab',
+  },
+  _global: {
+    root: true,
+  },
+});

package/eslint/index.js

@@ -0,0 +1,127 @@
+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');
+
+function createESLint({ eslintPreset: eslintPresetDefault = 'eslint:recommended' }) {
+  /**
+   *
+   * @param {{
+   *   eslintPreset: string,
+   *   eslintRules: Record<string, any>
+   * }} config
+   */
+  function task({ eslintPreset, eslintRules }) {
+    const hasTypescript = packageJson().get('devDependencies.typescript');
+    const hasJSX = true;
+    const hasJSON = 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'],
+      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',
+    });
+    eslintConfig({
+      extends: [eslintPreset],
+      rules: eslintRules,
+      parserOptions: {
+        project: hasTypescript ? './tsconfig.json' : undefined,
+      },
+    });
+
+    /** @type {Record<string, boolean>} */
+    const extsMap = {
+      js: true,
+      jsx: hasJSX,
+      ts: hasTypescript,
+      tsx: hasTypescript && hasJSX,
+      json: hasJSON,
+    };
+    const extList = Object.keys(extsMap).filter((ext) => extsMap[ext]);
+    const extOption = ` --ext ${extList.map((ext) => `.${ext}`).join(',')}`;
+
+    pkg.withPackageJson((packageFile) => {
+      pkg.script(packageFile, {
+        name: project.lint,
+        script: `eslint . --cache${extOption}`,
+        state: 'present',
+      });
+      pkg.script(packageFile, {
+        name: project.format,
+        script: `eslint . --quiet --cache --fix${extOption}`,
+        state: 'present',
+      });
+    });
+
+    // VSCode support
+    vscodeSettings({
+      state: 'present',
+      update: (settings) => {
+        return {
+          ...settings,
+          'editor.codeActionsOnSave': settings['editor.codeActionsOnSave'] || {
+            'source.fixAll.eslint': true,
+          },
+          'eslint.validate': extList.map(
+            (ext) =>
+              ({
+                jsx: 'javascriptreact',
+                js: 'javascript',
+                tsx: 'typescriptreact',
+                ts: 'typescript',
+              }[ext] || ext)
+          ),
+        };
+      },
+    });
+  }
+
+  task.description = 'Setup ESLint';
+  task.parameters = {
+    eslintPreset: {
+      default: eslintPresetDefault,
+      message: 'Enter ESLint preset name',
+      type: 'input',
+    },
+    eslintRules: {
+      type: 'config',
+    },
+  };
+
+  return task;
+}
+
+module.exports = createESLint({
+  eslintPreset: '@w5s/eslint-config',
+});

package/githooks/index.js

@@ -0,0 +1,62 @@
+const path = require('path');
+const { packageJson, template } = require('mrm-core');
+const project = require('../core/project');
+const { hasGit } = require('../core/git');
+const { gitHook, husky } = require('../core/githooks');
+const { lintStaged } = require('../core/lintStaged');
+const { file } = require('../core/file');
+
+function createGitHooks() {
+  function task() {
+    const gitSupported = hasGit();
+    const packageFile = packageJson();
+    const hasESLint = Boolean(packageFile.get('devDependencies.eslint'));
+    const hasJest = Boolean(packageFile.get('devDependencies.jest'));
+    const hasTsc = Boolean(packageFile.get('devDependencies.typescript'));
+
+    husky({
+      state: gitSupported ? 'present' : 'absent',
+    });
+    lintStaged({
+      state: gitSupported ? 'present' : 'absent',
+      update: (config) => ({
+        ...config,
+        '*.json': [...(hasESLint ? ['eslint'] : [])],
+        '*.js?(x)': [
+          ...(hasTsc ? ["bash -c 'tsc --noEmit'"] : []),
+          ...(hasESLint ? ['eslint'] : []),
+          ...(hasJest ? ['jest --ci --bail --findRelatedTests'] : []),
+        ],
+        '*.ts?(x)': [
+          ...(hasTsc ? ["bash -c 'tsc --noEmit'"] : []),
+          ...(hasESLint ? ['eslint'] : []),
+          ...(hasJest ? ['jest --ci --bail --findRelatedTests'] : []),
+        ],
+      }),
+    });
+    gitHook({
+      name: 'pre-commit',
+      content: `npm exec --no -- lint-staged`,
+      state: gitSupported ? 'present' : 'absent',
+    });
+    gitHook({
+      name: 'pre-push',
+      content: `npm run ${project.validate}`,
+      state: gitSupported ? 'present' : 'absent',
+    });
+
+    file({
+      path: 'CODEOWNERS',
+      state: gitSupported ? 'file' : 'absent',
+      update: (content) =>
+        content.length === 0 ? template('', path.join(__dirname, 'templates', 'CODEOWNERS')).apply().get() : undefined,
+    });
+  }
+
+  task.description = 'Setup Git hooks';
+  task.parameters = {};
+
+  return task;
+}
+
+module.exports = createGitHooks();

package/githooks/templates/CODEOWNERS

@@ -0,0 +1,4 @@
+# https://docs.gitlab.com/ee/user/project/code_owners.html
+
+# Default owners
+# * @someone

package/gitignore/index.js

@@ -0,0 +1,25 @@
+const { gitIgnore } = require('../core/git');
+
+/**
+ *
+ * @param {string} templatePath
+ * @param {Array<string>} flags
+ */
+function createGitIgnore(templatePath, flags) {
+  function task() {
+    // eslint-disable-next-line global-require, import/no-dynamic-require
+    const templateMap = require(templatePath);
+
+    flags.forEach((flag) => {
+      if (templateMap[flag]) {
+        gitIgnore(flag, templateMap[flag]);
+      }
+    });
+  }
+
+  task.description = 'Adds Gitignore file';
+
+  return task;
+}
+
+module.exports = createGitIgnore(require.resolve('./template'), ['macOS', 'NodeJS', 'VisualStudioCode']);

package/gitignore/template.js

@@ -0,0 +1,145 @@
+/* cSpell: disable */
+
+// A dictionary of { tool: git_ignore_section}
+
+module.exports = {
+  NodeJS: `
+  # Logs
+  logs
+  *.log
+  npm-debug.log*
+  yarn-debug.log*
+  yarn-error.log*
+  lerna-debug.log*
+
+  # Diagnostic reports (https://nodejs.org/api/report.html)
+  report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+  # Runtime data
+  pids
+  *.pid
+  *.seed
+  *.pid.lock
+
+  # Directory for instrumented libs generated by jscoverage/JSCover
+  lib-cov
+
+  # Coverage directory used by tools like istanbul
+  coverage
+  *.lcov
+
+  # nyc test coverage
+  .nyc_output
+
+  # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+  .grunt
+
+  # Bower dependency directory (https://bower.io/)
+  bower_components
+
+  # node-waf configuration
+  .lock-wscript
+
+  # Compiled binary addons (https://nodejs.org/api/addons.html)
+  build/Release
+
+  # Dependency directories
+  node_modules/
+  jspm_packages/
+
+  # TypeScript v1 declaration files
+  typings/
+
+  # TypeScript cache
+  *.tsbuildinfo
+
+  # Optional npm cache directory
+  .npm
+
+  # Optional eslint cache
+  .eslintcache
+
+  # Microbundle cache
+  .rpt2_cache/
+  .rts2_cache_cjs/
+  .rts2_cache_es/
+  .rts2_cache_umd/
+
+  # Optional REPL history
+  .node_repl_history
+
+  # Output of 'npm pack'
+  *.tgz
+
+  # Yarn Integrity file
+  .yarn-integrity
+
+  # dotenv environment variables file
+  .env
+  .env.test
+
+  # parcel-bundler cache (https://parceljs.org/)
+  .cache
+
+  # Next.js build output
+  .next
+
+  # Nuxt.js build / generate output
+  .nuxt
+  dist
+
+  # Gatsby files
+  .cache/
+  # Comment in the public line in if your project uses Gatsby and not Next.js
+  # https://nextjs.org/blog/next-9-1#public-directory-support
+  public/
+
+  # vuepress build output
+  .vuepress/dist
+
+  # Serverless directories
+  .serverless/
+
+  # FuseBox cache
+  .fusebox/
+
+  # DynamoDB Local files
+  .dynamodb/
+
+  # TernJS port file
+  .tern-port`,
+  VisualStudioCode: `
+  .vscode/*
+  !.vscode/settings.json
+  !.vscode/tasks.json
+  !.vscode/launch.json
+  !.vscode/extensions.json
+  !.vscode/*.code-snippets`,
+  macOS: `
+  # General
+  .DS_Store
+  .AppleDouble
+  .LSOverride
+
+  # Icon must end with two \\r
+  Icon
+
+  # Thumbnails
+  ._*
+
+  # Files that might appear in the root of a volume
+  .DocumentRevisions-V100
+  .fseventsd
+  .Spotlight-V100
+  .TemporaryItems
+  .Trashes
+  .VolumeIcon.icns
+  .com.apple.timemachine.donotpresent
+
+  # Directories potentially created on remote AFP share
+  .AppleDB
+  .AppleDesktop
+  Network Trash Folder
+  Temporary Items
+  .apdisk`,
+};

package/jest/index.js

@@ -0,0 +1,19 @@
+const { jest } = require('../core/jest');
+
+function createJest() {
+  /**
+   *
+   */
+  function task() {
+    jest({
+      state: 'present',
+    });
+  }
+
+  task.description = 'Setup Jest';
+  task.parameters = {};
+
+  return task;
+}
+
+module.exports = createJest();

package/lang/.eslintrc.json

@@ -0,0 +1,8 @@
+{
+  "rules": {
+    "import/no-extraneous-dependencies": "off",
+    "@typescript-eslint/no-unsafe-call": "off",
+    "@typescript-eslint/no-unsafe-assignment": "off",
+    "@typescript-eslint/no-unsafe-member-access": "off"
+  }
+}