@w5s/mrm-preset 3.5.6 → 3.5.8

package/core/{jest.js → jest.cjs}

@@ -1,7 +1,8 @@
 const { packageJson } = require('mrm-core');
-const pkg = require('./pkg.js');
-const npm = require('./npm.js');
-const project = require('./project.js');
+
+const npm = require('./npm.cjs');
+const pkg = require('./pkg.cjs');
+const project = require('./project.cjs');
 
 /**
  * @param {{
@@ -17,6 +18,8 @@ function jest({ state }) {
     const ignorePatterns = ['/node_modules/', '/docs/', '/lib/', '/dist/', '/build/', '/.cache/', '/public/'];
 
     pkg.value(packageFile, {
+      // @ts-ignore
+      default: {},
       path: 'jest',
       state: hasJest ? 'present' : 'absent',
       update: hasWorkspaces
@@ -28,24 +31,22 @@ function jest({ state }) {
           })
         : (config) => ({
             ...config,
-            preset: 'es-jest',
             coveragePathIgnorePatterns: ignorePatterns,
+            preset: 'es-jest',
             testPathIgnorePatterns: ignorePatterns,
           }),
-      // @ts-ignore
-      default: {},
     });
     pkg.script(packageFile, {
+      default: undefined, // pkg.emptyScript,
       name: `${project.coverage}:root`,
-      update: (/** @type {string|undefined} */ _) => (hasWorkspaces ? _ : 'jest --coverage'),
       state: 'present',
-      default: undefined, // pkg.emptyScript,
+      update: (/** @type {string|undefined} */ _) => (hasWorkspaces ? _ : 'jest --coverage'),
     });
     pkg.script(packageFile, {
+      default: undefined, // pkg.emptyScript,
       name: `${project.test}:root`,
-      update: (/** @type {string|undefined} */ _) => (hasWorkspaces ? _ : 'jest'),
       state: 'present',
-      default: undefined, // pkg.emptyScript,
+      update: (/** @type {string|undefined} */ _) => (hasWorkspaces ? _ : 'jest'),
     });
   });
 

package/core/{jsonFile.js → jsonFile.cjs}

@@ -39,7 +39,7 @@ function setValue(jsonFile, path, pathValue) {
  *   default?: T | (() => T)
  * }} options
  */
-function value(jsonFile, { state, path, default: defaultValue, update: nextValue }) {
+function value(jsonFile, { default: defaultValue, path, state, update: nextValue }) {
   if (state === 'present') {
     let currentValue = getValue(jsonFile, path);
 

package/core/{lintStaged.js → lintStaged.cjs}

@@ -1,5 +1,5 @@
-const pkg = require('./pkg.js');
-const jsonFile = require('./jsonFile.js');
+const jsonFile = require('./jsonFile.cjs');
+const pkg = require('./pkg.cjs');
 
 /**
  * @typedef {Record<string, string|string[]>} LintStagedConfig
@@ -14,11 +14,11 @@ const jsonFile = require('./jsonFile.js');
 function lintStaged({ state, update }) {
   pkg.withPackageJson((packageFile) => {
     jsonFile.value(packageFile, {
+      /** @type {LintStagedConfig} */
+      default: {},
       path: 'lint-staged',
       state,
       update,
-      /** @type {LintStagedConfig} */
-      default: {},
     });
   });
 

package/core/{npm.js → npm.cjs}

@@ -1,29 +1,28 @@
 /* eslint-disable no-param-reassign */
 /* eslint-disable consistent-return */
 /* eslint-disable default-param-last */
-const { yarnVersion, yarnConfig } = require('@w5s/configurator-core');
-
+const { yarnConfig, yarnVersion } = require('@w5s/configurator-core');
 /* cSpell: disable */
 // @ts-check
 // @ts-ignore
 const fs = require('fs-extra');
 // @ts-ignore
+const listify = require('listify');
+// @ts-ignore
 const _ = require('lodash');
+const { json, yaml } = require('mrm-core');
 // @ts-ignore
-const semver = require('semver');
+const MrmError = require('mrm-core/src/error');
 // @ts-ignore
-const listify = require('listify');
+const packageJson = require('mrm-core/src/files/packageJson');
 // @ts-ignore
-const validateNpmPackageName = require('validate-npm-package-name');
+const execCommand = require('mrm-core/src/util/execCommand');
 // @ts-ignore
 const log = require('mrm-core/src/util/log');
 // @ts-ignore
-const execCommand = require('mrm-core/src/util/execCommand');
-// @ts-ignore
-const packageJson = require('mrm-core/src/files/packageJson');
+const semver = require('semver');
 // @ts-ignore
-const MrmError = require('mrm-core/src/error');
-const { yaml, json } = require('mrm-core');
+const validateNpmPackageName = require('validate-npm-package-name');
 
 /**
  * @typedef {{
@@ -44,146 +43,83 @@ const { yaml, json } = require('mrm-core');
  */
 
 /**
- * Install or update given npm packages if needed
- *
- * @param {Record<string, string> | string[] | string} deps
- * @param {Options} [options]
- * @param {Function=} exec
+ * @param {'npm'|'pnpm'|`yarn@${'classic'|'berry'}`} defaultPackageManager
  */
-function install(deps, options = {}, exec) {
-  const dev = options.dev !== false;
-  const manager = options.yarn ? 'yarn' : options.pnpm ? 'pnpm' : detectPackageManager();
-  const run = manager === 'yarn' ? runYarn : manager === 'pnpm' ? runPnpm : runNpm;
-
-  // options.versions is a min versions mapping,
-  // the list of packages to install will be taken from deps
-  let versions = options.versions || {};
-
-  /** @type string[] */
-  let dependencies = [];
+async function bootstrap(defaultPackageManager) {
+  const packageFile = json(`./package.json`);
+  const isYarn = isUsingYarn() || defaultPackageManager.startsWith('yarn@');
+  const isPnpm = isUsingPnpm() || defaultPackageManager === 'pnpm';
 
-  if (typeof deps === 'string') {
-    dependencies = [deps];
-  } else if (Array.isArray(deps)) {
-    dependencies = deps;
-  } else if (typeof deps === 'object' && deps !== null) {
-    // deps is an object with required versions
-    // prettier-ignore
-    versions = deps;
-    dependencies = Object.keys(deps);
+  if (!packageFile.get('packageManager') && isYarn) {
+    // Downgrade
+    if (defaultPackageManager.endsWith('@classic')) {
+      await yarnVersion({
+        state: 'present',
+        update: () => 'classic',
+      });
+    } else {
+      await yarnVersion({
+        state: 'present',
+        update: () => 'berry',
+      });
+      await yarnConfig({
+        key: 'nodeLinker',
+        state: 'present',
+        update: () => 'node-modules',
+      });
+    }
+  } else if (!packageFile.get('packageManager') && isPnpm) {
+    packageFile.set('packageManager', 'pnpm@latest');
+    packageFile.save();
   }
 
-  const newDeps = getUnsatisfiedDeps(dependencies, versions, { dev });
-  if (newDeps.length === 0) {
-    return;
+  // lock files
+  if (isYarn && !fs.existsSync('yarn.lock')) {
+    execCommand(undefined, 'yarn', ['install']);
   }
-
-  log.info(`Installing ${listify(newDeps)}...`);
-  const versionedDeps = newDeps.map((dep) => getVersionedDep(dep, versions));
-
-  return run(versionedDeps, { dev }, exec);
-}
-
-/**
- * Uninstall given npm packages
- *
- * @param {string[] | string} deps
- * @param {Options} [options]
- * @param {Function=} exec
- */
-function uninstall(deps, options = {}, exec) {
-  deps = _.castArray(deps);
-  const dev = options.dev !== false;
-  const manager = options.yarn ? 'yarn' : options.pnpm ? 'pnpm' : detectPackageManager();
-  const run = manager === 'yarn' ? runYarn : manager === 'pnpm' ? runPnpm : runNpm;
-
-  const installed = getOwnDependencies({ dev });
-
-  // @ts-ignore
-  const newDeps = deps.filter((dep) => installed[dep]);
-
-  if (newDeps.length === 0) {
-    return;
+  if (isPnpm && !fs.existsSync('pnpm-lock.yaml')) {
+    execCommand(undefined, 'pnpm', ['install']);
+  }
+  if (!isYarn && !isPnpm && !fs.existsSync('package-lock.json')) {
+    execCommand(undefined, 'npm', ['install']);
   }
-
-  log.info(`Uninstalling ${listify(newDeps)}...`);
-
-  return run(newDeps, { dev, remove: true }, exec);
-}
-
-/**
- * Install given npm packages
- *
- * @param {string[]} deps
- * @param {RunOptions} [options]
- * @param {Function} [exec]
- */
-function runNpm(deps, options = {}, exec) {
-  const args = [options.remove ? 'uninstall' : 'install', options.dev ? '--save-dev' : '--save', ...deps];
-
-  return execCommand(exec, 'npm', args, {
-    cwd: options.cwd,
-    stdio: options.stdio === undefined ? 'inherit' : options.stdio,
-  });
 }
 
 /**
- * Install given Yarn packages
- *
- * @param {string[]} deps
- * @param {RunOptions} [options]
- * @param {Function} [exec]
+ * @param {{
+ *   name: string|string[]|Record<string, string>,
+ *   state: 'present'|'absent',
+ *   dev?: boolean,
+ *   yarn?: boolean,
+ *   pnpm?: boolean,
+ * }} options
  */
-function runYarn(deps, options = {}, exec) {
-  const add = options.dev ? ['add', '--dev'] : ['add'];
-  const remove = ['remove'];
-  // eslint-disable-next-line unicorn/prefer-spread
-  const args = (options.remove ? remove : add).concat(isUsingWorkspaces() && !isYarnBerry() ? ['-W'] : []).concat(deps);
-
-  return execCommand(exec, 'yarn', args, {
-    cwd: options.cwd,
-    stdio: options.stdio === undefined ? 'inherit' : options.stdio,
-  });
+function dependency({ name, state, ...options }) {
+  if (state === 'present') {
+    install(name, options);
+  } else {
+    uninstall(typeof name === 'string' || Array.isArray(name) ? name : Object.keys(name));
+  }
 }
 
-/**
- * Install given PNPM packages
- *
- * @param {string[]} deps
- * @param {RunOptions} [options]
- * @param {Function} [exec]
- */
-function runPnpm(deps, options = {}, exec) {
-  const add = options.dev ? ['add', '--save-dev'] : ['add'];
-  const remove = ['remove'];
-  const args = [...(options.remove ? remove : add), ...(isUsingWorkspaces() ? ['--workspace-root'] : []), ...deps];
-
-  return execCommand(exec, 'pnpm', args, {
-    cwd: options.cwd,
-    stdio: options.stdio === undefined ? 'inherit' : options.stdio,
-  });
+function detectPackageManager() {
+  if (isUsingYarn()) {
+    return 'yarn';
+  }
+  if (isUsingPnpm()) {
+    return 'pnpm';
+  }
+  return 'npm';
 }
 
 /**
- * Add version or latest to package name
+ * Return version of installed npm package
  *
- * @param {string} dep
- * @param {Record<string, string>} versions
+ * @param {string} name
+ * @returns {string} - version
  */
-function getVersionedDep(dep, versions) {
-  // Handle non-registry packages (Github, bitbucket, etc.)
-  if (!validateNpmPackageName(dep).validForNewPackages) {
-    // If we were explicitly passed a version, attempt to
-    // load it via the `#semver:<semver>` syntax.
-    if (versions[dep]) {
-      return `${dep}#semver:${versions[dep]}`;
-    }
-
-    return dep;
-  }
-  const version = versions[dep] || 'latest';
-
-  return `${dep}@${version}`;
+function getInstalledVersion(name) {
+  return json(`./node_modules/${name}/package.json`).get('version');
 }
 
 /**
@@ -200,16 +136,6 @@ function getOwnDependencies(options) {
   return pkg.get(options.dev ? 'devDependencies' : 'dependencies') || {};
 }
 
-/**
- * Return version of installed npm package
- *
- * @param {string} name
- * @returns {string} - version
- */
-function getInstalledVersion(name) {
-  return json(`./node_modules/${name}/package.json`).get('version');
-}
-
 /**
  * Return only not installed dependencies, or dependencies which installed
  * version doesn't satisfy range.
@@ -259,94 +185,167 @@ function getUnsatisfiedDeps(deps, versions, options) {
   });
 }
 
-/*
- * Is project using Yarn?
+/**
+ * Add version or latest to package name
+ *
+ * @param {string} dep
+ * @param {Record<string, string>} versions
  */
-function isUsingYarn() {
-  return fs.existsSync('yarn.lock');
-}
+function getVersionedDep(dep, versions) {
+  // Handle non-registry packages (Github, bitbucket, etc.)
+  if (!validateNpmPackageName(dep).validForNewPackages) {
+    // If we were explicitly passed a version, attempt to
+    // load it via the `#semver:<semver>` syntax.
+    if (versions[dep]) {
+      return `${dep}#semver:${versions[dep]}`;
+    }
 
-function isUsingPnpm() {
-  return fs.existsSync('pnpm-lock.yaml');
+    return dep;
+  }
+  const version = versions[dep] || 'latest';
+
+  return `${dep}@${version}`;
 }
 
-function detectPackageManager() {
-  if (isUsingYarn()) {
-    return 'yarn';
+/**
+ * Install or update given npm packages if needed
+ *
+ * @param {Record<string, string> | string[] | string} deps
+ * @param {Options} [options]
+ * @param {Function=} exec
+ */
+function install(deps, options = {}, exec) {
+  const dev = options.dev !== false;
+  const manager = options.yarn ? 'yarn' : options.pnpm ? 'pnpm' : detectPackageManager();
+  const run = manager === 'yarn' ? runYarn : manager === 'pnpm' ? runPnpm : runNpm;
+
+  // options.versions is a min versions mapping,
+  // the list of packages to install will be taken from deps
+  let versions = options.versions || {};
+
+  /** @type string[] */
+  let dependencies = [];
+
+  if (typeof deps === 'string') {
+    dependencies = [deps];
+  } else if (Array.isArray(deps)) {
+    dependencies = deps;
+  } else if (typeof deps === 'object' && deps !== null) {
+    // deps is an object with required versions
+    // prettier-ignore
+    versions = deps;
+    dependencies = Object.keys(deps);
   }
-  if (isUsingPnpm()) {
-    return 'pnpm';
+
+  const newDeps = getUnsatisfiedDeps(dependencies, versions, { dev });
+  if (newDeps.length === 0) {
+    return;
   }
-  return 'npm';
+
+  log.info(`Installing ${listify(newDeps)}...`);
+  const versionedDeps = newDeps.map((dep) => getVersionedDep(dep, versions));
+
+  return run(versionedDeps, { dev }, exec);
+}
+
+function isUsingPnpm() {
+  return fs.existsSync('pnpm-lock.yaml');
 }
 
 function isUsingWorkspaces() {
   return Boolean(packageJson().get('workspaces'));
 }
 
+/*
+ * Is project using Yarn?
+ */
+function isUsingYarn() {
+  return fs.existsSync('yarn.lock');
+}
+
 function isYarnBerry() {
   const yamlRC = yaml('.yarnrc.yml');
   return yamlRC.exists() && !(yamlRC.get('yarnPath') || '').includes('.yarn/releases/yarn-1.');
 }
 
 /**
- * @param {'npm'|'pnpm'|`yarn@${'classic'|'berry'}`} defaultPackageManager
+ * Install given npm packages
+ *
+ * @param {string[]} deps
+ * @param {RunOptions} [options]
+ * @param {Function} [exec]
  */
-async function bootstrap(defaultPackageManager) {
-  const packageFile = json(`./package.json`);
-  const isYarn = isUsingYarn() || defaultPackageManager.startsWith('yarn@');
-  const isPnpm = isUsingPnpm() || defaultPackageManager === 'pnpm';
+function runNpm(deps, options = {}, exec) {
+  const args = [options.remove ? 'uninstall' : 'install', options.dev ? '--save-dev' : '--save', ...deps];
 
-  if (!packageFile.get('packageManager') && isYarn) {
-    // Downgrade
-    if (defaultPackageManager.endsWith('@classic')) {
-      await yarnVersion({
-        state: 'present',
-        update: () => 'classic',
-      });
-    } else {
-      await yarnVersion({
-        state: 'present',
-        update: () => 'berry',
-      });
-      await yarnConfig({
-        key: 'nodeLinker',
-        state: 'present',
-        update: () => 'node-modules',
-      });
-    }
-  } else if (!packageFile.get('packageManager') && isPnpm) {
-    packageFile.set('packageManager', 'pnpm@latest');
-    packageFile.save();
-  }
+  return execCommand(exec, 'npm', args, {
+    cwd: options.cwd,
+    stdio: options.stdio === undefined ? 'inherit' : options.stdio,
+  });
+}
 
-  // lock files
-  if (isYarn && !fs.existsSync('yarn.lock')) {
-    execCommand(undefined, 'yarn', ['install']);
-  }
-  if (isPnpm && !fs.existsSync('pnpm-lock.yaml')) {
-    execCommand(undefined, 'pnpm', ['install']);
-  }
-  if (!isYarn && !isPnpm && !fs.existsSync('package-lock.json')) {
-    execCommand(undefined, 'npm', ['install']);
-  }
+/**
+ * Install given PNPM packages
+ *
+ * @param {string[]} deps
+ * @param {RunOptions} [options]
+ * @param {Function} [exec]
+ */
+function runPnpm(deps, options = {}, exec) {
+  const add = options.dev ? ['add', '--save-dev'] : ['add'];
+  const remove = ['remove'];
+  const args = [...(options.remove ? remove : add), ...(isUsingWorkspaces() ? ['--workspace-root'] : []), ...deps];
+
+  return execCommand(exec, 'pnpm', args, {
+    cwd: options.cwd,
+    stdio: options.stdio === undefined ? 'inherit' : options.stdio,
+  });
 }
 
 /**
- * @param {{
- *   name: string|string[]|Record<string, string>,
- *   state: 'present'|'absent',
- *   dev?: boolean,
- *   yarn?: boolean,
- *   pnpm?: boolean,
- * }} options
+ * Install given Yarn packages
+ *
+ * @param {string[]} deps
+ * @param {RunOptions} [options]
+ * @param {Function} [exec]
  */
-function dependency({ name, state, ...options }) {
-  if (state === 'present') {
-    install(name, options);
-  } else {
-    uninstall(typeof name === 'string' || Array.isArray(name) ? name : Object.keys(name));
+function runYarn(deps, options = {}, exec) {
+  const add = options.dev ? ['add', '--dev'] : ['add'];
+  const remove = ['remove'];
+
+  const args = (options.remove ? remove : add).concat(isUsingWorkspaces() && !isYarnBerry() ? ['-W'] : []).concat(deps);
+
+  return execCommand(exec, 'yarn', args, {
+    cwd: options.cwd,
+    stdio: options.stdio === undefined ? 'inherit' : options.stdio,
+  });
+}
+
+/**
+ * Uninstall given npm packages
+ *
+ * @param {string[] | string} deps
+ * @param {Options} [options]
+ * @param {Function=} exec
+ */
+function uninstall(deps, options = {}, exec) {
+  deps = _.castArray(deps);
+  const dev = options.dev !== false;
+  const manager = options.yarn ? 'yarn' : options.pnpm ? 'pnpm' : detectPackageManager();
+  const run = manager === 'yarn' ? runYarn : manager === 'pnpm' ? runPnpm : runNpm;
+
+  const installed = getOwnDependencies({ dev });
+
+  // @ts-ignore
+  const newDeps = deps.filter((dep) => installed[dep]);
+
+  if (newDeps.length === 0) {
+    return;
   }
+
+  log.info(`Uninstalling ${listify(newDeps)}...`);
+
+  return run(newDeps, { dev, remove: true }, exec);
 }
 
 module.exports = {