@form8ion/javascript 7.2.2 → 7.2.5

package/lib/index.mjs

@@ -1,12 +1,12 @@
 import { questionNames as questionNames$2, questions } from '@travi/language-scaffolder-prompts';
 import deepmerge from 'deepmerge';
-import { validateOptions, scaffoldChoice, projectTypes, dialects as dialects$1, writePackageJson, installDependencies, PROD_DEPENDENCY_TYPE, DEV_DEPENDENCY_TYPE, packageManagers, mergeIntoExistingPackageJson } from '@form8ion/javascript-core';
+import { validateOptions, scaffoldChoice, projectTypes, dialects as dialects$1, writePackageJson, packageManagers, DEV_DEPENDENCY_TYPE, PROD_DEPENDENCY_TYPE, mergeIntoExistingPackageJson } from '@form8ion/javascript-core';
 import joi from 'joi';
 import { prompt as prompt$1, Separator } from '@form8ion/overridable-prompts';
 import { scaffold, lift as lift$3 } from '@form8ion/codecov';
 import { promises } from 'fs';
 import { fileExists, fileTypes, writeConfigFile, applyEnhancers } from '@form8ion/core';
-import { info, error, warn } from '@travi/cli-messages';
+import { info, warn, error } from '@travi/cli-messages';
 import * as commitConventionPlugin from '@form8ion/commit-convention';
 import { scaffold as scaffold$5 } from '@form8ion/commit-convention';
 import hoek from '@hapi/hoek';
@@ -15,7 +15,7 @@ import npmConf from 'npm-conf';
 import { stringify } from 'ini';
 import { EOL } from 'os';
 import validatePackageName from 'validate-npm-package-name';
-import { scaffold as scaffold$1 } from '@form8ion/rollup';
+import { scaffold as scaffold$3 } from '@form8ion/rollup';
 import mustache from 'mustache';
 import camelcase from 'camelcase';
 import makeDir from 'make-dir';
@@ -23,10 +23,10 @@ import touch from 'touch';
 import { resolve } from 'path';
 import filedirname from 'filedirname';
 import * as huskyPlugin from '@form8ion/husky';
-import { scaffold as scaffold$2 } from '@form8ion/husky';
+import { scaffold as scaffold$4 } from '@form8ion/husky';
 import { write as write$1 } from '@form8ion/config-file';
-import { scaffold as scaffold$4 } from '@form8ion/prettier';
-import { lift as lift$4, scaffold as scaffold$3 } from '@form8ion/eslint';
+import { scaffold as scaffold$2 } from '@form8ion/prettier';
+import { scaffold as scaffold$1, lift as lift$4, test as test$2 } from '@form8ion/eslint';
 
 const questionNames$1 = {
   UNIT_TEST_FRAMEWORK: 'unitTestFramework',
@@ -155,6 +155,87 @@ async function scaffoldUnitTesting ({projectRoot, frameworks, decisions, visibil
   ]);
 }
 
+async function scaffoldEslint ({config, projectRoot, additionalConfiguration}) {
+  const {scope} = config;
+  const {ignore} = additionalConfiguration;
+
+  return scaffold$1({scope, projectRoot, ignore});
+}
+
+function lifter$1 ({results: {buildDirectory, eslintConfigs, eslint}, projectRoot}) {
+  return lift$4({projectRoot, configs: [...eslintConfigs || [], ...eslint?.configs || []], buildDirectory});
+}
+
+async function scaffoldRemark ({config, projectRoot, projectType, vcs, dialect}) {
+  await write$1({
+    format: fileTypes.JSON,
+    path: projectRoot,
+    name: 'remark',
+    config: {
+      settings: {
+        listItemIndent: 1,
+        emphasis: '_',
+        strong: '_',
+        bullet: '*',
+        incrementListMarker: false
+      },
+      plugins: [
+        config,
+        ['remark-toc', {tight: true}],
+        ...projectTypes.PACKAGE === projectType ? [['remark-usage', {heading: 'example'}]] : [],
+        ...!vcs ? [['validate-links', {repository: false}]] : []
+      ]
+    }
+  });
+
+  return deepmerge(
+    {
+      devDependencies: [config, 'remark-cli', 'remark-toc'],
+      scripts: {
+        'lint:md': 'remark . --frail',
+        'generate:md': 'remark . --output'
+      }
+    },
+    {
+      ...projectTypes.PACKAGE === projectType && {
+        devDependencies: ['remark-usage'],
+        ...dialects$1.COMMON_JS !== dialect && {scripts: {'pregenerate:md': 'run-s build'}}
+      }
+    }
+  );
+}
+
+async function scaffoldCodeStyle ({
+  projectRoot,
+  projectType,
+  dialect,
+  configs,
+  vcs,
+  configureLinting,
+  eslint
+}) {
+  return deepmerge.all(await Promise.all([
+    configs.eslint
+      && configureLinting
+      && scaffoldEslint({projectRoot, config: configs.eslint, additionalConfiguration: eslint}),
+    scaffoldRemark({
+      projectRoot,
+      projectType,
+      dialect,
+      vcs,
+      config: configs.remark || '@form8ion/remark-lint-preset'
+    }),
+    scaffold$2({projectRoot, config: configs.prettier})
+  ].filter(Boolean)));
+}
+
+var codeStylePlugin = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  scaffold: scaffoldCodeStyle,
+  lift: lifter$1,
+  test: test$2
+});
+
 async function test$1({projectRoot}) {
   const {engines} = JSON.parse(await promises.readFile(`${projectRoot}/package.json`, 'utf8'));
 
@@ -202,8 +283,8 @@ async function scaffoldBabel ({projectRoot, preset}) {
   };
 }
 
-async function lifter ({buildDirectory, projectRoot}) {
-  await addIgnore({ignore: buildDirectory, projectRoot});
+async function lifter ({results, projectRoot}) {
+  await addIgnore({ignore: results.buildDirectory, projectRoot});
 
   return {};
 }
@@ -354,6 +435,52 @@ async function scaffoldPackage ({
   return {homepage: packageData.homepage};
 }
 
+const details = {
+  [packageManagers.NPM]: {
+    installationCommand: 'install',
+    installationFlags: {
+      [DEV_DEPENDENCY_TYPE]: `save-${DEV_DEPENDENCY_TYPE}`,
+      [PROD_DEPENDENCY_TYPE]: `save-${PROD_DEPENDENCY_TYPE}`,
+      exact: 'save-exact'
+    }
+  },
+  [packageManagers.YARN]: {
+    installationCommand: 'add',
+    installationFlags: {
+      [DEV_DEPENDENCY_TYPE]: DEV_DEPENDENCY_TYPE,
+      [PROD_DEPENDENCY_TYPE]: PROD_DEPENDENCY_TYPE,
+      exact: 'exact'
+    }
+  }
+};
+
+function getInstallationCommandFor(manager) {
+  return details[manager].installationCommand;
+}
+
+function getDependencyTypeFlag(manager, type) {
+  return details[manager].installationFlags[type];
+}
+
+function getExactFlag(manager) {
+  return details[manager].installationFlags.exact;
+}
+
+async function install$1 (dependencies, dependenciesType, projectRoot, packageManager = packageManagers.NPM) {
+  if (dependencies.length) {
+    info(`Installing ${dependenciesType} dependencies`, {level: 'secondary'});
+
+    await execa(
+      `. ~/.nvm/nvm.sh && nvm use && ${packageManager} ${
+        getInstallationCommandFor(packageManager)
+      } ${[...new Set(dependencies)].join(' ')} --${getDependencyTypeFlag(packageManager, dependenciesType)}${
+        DEV_DEPENDENCY_TYPE === dependenciesType ? ` --${getExactFlag(packageManager)}` : ''
+      }`,
+      {shell: true, cwd: projectRoot}
+    );
+  } else warn(`No ${dependenciesType} dependencies to install`);
+}
+
 async function liftPackage ({
   projectRoot,
   scripts,
@@ -384,8 +511,8 @@ async function liftPackage ({
   info('Installing dependencies');
 
   try {
-    await installDependencies(dependencies || [], PROD_DEPENDENCY_TYPE, projectRoot, packageManager);
-    await installDependencies([...devDependencies || []], DEV_DEPENDENCY_TYPE, projectRoot, packageManager);
+    await install$1(dependencies || [], PROD_DEPENDENCY_TYPE, projectRoot, packageManager);
+    await install$1([...devDependencies || []], DEV_DEPENDENCY_TYPE, projectRoot, packageManager);
   } catch (e) {
     error('Failed to install dependencies');
   }
@@ -411,28 +538,23 @@ async function lift ({projectRoot, vcs, results}) {
   const {
     scripts,
     tags,
-    eslintConfigs,
-    eslint,
     dependencies,
     devDependencies,
-    packageManager: manager,
-    buildDirectory
+    packageManager: manager
   } = results;
 
   const packageManager = await resolvePackageManager({projectRoot, packageManager: manager});
 
-  const eslintResults = await lift$4({projectRoot, configs: [...eslintConfigs || [], ...eslint?.configs || []]});
   const enhancerResults = await applyEnhancers({
     results,
-    enhancers: [huskyPlugin, enginesEnhancer, coveragePlugin, commitConventionPlugin, dialects],
-    options: {packageManager, projectRoot, vcs, buildDirectory}
+    enhancers: [huskyPlugin, enginesEnhancer, coveragePlugin, commitConventionPlugin, dialects, codeStylePlugin],
+    options: {packageManager, projectRoot, vcs}
   });
 
   await liftPackage(
     deepmerge.all([
       {projectRoot, scripts, tags, dependencies, devDependencies, packageManager},
-      enhancerResults,
-      eslintResults
+      enhancerResults
     ])
   );
 
@@ -1068,7 +1190,7 @@ const defaultBuildDirectory = 'bin';
 
 async function scaffoldCliType ({packageName, visibility, projectRoot, dialect, publishRegistry}) {
   const [rollupResults] = await Promise.all([
-    scaffold$1({projectRoot, dialect, projectType: projectTypes.CLI}),
+    scaffold$3({projectRoot, dialect, projectType: projectTypes.CLI}),
     mergeIntoExistingPackageJson({
       projectRoot,
       config: {
@@ -1245,15 +1367,17 @@ async function scaffoldLockfileLint ({projectRoot, packageManager, registries})
     );
   }
 
-  await promises.writeFile(
-    `${projectRoot}/.lockfile-lintrc.json`,
-    JSON.stringify({
+  await write$1({
+    name: 'lockfile-lint',
+    format: fileTypes.JSON,
+    path: projectRoot,
+    config: {
       path: determineLockfilePathFor(packageManager),
       type: packageManager,
       'validate-https': true,
       'allowed-hosts': buildAllowedHostsList({packageManager, registries})
-    })
-  );
+    }
+  });
 
   return {
     devDependencies: ['lockfile-lint'],
@@ -1292,88 +1416,12 @@ async function scaffoldVerification({
       pathWithinParent
     }),
     scaffoldLinting({projectRoot, packageManager, registries, vcs, pathWithinParent}),
-    scaffold$2({projectRoot, packageManager, pathWithinParent})
+    scaffold$4({projectRoot, packageManager, pathWithinParent})
   ]);
 
   return deepmerge.all([testingResults, lintingResults, huskyResults]);
 }
 
-async function scaffoldEslint ({config, projectRoot, buildDirectory, additionalConfiguration}) {
-  const {scope} = config;
-  const {ignore} = additionalConfiguration;
-  const ignores = deepmerge(ignore, {directories: [`/${buildDirectory}/`]});
-
-  return scaffold$3({scope, projectRoot, ignore: {directories: ignores.directories}});
-}
-
-async function scaffoldRemark ({config, projectRoot, projectType, vcs, dialect}) {
-  await write$1({
-    format: fileTypes.JSON,
-    path: projectRoot,
-    name: 'remark',
-    config: {
-      settings: {
-        listItemIndent: 1,
-        emphasis: '_',
-        strong: '_',
-        bullet: '*',
-        incrementListMarker: false
-      },
-      plugins: [
-        config,
-        ['remark-toc', {tight: true}],
-        ...projectTypes.PACKAGE === projectType ? [['remark-usage', {heading: 'example'}]] : [],
-        ...!vcs ? [['validate-links', {repository: false}]] : []
-      ]
-    }
-  });
-
-  return deepmerge(
-    {
-      devDependencies: [config, 'remark-cli', 'remark-toc'],
-      scripts: {
-        'lint:md': 'remark . --frail',
-        'generate:md': 'remark . --output'
-      }
-    },
-    {
-      ...projectTypes.PACKAGE === projectType && {
-        devDependencies: ['remark-usage'],
-        ...dialects$1.COMMON_JS !== dialect && {scripts: {'pregenerate:md': 'run-s build'}}
-      }
-    }
-  );
-}
-
-async function scaffoldCodeStyle ({
-  projectRoot,
-  projectType,
-  dialect,
-  configs,
-  vcs,
-  configureLinting,
-  buildDirectory,
-  eslint
-}) {
-  return deepmerge.all(await Promise.all([
-    configs.eslint && configureLinting
-      && scaffoldEslint({
-        projectRoot,
-        config: configs.eslint,
-        buildDirectory,
-        additionalConfiguration: eslint
-      }),
-    scaffoldRemark({
-      projectRoot,
-      projectType,
-      dialect,
-      vcs,
-      config: configs.remark || '@form8ion/remark-lint-preset'
-    }),
-    scaffold$4({projectRoot, config: configs.prettier})
-  ].filter(Boolean)));
-}
-
 async function scaffolder (options) {
   info('Initializing JavaScript project');
 
@@ -1474,7 +1522,6 @@ async function scaffolder (options) {
       configs,
       vcs,
       configureLinting,
-      buildDirectory: projectTypeResults.buildDirectory,
       eslint: verificationResults.eslint
     }),
     scaffoldProjectTypePlugin({