@form8ion/javascript 2.0.0 → 3.0.0-alpha.1

package/lib/index.es.js

@@ -1,41 +1,36 @@
 import { questionNames as questionNames$2, questions } from '@travi/language-scaffolder-prompts';
 import deepmerge from 'deepmerge';
-import { validateOptions, scaffoldChoice, dialects, projectTypes, packageManagers } from '@form8ion/javascript-core';
-import { scaffold as scaffold$1 } from '@form8ion/codecov';
+import { validateOptions, scaffoldChoice, installDependencies, PROD_DEPENDENCY_TYPE, DEV_DEPENDENCY_TYPE, packageManagers, dialects, projectTypes } from '@form8ion/javascript-core';
+import { scaffold } from '@form8ion/codecov';
 import { promises } from 'fs';
-import * as joi from '@hapi/joi';
+import * as joi from 'joi';
 import { Separator } from 'inquirer';
 import { prompt as prompt$1 } from '@form8ion/overridable-prompts';
-import { warn, info } from '@travi/cli-messages';
-import { lift } from '@form8ion/lift-javascript';
-import { scaffold as scaffold$5 } from '@form8ion/commit-convention';
+import { info, warn } from '@travi/cli-messages';
+import { lift as lift$3, scaffold as scaffold$2 } from '@form8ion/eslint';
+import { fileExists } from '@form8ion/core';
+import { test as test$2, lift as lift$2, scaffold as scaffold$3 } from '@form8ion/husky';
+import { scaffold as scaffold$4 } from '@form8ion/commit-convention';
 import hoek from '@hapi/hoek';
 import execa from 'execa';
 import { stringify } from 'ini';
 import { EOL } from 'os';
 import validatePackageName from 'validate-npm-package-name';
-import { scaffold as scaffold$2 } from '@form8ion/rollup';
+import { scaffold as scaffold$1 } from '@form8ion/rollup';
 import mustache from 'mustache';
 import camelcase from 'camelcase';
 import makeDir from 'make-dir';
 import touch from 'touch';
 import { resolve } from 'path';
-import { scaffold as scaffold$4 } from '@form8ion/husky';
-import { scaffold as scaffold$3 } from '@form8ion/eslint';
 
 function ownKeys(object, enumerableOnly) {
   var keys = Object.keys(object);
 
   if (Object.getOwnPropertySymbols) {
     var symbols = Object.getOwnPropertySymbols(object);
-
-    if (enumerableOnly) {
-      symbols = symbols.filter(function (sym) {
-        return Object.getOwnPropertyDescriptor(object, sym).enumerable;
-      });
-    }
-
-    keys.push.apply(keys, symbols);
+    enumerableOnly && (symbols = symbols.filter(function (sym) {
+      return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+    })), keys.push.apply(keys, symbols);
   }
 
   return keys;
@@ -43,19 +38,12 @@ function ownKeys(object, enumerableOnly) {
 
 function _objectSpread2(target) {
   for (var i = 1; i < arguments.length; i++) {
-    var source = arguments[i] != null ? arguments[i] : {};
-
-    if (i % 2) {
-      ownKeys(Object(source), true).forEach(function (key) {
-        _defineProperty(target, key, source[key]);
-      });
-    } else if (Object.getOwnPropertyDescriptors) {
-      Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
-    } else {
-      ownKeys(Object(source)).forEach(function (key) {
-        Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
-      });
-    }
+    var source = null != arguments[i] ? arguments[i] : {};
+    i % 2 ? ownKeys(Object(source), !0).forEach(function (key) {
+      _defineProperty(target, key, source[key]);
+    }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) {
+      Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+    });
   }
 
   return target;
@@ -116,13 +104,15 @@ async function scaffoldC8 ({
 async function scaffoldCoverage ({
   projectRoot,
   vcs,
-  visibility
+  visibility,
+  pathWithinParent
 }) {
   return deepmerge(await scaffoldC8({
     projectRoot
-  }), await scaffold$1({
+  }), await scaffold({
     vcs,
-    visibility
+    visibility,
+    pathWithinParent
   }));
 }
 
@@ -149,7 +139,8 @@ async function scaffoldUnitTesting ({
   frameworks,
   decisions,
   visibility,
-  vcs
+  vcs,
+  pathWithinParent
 }) {
   const validatedFrameworks = validateOptions(unitTestFrameworksSchema, frameworks);
   const [framework, coverage] = await Promise.all([chooseFramework({
@@ -160,7 +151,8 @@ async function scaffoldUnitTesting ({
   })), scaffoldCoverage({
     projectRoot,
     vcs,
-    visibility
+    visibility,
+    pathWithinParent
   })]);
   return deepmerge.all([{
     scripts: {
@@ -169,6 +161,157 @@ async function scaffoldUnitTesting ({
   }, framework, coverage]);
 }
 
+async function applyEnhancers ({
+  results,
+  enhancers = {},
+  projectRoot
+}) {
+  info('Applying Enhancers');
+  return Object.values(enhancers).reduce(async (acc, enhancer) => {
+    if (await enhancer.test({
+      projectRoot
+    })) {
+      const previousResults = await acc;
+      return deepmerge(previousResults, await enhancer.lift({
+        results: previousResults,
+        projectRoot
+      }));
+    }
+
+    return acc;
+  }, results);
+}
+
+async function test$1({
+  projectRoot
+}) {
+  const {
+    engines
+  } = JSON.parse(await promises.readFile(`${projectRoot}/package.json`, 'utf8'));
+  return !!(engines !== null && engines !== void 0 && engines.node);
+}
+async function lift$1({
+  projectRoot
+}) {
+  const {
+    name
+  } = JSON.parse(await promises.readFile(`${projectRoot}/package.json`, 'utf8'));
+  return {
+    devDependencies: ['ls-engines'],
+    scripts: {
+      'lint:engines': 'ls-engines'
+    },
+    badges: {
+      consumer: {
+        node: {
+          img: `https://img.shields.io/node/v/${name}?logo=node.js`,
+          text: 'node'
+        }
+      }
+    }
+  };
+}
+
+var enginesEnhancer = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  test: test$1,
+  lift: lift$1
+});
+
+async function liftPackage ({
+  projectRoot,
+  scripts,
+  tags,
+  dependencies,
+  devDependencies,
+  packageManager
+}) {
+  if (scripts || tags) {
+    info('Updating `package.json`', {
+      level: 'secondary'
+    });
+    const pathToPackageJson = `${projectRoot}/package.json`;
+    const existingPackageJsonContents = JSON.parse(await promises.readFile(pathToPackageJson, 'utf8'));
+    await promises.writeFile(pathToPackageJson, JSON.stringify(_objectSpread2(_objectSpread2({}, existingPackageJsonContents), {}, {
+      scripts: _objectSpread2(_objectSpread2({}, existingPackageJsonContents.scripts), scripts)
+    }, tags && {
+      keywords: existingPackageJsonContents.keywords ? [...existingPackageJsonContents.keywords, ...tags] : tags
+    }), null, 2));
+  }
+
+  info('Installing dependencies');
+  await installDependencies(dependencies || [], PROD_DEPENDENCY_TYPE, projectRoot, packageManager);
+  await installDependencies([...(devDependencies || [])], DEV_DEPENDENCY_TYPE, projectRoot, packageManager);
+}
+
+async function resolvePackageManager ({
+  projectRoot,
+  packageManager
+}) {
+  if (packageManager) return packageManager;
+
+  if (await fileExists(`${projectRoot}/package-lock.json`)) {
+    return packageManagers.NPM;
+  }
+
+  if (await fileExists(`${projectRoot}/yarn.lock`)) {
+    return packageManagers.YARN;
+  }
+
+  throw new Error('Package-manager could not be determined');
+}
+
+function enhanceHuskyEnhancer(packageManager) {
+  return {
+    test: test$2,
+    lift: ({
+      projectRoot,
+      results
+    }) => lift$2({
+      projectRoot,
+      results,
+      packageManager
+    })
+  };
+}
+
+async function lift ({
+  projectRoot,
+  results
+}) {
+  info('Lifting JavaScript-specific details');
+  const {
+    scripts,
+    tags,
+    eslintConfigs,
+    dependencies,
+    devDependencies,
+    packageManager: manager
+  } = results;
+  const packageManager = await resolvePackageManager({
+    projectRoot,
+    packageManager: manager
+  });
+  const eslintResults = await lift$3({
+    projectRoot,
+    configs: eslintConfigs
+  });
+  const enhancerResults = await applyEnhancers({
+    results,
+    enhancers: [enhanceHuskyEnhancer(packageManager), enginesEnhancer],
+    projectRoot
+  });
+  await liftPackage(deepmerge.all([{
+    projectRoot,
+    scripts,
+    tags,
+    dependencies,
+    devDependencies,
+    packageManager
+  }, enhancerResults, eslintResults]));
+  return enhancerResults;
+}
+
 function validate(options) {
   const schema = joi.object().required().keys({
     projectRoot: joi.string().required(),
@@ -790,7 +933,7 @@ function defineBadges (packageName, visibility) {
   return {
     consumer: _objectSpread2({}, 'Public' === visibility && {
       npm: {
-        img: `https://img.shields.io/npm/v/${packageName}.svg`,
+        img: `https://img.shields.io/npm/v/${packageName}?logo=npm`,
         text: 'npm',
         link: `https://www.npmjs.com/package/${packageName}`
       }
@@ -831,7 +974,7 @@ async function buildDetails ({
     projectName
   });
   const pathToCreatedSrcDirectory = await makeDir(`${projectRoot}/src`);
-  const [rollupResults] = await Promise.all([scaffold$2({
+  const [rollupResults] = await Promise.all([scaffold$1({
     projectRoot,
     dialect,
     projectType: projectTypes.PACKAGE
@@ -1025,7 +1168,7 @@ async function scaffoldCliType ({
   projectRoot,
   dialect
 }) {
-  const rollupResults = await scaffold$2({
+  const rollupResults = await scaffold$1({
     projectRoot,
     dialect,
     projectType: projectTypes.CLI
@@ -1137,7 +1280,8 @@ async function scaffoldTesting ({
   vcs,
   unitTestFrameworks,
   decisions,
-  dialect
+  dialect,
+  pathWithinParent
 }) {
   const unitResults = unit ? await scaffoldUnitTesting({
     projectRoot,
@@ -1145,7 +1289,8 @@ async function scaffoldTesting ({
     vcs,
     frameworks: unitTestFrameworks,
     decisions,
-    dialect
+    dialect,
+    pathWithinParent
   }) : {};
   return deepmerge({
     devDependencies: [...(unit || integration ? ['@travi/any'] : [])],
@@ -1169,7 +1314,7 @@ async function scaffoldEslint ({
   const ignores = deepmerge(ignore, {
     directories: [`/${buildDirectory}/`]
   });
-  return scaffold$3({
+  return scaffold$2({
     scope,
     projectRoot,
     ignore: {
@@ -1294,7 +1439,8 @@ async function scaffoldVerification({
   unitTestFrameworks,
   decisions,
   buildDirectory,
-  eslintConfigs
+  eslintConfigs,
+  pathWithinParent
 }) {
   const [testingResults, huskyResults] = await Promise.all([scaffoldTesting({
     projectRoot,
@@ -1303,8 +1449,9 @@ async function scaffoldVerification({
     vcs,
     unitTestFrameworks,
     decisions,
-    dialect
-  }), scaffold$4({
+    dialect,
+    pathWithinParent
+  }), scaffold$3({
     projectRoot,
     packageManager
   })]);
@@ -1327,7 +1474,7 @@ async function scaffoldVerification({
   return deepmerge.all([testingResults, lintingResults, huskyResults]);
 }
 
-async function scaffold(options) {
+async function scaffolder (options) {
   info('Initializing JavaScript project');
   const {
     projectRoot,
@@ -1393,6 +1540,7 @@ async function scaffold(options) {
     tests,
     unitTestFrameworks,
     decisions,
+    pathWithinParent,
     buildDirectory: projectTypeResults.buildDirectory,
     eslintConfigs: projectTypeResults.eslintConfigs
   });
@@ -1425,7 +1573,7 @@ async function scaffold(options) {
     projectName,
     nodeVersion,
     tests
-  }), scaffold$5({
+  }), scaffold$4({
     projectRoot,
     projectType,
     configs,
@@ -1470,7 +1618,19 @@ async function scaffold(options) {
   };
 }
 
+async function test ({
+  projectRoot
+}) {
+  try {
+    const stats = await promises.stat(`${projectRoot}/.nvmrc`);
+    return stats.isFile();
+  } catch (e) {
+    if ('ENOENT' === e.code) return false;
+    throw e;
+  }
+}
+
 const questionNames = _objectSpread2(_objectSpread2({}, questionNames$2), questionNames$1);
 
-export { questionNames, scaffold, scaffoldUnitTesting };
+export { lift, questionNames, scaffolder as scaffold, scaffoldUnitTesting, test };
 //# sourceMappingURL=index.es.js.map