@form8ion/javascript 7.2.0 → 7.2.3

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, dialects, projectTypes, 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, applyEnhancers, fileTypes } from '@form8ion/core';
-import { info, error, warn } from '@travi/cli-messages';
+import { fileExists, fileTypes, writeConfigFile, applyEnhancers } from '@form8ion/core';
+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';
@@ -24,7 +24,7 @@ import { resolve } from 'path';
 import filedirname from 'filedirname';
 import * as huskyPlugin from '@form8ion/husky';
 import { scaffold as scaffold$2 } from '@form8ion/husky';
-import { write } from '@form8ion/config-file';
+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';
 
@@ -177,6 +177,90 @@ var enginesEnhancer = /*#__PURE__*/Object.freeze({
   lift: lift$1
 });
 
+function write ({projectRoot, config}) {
+  return write$1({path: projectRoot, name: 'babel', format: fileTypes.JSON, config});
+}
+
+async function addIgnore ({projectRoot, ignore}) {
+  if (ignore) {
+    const existingConfig = JSON.parse(await promises.readFile(`${projectRoot}/.babelrc.json`, 'utf-8'));
+
+    await write({projectRoot, config: {...existingConfig, ignore: [`./${ignore}/`]}});
+  }
+}
+
+async function scaffoldBabel ({projectRoot, preset}) {
+  if (!preset) {
+    throw new Error('No babel preset provided. Cannot configure babel transpilation');
+  }
+
+  await write({projectRoot, config: {presets: [preset.name]}});
+
+  return {
+    devDependencies: ['@babel/register', preset.packageName],
+    eslint: {}
+  };
+}
+
+async function lifter ({buildDirectory, projectRoot}) {
+  await addIgnore({ignore: buildDirectory, projectRoot});
+
+  return {};
+}
+
+function predicate ({projectRoot}) {
+  return fileExists(`${projectRoot}/.babelrc.json`);
+}
+
+async function scaffoldTypescript ({config, projectType, projectRoot, testFilenamePattern}) {
+  const eslintConfigs = ['typescript'];
+  const shareableTsConfigPackage = `${config.scope}/tsconfig`;
+
+  await writeConfigFile({
+    path: projectRoot,
+    name: 'tsconfig',
+    format: fileTypes.JSON,
+    config: {
+      $schema: 'https://json.schemastore.org/tsconfig',
+      extends: shareableTsConfigPackage,
+      compilerOptions: {
+        rootDir: 'src',
+        ...projectTypes.PACKAGE === projectType && {
+          outDir: 'lib',
+          declaration: true
+        }
+      },
+      include: ['src/**/*.ts'],
+      ...testFilenamePattern && {exclude: [testFilenamePattern]}
+    }
+  });
+
+  return {
+    eslint: {configs: eslintConfigs},
+    eslintConfigs,
+    devDependencies: ['typescript', shareableTsConfigPackage],
+    vcsIgnore: {files: ['tsconfig.tsbuildinfo']}
+  };
+}
+
+function scaffoldDialect ({dialect, projectType, projectRoot, configs, testFilenamePattern}) {
+  switch (dialect) {
+    case dialects$1.BABEL:
+      return scaffoldBabel({preset: configs.babelPreset, projectRoot});
+    case dialects$1.TYPESCRIPT:
+      return scaffoldTypescript({config: configs.typescript, projectType, projectRoot, testFilenamePattern});
+    default:
+      return {};
+  }
+}
+
+var dialects = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  scaffold: scaffoldDialect,
+  test: predicate,
+  lift: lifter
+});
+
 function scaffoldScripts () {
   return {};
 }
@@ -234,7 +318,7 @@ function buildPackageDetails ({
     name: packageName,
     description,
     license,
-    type: dialects.ESM === dialect ? 'module' : 'commonjs',
+    type: dialects$1.ESM === dialect ? 'module' : 'commonjs',
     ...defineVcsHostDetails(vcs, projectType, packageName, pathWithinParent),
     author: `${author.name}${author.email ? ` <${author.email}>` : ''}${author.url ? ` (${author.url})` : ''}`,
     scripts: scaffoldScripts()
@@ -270,6 +354,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,
@@ -300,8 +430,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');
   }
@@ -324,15 +454,24 @@ async function resolvePackageManager ({projectRoot, packageManager}) {
 async function lift ({projectRoot, vcs, results}) {
   info('Lifting JavaScript-specific details');
 
-  const {scripts, tags, eslintConfigs, eslint, dependencies, devDependencies, packageManager: manager} = results;
+  const {
+    scripts,
+    tags,
+    eslintConfigs,
+    eslint,
+    dependencies,
+    devDependencies,
+    packageManager: manager,
+    buildDirectory
+  } = 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],
-    options: {packageManager, projectRoot, vcs}
+    enhancers: [huskyPlugin, enginesEnhancer, coveragePlugin, commitConventionPlugin, dialects],
+    options: {packageManager, projectRoot, vcs, buildDirectory}
   });
 
   await liftPackage(
@@ -434,10 +573,10 @@ function validate(options) {
 
 function buildDialectChoices ({babelPreset, typescript}) {
   return [
-    {name: 'Common JS (no transpilation)', value: dialects.COMMON_JS, short: 'cjs'},
-    ...babelPreset ? [{name: 'Modern JavaScript (transpiled)', value: dialects.BABEL, short: 'modern'}] : [],
-    {name: 'ESM-only (no transpilation)', value: dialects.ESM, short: 'esm'},
-    ...typescript ? [{name: 'TypeScript', value: dialects.TYPESCRIPT, short: 'ts'}] : []
+    {name: 'Common JS (no transpilation)', value: dialects$1.COMMON_JS, short: 'cjs'},
+    ...babelPreset ? [{name: 'Modern JavaScript (transpiled)', value: dialects$1.BABEL, short: 'modern'}] : [],
+    {name: 'ESM-only (no transpilation)', value: dialects$1.ESM, short: 'esm'},
+    ...typescript ? [{name: 'TypeScript', value: dialects$1.TYPESCRIPT, short: 'ts'}] : []
   ];
 }
 
@@ -620,64 +759,6 @@ async function prompt(
   };
 }
 
-async function scaffoldBabel ({projectRoot, preset, buildDirectory}) {
-  if (!preset) {
-    throw new Error('No babel preset provided. Cannot configure babel transpilation');
-  }
-
-  await write({
-    path: projectRoot,
-    name: 'babel',
-    format: fileTypes.JSON,
-    config: {presets: [preset.name], ignore: [`./${buildDirectory}/`]}
-  });
-
-  return {
-    devDependencies: ['@babel/register', preset.packageName],
-    eslint: {}
-  };
-}
-
-async function scaffoldTypescript ({config, projectType, projectRoot, testFilenamePattern}) {
-  const eslintConfigs = ['typescript'];
-  const shareableTsConfigPackage = `${config.scope}/tsconfig`;
-
-  await promises.writeFile(
-    `${projectRoot}/tsconfig.json`,
-    JSON.stringify({
-      $schema: 'https://json.schemastore.org/tsconfig',
-      extends: shareableTsConfigPackage,
-      compilerOptions: {
-        rootDir: 'src',
-        ...projectTypes.PACKAGE === projectType && {
-          outDir: 'lib',
-          declaration: true
-        }
-      },
-      include: ['src/**/*.ts'],
-      ...testFilenamePattern && {exclude: [testFilenamePattern]}
-    })
-  );
-
-  return {
-    eslint: {configs: eslintConfigs},
-    eslintConfigs,
-    devDependencies: ['typescript', shareableTsConfigPackage],
-    vcsIgnore: {files: ['tsconfig.tsbuildinfo']}
-  };
-}
-
-function scaffoldDialect ({dialect, projectType, projectRoot, configs, buildDirectory, testFilenamePattern}) {
-  switch (dialect) {
-    case dialects.BABEL:
-      return scaffoldBabel({preset: configs.babelPreset, projectRoot, buildDirectory});
-    case dialects.TYPESCRIPT:
-      return scaffoldTypescript({config: configs.typescript, projectType, projectRoot, testFilenamePattern});
-    default:
-      return {};
-  }
-}
-
 function projectWillNotBeConsumed(projectType) {
   return projectTypes.APPLICATION === projectType || projectTypes.CLI === projectType;
 }
@@ -885,7 +966,7 @@ async function buildDetails ({
   dialect,
   decisions
 }) {
-  if (dialects.COMMON_JS === dialect) return buildDetailsForCommonJsProject({projectRoot, projectName});
+  if (dialects$1.COMMON_JS === dialect) return buildDetailsForCommonJsProject({projectRoot, projectName});
 
   const chosenBundler = await chooseBundler({bundlers: packageBundlers, decisions});
 
@@ -942,14 +1023,14 @@ async function scaffoldPackageType ({
     mergeIntoExistingPackageJson({
       projectRoot,
       config: {
-        files: ['example.js', ...dialects.COMMON_JS === dialect ? ['index.js'] : ['lib/']],
+        files: ['example.js', ...dialects$1.COMMON_JS === dialect ? ['index.js'] : ['lib/']],
         publishConfig: {
           access: 'Public' === visibility ? 'public' : 'restricted',
           ...publishRegistry && {registry: publishRegistry}
         },
         sideEffects: false,
         ...'Public' === visibility && {runkitExampleFilename: './example.js'},
-        ...dialects.BABEL === dialect && {
+        ...dialects$1.BABEL === dialect && {
           main: './lib/index.js',
           module: './lib/index.mjs',
           exports: {
@@ -957,11 +1038,11 @@ async function scaffoldPackageType ({
             import: './lib/index.mjs'
           }
         },
-        ...dialects.ESM === dialect && {
+        ...dialects$1.ESM === dialect && {
           main: './lib/index.mjs',
           exports: './lib/index.mjs'
         },
-        ...dialects.TYPESCRIPT === dialect && {
+        ...dialects$1.TYPESCRIPT === dialect && {
           main: './lib/index.js',
           module: './lib/index.mjs',
           types: './lib/index.d.ts',
@@ -1272,7 +1353,7 @@ async function scaffoldEslint ({config, projectRoot, buildDirectory, additionalC
 }
 
 async function scaffoldRemark ({config, projectRoot, projectType, vcs, dialect}) {
-  await write({
+  await write$1({
     format: fileTypes.JSON,
     path: projectRoot,
     name: 'remark',
@@ -1304,7 +1385,7 @@ async function scaffoldRemark ({config, projectRoot, projectType, vcs, dialect})
     {
       ...projectTypes.PACKAGE === projectType && {
         devDependencies: ['remark-usage'],
-        ...dialects.COMMON_JS !== dialect && {scripts: {'pregenerate:md': 'run-s build'}}
+        ...dialects$1.COMMON_JS !== dialect && {scripts: {'pregenerate:md': 'run-s build'}}
       }
     }
   );
@@ -1430,7 +1511,6 @@ async function scaffolder (options) {
       configs,
       projectRoot,
       projectType,
-      buildDirectory: projectTypeResults.buildDirectory,
       testFilenamePattern: verificationResults.testFilenamePattern
     }),
     scaffoldCodeStyle({
@@ -1470,8 +1550,8 @@ async function scaffolder (options) {
       scaffoldChoice(ciServices, ci, {projectRoot, vcs, visibility, projectType, projectName, nodeVersion, tests}),
       scaffold$5({projectRoot, projectType, configs, pathWithinParent})
     ])),
-    projectTypePluginResults,
     projectTypeResults,
+    projectTypePluginResults,
     verificationResults,
     codeStyleResults,
     npmResults,