@w5s/mrm-preset 1.0.0-alpha.2 → 1.0.0-alpha.21

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,14 +21,6 @@ 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', {
     version: '0.2',
     language: 'en',

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/{gitignore/template.js → core/git.ignore.js}

@@ -11,6 +11,7 @@ module.exports = {
   yarn-debug.log*
   yarn-error.log*
   lerna-debug.log*
+  .pnpm-debug.log*
 
   # Diagnostic reports (https://nodejs.org/api/report.html)
   report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
@@ -47,8 +48,8 @@ module.exports = {
   node_modules/
   jspm_packages/
 
-  # TypeScript v1 declaration files
-  typings/
+  # Snowpack dependency directory (https://snowpack.dev/)
+  web_modules/
 
   # TypeScript cache
   *.tsbuildinfo
@@ -59,6 +60,9 @@ module.exports = {
   # Optional eslint cache
   .eslintcache
 
+  # Optional stylelint cache
+  .stylelintcache
+
   # Microbundle cache
   .rpt2_cache/
   .rts2_cache_cjs/
@@ -74,15 +78,20 @@ module.exports = {
   # Yarn Integrity file
   .yarn-integrity
 
-  # dotenv environment variables file
+  # dotenv environment variable files
   .env
-  .env.test
+  .env.development.local
+  .env.test.local
+  .env.production.local
+  .env.local
 
   # parcel-bundler cache (https://parceljs.org/)
   .cache
+  .parcel-cache
 
   # Next.js build output
   .next
+  out
 
   # Nuxt.js build / generate output
   .nuxt
@@ -92,11 +101,18 @@ module.exports = {
   .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/
+  # public
 
   # vuepress build output
   .vuepress/dist
 
+  # vuepress v2.x temp and cache directory
+  .temp
+  .cache
+
+  # Docusaurus cache and generated files
+  .docusaurus
+
   # Serverless directories
   .serverless/
 
@@ -107,7 +123,17 @@ module.exports = {
   .dynamodb/
 
   # TernJS port file
-  .tern-port`,
+  .tern-port
+
+  # Stores VSCode versions used for testing VSCode extensions
+  .vscode-test
+
+  # yarn v2
+  .yarn/cache
+  .yarn/unplugged
+  .yarn/build-state.yml
+  .yarn/install-state.gz
+  .pnp.*`,
   VisualStudioCode: `
   .vscode/*
   !.vscode/settings.json

package/core/git.js

@@ -1,5 +1,5 @@
 const { file, ini } = require('mrm-core');
-const block = require('./block');
+const block = require('./block.js');
 
 /**
  *
@@ -7,23 +7,9 @@ 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) => 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;
-  } catch (error) {
+    const remoteURL = gitConfig.get('remote "origin"').url.trim();
+    return remoteURL;
+  } catch {
     // ignore error
   }
 
@@ -61,3 +47,20 @@ function gitIgnore(section, sectionContent) {
   });
 }
 exports.gitIgnore = gitIgnore;
+
+/**
+ * @param {string[]} flags
+ */
+function gitIgnoreTemplate(flags) {
+  // eslint-disable-next-line global-require, import/no-dynamic-require
+  const templateMap = require('./git.ignore.js');
+
+  flags.forEach((flag) => {
+    // @ts-ignore
+    if (templateMap[flag]) {
+      // @ts-ignore
+      gitIgnore(flag, templateMap[flag]);
+    }
+  });
+}
+exports.gitIgnoreTemplate = gitIgnoreTemplate;

package/core/githooks.js

@@ -1,10 +1,10 @@
-const { execSync } = require('child_process');
-const path = require('path');
+const { execSync } = require('node:child_process');
+const path = require('node: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 project = require('./project.js');
+const npm = require('./npm.js');
+const pkg = require('./pkg.js');
+const block = require('./block.js');
 
 /**
  * @param {{
@@ -44,7 +44,8 @@ function husky({ state }) {
  * }} options
  */
 function gitHook({ name, state, content }) {
-  const hasHusky = Boolean(packageJson().get('devDependencies.husky'));
+  const packageFileDefault = packageJson();
+  const hasHusky = pkg.hasDependency(packageFileDefault, 'husky', 'dev');
   const hasGitHook = hasHusky && state === 'present';
   const hookDirectory = '.husky';
   const hookFileName = path.join(hookDirectory, name);

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;

package/core/jest.js

@@ -1,9 +1,8 @@
 /* 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');
+const pkg = require('./pkg.js');
+const npm = require('./npm.js');
+const project = require('./project.js');
 
 /**
  * @param {{
@@ -13,38 +12,29 @@ const project = require('./project');
 function jest({ state }) {
   const packageFileDefault = packageJson();
   const hasJest = state === 'present';
-  const hasTypescript = Boolean(packageFileDefault.get('devDependencies.typescript'));
-  const hasWorkspaces = Boolean(packageFileDefault.get('workspaces'));
+  const hasWorkspaces = pkg.hasWorkspaces(packageFileDefault);
 
   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');
-    }
+    const ignorePatterns = ['/node_modules/', '/docs/', '/lib/', '/build/', '/.cache/', '/public/'];
+
+    pkg.value(packageFile, {
+      path: 'jest',
+      state: hasJest ? 'present' : 'absent',
+      update: hasWorkspaces
+        ? () => ({
+            preset: 'es-jest',
+            projects: packageFile
+              .get('workspaces.packages', packageFile.get('workspaces', []))
+              .map((/** @type {string} */ workspace) => `<rootDir>/${workspace}`),
+          })
+        : (config) => ({
+            ...config,
+            preset: 'es-jest',
+            coveragePathIgnorePatterns: ignorePatterns,
+            testPathIgnorePatterns: ignorePatterns,
+          }),
+      default: {},
+    });
 
     pkg.script(packageFile, {
       name: project.coverage,
@@ -56,48 +46,39 @@ function jest({ state }) {
       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'],
+    name: ['jest', 'es-jest'],
     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',
-  });
+  // 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 = {

package/core/jsonFile.js

@@ -41,16 +41,17 @@ function setValue(jsonFile, path, pathValue) {
  */
 function value(jsonFile, { state, path, default: defaultValue, update: nextValue }) {
   if (state === 'present') {
-    if (nextValue != null) {
-      const resolvedValue = typeof nextValue === 'function' ? nextValue(getValue(jsonFile, path)) : nextValue;
-      if (resolvedValue != null) {
-        setValue(jsonFile, path, resolvedValue);
+    let currentValue = getValue(jsonFile, path);
+
+    if (currentValue == null) {
+      currentValue = typeof defaultValue === 'function' ? defaultValue() : defaultValue;
+      if (currentValue != null) {
+        setValue(jsonFile, path, currentValue);
       }
     }
 
-    const currentValue = getValue(jsonFile, path);
-    if (currentValue == null) {
-      const resolvedValue = typeof defaultValue === 'function' ? defaultValue() : defaultValue;
+    if (nextValue != null) {
+      const resolvedValue = typeof nextValue === 'function' ? nextValue(getValue(jsonFile, path)) : nextValue;
       if (resolvedValue != null) {
         setValue(jsonFile, path, resolvedValue);
       }

package/core/lintStaged.js

@@ -1,6 +1,6 @@
-const pkg = require('./pkg');
-const npm = require('./npm');
-const jsonFile = require('./jsonFile');
+const pkg = require('./pkg.js');
+const npm = require('./npm.js');
+const jsonFile = require('./jsonFile.js');
 
 /**
  * @typedef {Record<string, string|string[]>} LintStagedConfig

package/core/npm.js

@@ -1,3 +1,5 @@
+/* eslint-disable default-param-last */
+/* eslint-disable no-use-before-define */
 /* eslint-disable import/no-extraneous-dependencies */
 /* cSpell: disable */
 // @ts-check
@@ -16,25 +18,26 @@ const log = require('mrm-core/src/util/log');
 // @ts-ignore
 const execCommand = require('mrm-core/src/util/execCommand');
 // @ts-ignore
-const json = require('mrm-core/src/formats/json');
-// @ts-ignore
 const packageJson = require('mrm-core/src/files/packageJson');
 // @ts-ignore
 const MrmError = require('mrm-core/src/error');
+const { yaml, json } = require('mrm-core');
 
 /**
- * @typedef Options
- * @property {boolean} [dev]
- * @property {boolean} [yarn]
- * @property {Record<string, string>} [versions]
+ * @typedef {{
+ *   dev?: boolean,
+ *   yarn?: boolean,
+ *   versions?: Record<string, string>,
+ * }} Options
  */
 
 /**
- * @typedef RunOptions
- * @property {boolean} [dev]
- * @property {boolean} [remove]
- * @property {boolean} [stdio]
- * @property {string} [cwd]
+ * @typedef {{
+ *  dev?: boolean,
+ *  remove?: boolean,
+ *  stdio?: boolean,
+ *  cwd?: string,
+ * }} RunOptions
  */
 
 /**
@@ -132,7 +135,7 @@ function runNpm(deps, options = {}, exec) {
 function runYarn(deps, options = {}, exec) {
   const add = options.dev ? ['add', '--dev'] : ['add'];
   const remove = ['remove'];
-  const args = (options.remove ? remove : add).concat(isUsingWorkspaces() ? ['-W'] : []).concat(deps);
+  const args = (options.remove ? remove : add).concat(isUsingWorkspaces() && !isYarnBerry() ? ['-W'] : []).concat(deps);
 
   return execCommand(exec, 'yarn', args, {
     cwd: options.cwd,
@@ -165,7 +168,7 @@ function getVersionedDep(dep, versions) {
 /**
  *
  * @param {Options} options
- * @returns {Record<string, string>}
+ * @returns {Record<string, string>} - map of package names to versions
  */
 function getOwnDependencies(options) {
   const pkg = packageJson({
@@ -180,7 +183,7 @@ function getOwnDependencies(options) {
  * Return version of installed npm package
  *
  * @param {string} name
- * @returns {string}
+ * @returns {string} - version
  */
 function getInstalledVersion(name) {
   return json(`./node_modules/${name}/package.json`).get('version');
@@ -193,7 +196,7 @@ function getInstalledVersion(name) {
  * @param {string[]} deps
  * @param {Record<string, string>} versions
  * @param {Options} options
- * @returns {string[]}
+ * @returns {string[]} - list of not installed dependencies
  */
 function getUnsatisfiedDeps(deps, versions, options) {
   const ownDependencies = getOwnDependencies(options);
@@ -246,6 +249,39 @@ function isUsingWorkspaces() {
   return Boolean(packageJson().get('workspaces'));
 }
 
+function isYarnBerry() {
+  const yamlRC = yaml('.yarnrc.yml');
+  return yamlRC.exists() && !(yamlRC.get('yarnPath') || '').includes('.yarn/releases/yarn-1.');
+}
+
+/**
+ * @param {'npm'|`yarn@${'classic'|'berry'}`} defaultPackageManager
+ */
+function bootstrap(defaultPackageManager) {
+  const packageFile = json(`./package.json`);
+  const isYarn = isUsingYarn() || defaultPackageManager.startsWith('yarn@');
+  if (!packageFile.get('packageManager') && isYarn) {
+    execCommand(undefined, 'yarn', ['set', 'version', 'berry']);
+    yaml('.yarnrc.yml')
+      .merge({
+        nodeLinker: 'node-modules',
+      })
+      .save();
+    // Downgrade
+    if (defaultPackageManager.endsWith('@classic')) {
+      execCommand(undefined, 'yarn', ['set', 'version', 'classic']);
+    }
+  }
+
+  // lock files
+  if (isYarn && !fs.existsSync('yarn.lock')) {
+    execCommand(undefined, 'yarn', ['install']);
+  }
+  if (!isYarn && !fs.existsSync('package-lock.json')) {
+    execCommand(undefined, 'npm', ['install']);
+  }
+}
+
 /**
  * @param {{
  *   name: string|string[]|Record<string, string>,
@@ -263,5 +299,6 @@ function dependency({ name, state, ...options }) {
 }
 
 module.exports = {
+  bootstrap,
   dependency,
 };