@form8ion/javascript 15.8.3 → 16.0.0-beta.2

package/README.md

@@ -65,7 +65,7 @@ const projectRoot = process.cwd();
 await scaffoldJavaScript({
   projectRoot,
   projectName: 'project-name',
-  visibility: 'Public',
+  visibility: 'OSS',
   license: 'MIT',
   configs: {
     eslint: {scope: `@${accountName}`},
@@ -121,7 +121,7 @@ await scaffoldUnitTesting({
     Mocha: {scaffold: options => options},
     Jest: {scaffold: options => options}
   },
-  visibility: 'Public',
+  visibility: 'OSS',
   vcs: {host: 'GitHub', owner: 'foo', name: 'bar'},
   decisions: {[questionNames.UNIT_TEST_FRAMEWORK]: 'Mocha'}
 });
@@ -175,7 +175,7 @@ $ npm test
 
 [renovate-link]: https://renovatebot.com
 
-[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovatebot
+[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovate
 
 [github-actions-ci-link]: https://github.com/form8ion/javascript/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster
 
@@ -197,6 +197,6 @@ $ npm test
 
 [coverage-link]: https://codecov.io/github/form8ion/javascript
 
-[coverage-badge]: https://img.shields.io/codecov/c/github/form8ion/javascript?logo=codecov
+[coverage-badge]: https://img.shields.io/codecov/c/github/form8ion/javascript/master?logo=codecov
 
 [slsa-badge]: https://slsa.dev/images/gh-badge-level2.svg

package/example.js

@@ -34,7 +34,7 @@ const projectRoot = process.cwd();
 await scaffoldJavaScript({
   projectRoot,
   projectName: 'project-name',
-  visibility: 'Public',
+  visibility: 'OSS',
   license: 'MIT',
   configs: {
     eslint: {scope: `@${accountName}`},
@@ -90,7 +90,7 @@ await scaffoldUnitTesting({
     Mocha: {scaffold: options => options},
     Jest: {scaffold: options => options}
   },
-  visibility: 'Public',
+  visibility: 'OSS',
   vcs: {host: 'GitHub', owner: 'foo', name: 'bar'},
   decisions: {[questionNames.UNIT_TEST_FRAMEWORK]: 'Mocha'}
 });

package/lib/index.js

@@ -1,11 +1,10 @@
 import { questionNames as questionNames$2, questions } from '@travi/language-scaffolder-prompts';
 import deepmerge from 'deepmerge';
-import { warn, info, error } from '@travi/cli-messages';
 import { scaffoldChoice, dialects as dialects$1, projectTypes as projectTypes$1, packageManagers as packageManagers$1, writePackageJson, PROD_DEPENDENCY_TYPE, DEV_DEPENDENCY_TYPE, mergeIntoExistingPackageJson } from '@form8ion/javascript-core';
 import * as commitConventionPlugin from '@form8ion/commit-convention';
 import { scaffold as scaffold$5 } from '@form8ion/commit-convention';
 import joi from 'joi';
-import { fileExists, directoryExists, optionsSchemas, validateOptions, fileTypes, loadConfigFile, writeConfigFile, applyEnhancers } from '@form8ion/core';
+import { fileExists, directoryExists, optionsSchemas, validateOptions, visibilityOptions, fileTypes, loadConfigFile, writeConfigFile, applyEnhancers } from '@form8ion/core';
 import { prompt as prompt$1 } from '@form8ion/overridable-prompts';
 import { execa } from 'execa';
 import npmConf from 'npm-conf';
@@ -145,7 +144,7 @@ const nameBasedConfigSchema = joi.object({
 
 const registriesSchema = joi.object().pattern(joi.string(), joi.string().uri()).default({});
 
-const visibilitySchema = joi.string().valid('Public', 'Private').required();
+const visibilitySchema = joi.string().valid(...Object.keys(visibilityOptions)).required();
 
 const projectNameSchema = joi.string().regex(/^@\w*\//, {invert: true}).required();
 
@@ -182,7 +181,8 @@ function validate(options) {
       packageTypes: pluginsSchema,
       monorepoTypes: pluginsSchema,
       hosts: pluginsSchema,
-      ciServices: pluginsSchema
+      ciServices: pluginsSchema,
+      registries: pluginsSchema
     }
   }).required();
 
@@ -211,7 +211,7 @@ function projectIsApplication$1(answers) {
 }
 
 function packageShouldBeScoped(visibility, answers) {
-  return 'Private' === visibility || answers[questionNames$1.SHOULD_BE_SCOPED];
+  return ['ISS', 'CS'].includes(visibility) || answers[questionNames$1.SHOULD_BE_SCOPED];
 }
 
 function willBePublishedToNpm(answers) {
@@ -235,8 +235,13 @@ function lintingPromptShouldBePresented({
 
 function scope(visibility) {
   return input => {
-    if (!input && 'Private' === visibility) {
-      return 'Private packages must be scoped (https://docs.npmjs.com/private-modules/intro#setting-up-your-package)';
+    if (!input) {
+      if ('CS' === visibility) {
+        return 'Closed source packages must be scoped';
+      }
+      if ('ISS' === visibility) {
+        return 'Inner source packages must be scoped';
+      }
     }
 
     return true;
@@ -270,7 +275,8 @@ async function prompt(
   vcs,
   decisions,
   configs,
-  pathWithinParent
+  pathWithinParent,
+  {logger}
 ) {
   const npmConf$1 = npmConf();
 
@@ -279,7 +285,7 @@ async function prompt(
     maybeLoggedInNpmUsername = (await execa('npm', ['whoami'])).stdout;
   } catch (failedExecutionResult) {
     if (!decisions[questionNames$1.SCOPE]) {
-      warn('No logged in user found with `npm whoami`. Login with `npm login` '
+      logger.warn('No logged in user found with `npm whoami`. Login with `npm login` '
         + 'to use your npm account name as the package scope default.');
     }
   }
@@ -328,7 +334,7 @@ async function prompt(
       choices: [...Object.values(projectTypes$1), 'Other'],
       default: projectTypes$1.PACKAGE
     },
-    ...'Private' === visibility ? [] : [{
+    ...['ISS', 'CS'].includes(visibility) ? [] : [{
       name: questionNames$1.SHOULD_BE_SCOPED,
       message: 'Should this package be scoped?',
       type: 'confirm',
@@ -657,8 +663,8 @@ $ ${packageManager} test
   };
 }
 
-async function determineLatestVersionOf(nodeVersionCategory) {
-  info('Determining version of node', {level: 'secondary'});
+async function determineLatestVersionOf(nodeVersionCategory, {logger}) {
+  logger.info('Determining version of node', {level: 'secondary'});
 
   const {stdout: nvmLsOutput} = await execa(
     `. ~/.nvm/nvm.sh && nvm ls-remote${('LTS' === nodeVersionCategory) ? ' --lts' : ''}`,
@@ -671,25 +677,25 @@ async function determineLatestVersionOf(nodeVersionCategory) {
   return lsLine.match(/(v[0-9]+)\.[0-9]+\.[0-9]+/)[1];
 }
 
-function install(nodeVersionCategory) {
-  info(`Installing ${nodeVersionCategory} version of node using nvm`, {level: 'secondary'});
+function install(nodeVersionCategory, {logger}) {
+  logger.info(`Installing ${nodeVersionCategory} version of node using nvm`, {level: 'secondary'});
 
   const subprocess = execa('. ~/.nvm/nvm.sh && nvm install', {shell: true});
   subprocess.stdout.pipe(process.stdout);
   return subprocess;
 }
 
-async function scaffoldNodeVersion({projectRoot, nodeVersionCategory}) {
+async function scaffoldNodeVersion({projectRoot, nodeVersionCategory}, {logger}) {
   if (!nodeVersionCategory) return undefined;
 
   const lowerCaseCategory = nodeVersionCategory.toLowerCase();
-  info(`Configuring ${lowerCaseCategory} version of node`);
+  logger.info(`Configuring ${lowerCaseCategory} version of node`);
 
-  const version = await determineLatestVersionOf(nodeVersionCategory);
+  const version = await determineLatestVersionOf(nodeVersionCategory, {logger});
 
   await promises.writeFile(`${projectRoot}/.nvmrc`, version);
 
-  await install(nodeVersionCategory);
+  await install(nodeVersionCategory, {logger});
 
   return version;
 }
@@ -741,8 +747,8 @@ async function scaffoldPackage({
   license,
   author,
   description
-}) {
-  info('Configuring package.json');
+}, {logger}) {
+  logger.info('Configuring package.json');
 
   const packageName = determinePackageName(projectName, scope);
 
@@ -845,10 +851,11 @@ async function installDependencies(
   dependencies,
   dependenciesType,
   projectRoot,
-  packageManager = packageManagers$1.NPM
+  packageManager,
+  {logger}
 ) {
   if (dependencies.length) {
-    info(`Installing ${dependenciesType} dependencies`, {level: 'secondary'});
+    logger.info(`Installing ${dependenciesType} dependencies`, {level: 'secondary'});
 
     await execa(
       `. ~/.nvm/nvm.sh && nvm use && ${packageManager} ${
@@ -858,19 +865,22 @@ async function installDependencies(
       }`,
       {shell: true, cwd: projectRoot}
     );
-  } else warn(`No ${dependenciesType} dependencies to install`);
+  } else logger.warn(`No ${dependenciesType} dependencies to install`);
 }
 
-async function removeDependencies({packageManager, dependencies}) {
+async function removeDependencies({packageManager, dependencies}, {logger}) {
   if (dependencies.length) {
-    info('Removing dependencies dependencies', {level: 'secondary'});
+    logger.info('Removing dependencies dependencies', {level: 'secondary'});
 
     await execa(packageManager, ['remove', ...dependencies]);
   }
 }
 
-async function processDependencies({dependencies = {}, devDependencies, projectRoot, packageManager}) {
-  info('Processing dependencies');
+async function processDependencies(
+  {dependencies = {}, devDependencies, projectRoot, packageManager},
+  {logger}
+) {
+  logger.info('Processing dependencies');
 
   if (Array.isArray(devDependencies)) {
     throw new Error(
@@ -885,12 +895,12 @@ async function processDependencies({dependencies = {}, devDependencies, projectR
   const {javascript: {production = [], development = [], remove: dependenciesToRemove = []} = {}} = dependencies;
 
   try {
-    await installDependencies(production, PROD_DEPENDENCY_TYPE, projectRoot, packageManager);
-    await installDependencies(development, DEV_DEPENDENCY_TYPE, projectRoot, packageManager);
-    await removeDependencies({packageManager, dependencies: dependenciesToRemove});
+    await installDependencies(production, PROD_DEPENDENCY_TYPE, projectRoot, packageManager, {logger});
+    await installDependencies(development, DEV_DEPENDENCY_TYPE, projectRoot, packageManager, {logger});
+    await removeDependencies({packageManager, dependencies: dependenciesToRemove}, {logger});
   } catch (e) {
-    error('Failed to update dependencies');
-    error(e, {level: 'secondary'});
+    logger.error('Failed to update dependencies');
+    logger.error(e, {level: 'secondary'});
   }
 }
 
@@ -982,8 +992,8 @@ async function liftPackageJson({
   packageManager,
   vcs,
   pathWithinParent
-}) {
-  info('Updating `package.json`', {level: 'secondary'});
+}, {logger}) {
+  logger.info('Updating `package.json`', {level: 'secondary'});
 
   const existingPackageJsonContents = JSON.parse(await promises.readFile(`${projectRoot}/package.json`, 'utf-8'));
   const {scripts: liftedScripts, dependencies: scriptDependencies} = liftScripts({
@@ -1008,11 +1018,11 @@ async function liftPackageJson({
     devDependencies,
     projectRoot,
     packageManager
-  });
+  }, {logger});
 }
 
 function mapProjectVisibility({projectVisibility}) {
-  return 'Public' === projectVisibility ? 'public' : 'restricted';
+  return 'OSS' === projectVisibility ? 'public' : 'restricted';
 }
 
 function isScope(firstPart) {
@@ -1220,8 +1230,8 @@ async function scaffoldPackageProjectType({
   dialect,
   provideExample,
   publishRegistry
-}) {
-  info('Scaffolding Package Details');
+}, {logger}) {
+  logger.info('Scaffolding Package Details');
 
   const packageAccessLevel = mapProjectVisibility({projectVisibility: visibility});
   const [detailsForBuild, publishableResults] = await Promise.all([
@@ -1289,15 +1299,15 @@ function liftPackage({projectRoot, packageDetails, configs}) {
 }
 
 async function projectIsPackage({
-  packageDetails: {exports: exports$1, publishConfig, bin, private: projectMarkedPrivate}
+  packageDetails: {exports, publishConfig, bin, private: projectMarkedPrivate}
 }) {
-  return !projectMarkedPrivate && (!!exports$1 || (!!publishConfig && !bin));
+  return !projectMarkedPrivate && (!!exports || (!!publishConfig && !bin));
 }
 
 const defaultBuildDirectory$1 = 'public';
 
-async function scaffoldApplication({projectRoot}) {
-  info('Scaffolding Application Details');
+async function scaffoldApplication({projectRoot}, {logger}) {
+  logger.info('Scaffolding Application Details');
 
   await mergeIntoExistingPackageJson({projectRoot, config: {private: true}});
 
@@ -1320,8 +1330,8 @@ function projectIsApplication({packageDetails}) {
   return !!packageDetails.private;
 }
 
-async function scaffoldMonorepo({projectRoot}) {
-  info('Scaffolding Monorepo Details');
+async function scaffoldMonorepo({projectRoot}, {logger}) {
+  logger.info('Scaffolding Monorepo Details');
 
   await mergeIntoExistingPackageJson({projectRoot, config: {private: true}});
 
@@ -1400,7 +1410,7 @@ async function scaffoldProjectType({
   dialect,
   provideExample,
   publishRegistry
-}) {
+}, {logger}) {
   switch (projectType) {
     case projectTypes$1.PACKAGE:
       return scaffoldPackageProjectType({
@@ -1415,9 +1425,9 @@ async function scaffoldProjectType({
         dialect,
         provideExample,
         publishRegistry
-      });
+      }, {logger});
     case projectTypes$1.APPLICATION:
-      return scaffoldApplication({projectRoot});
+      return scaffoldApplication({projectRoot}, {logger});
     case projectTypes$1.CLI:
       return scaffoldCli({
         visibility,
@@ -1428,7 +1438,7 @@ async function scaffoldProjectType({
         packageBundlers
       });
     case projectTypes$1.MONOREPO:
-      return scaffoldMonorepo({projectRoot});
+      return scaffoldMonorepo({projectRoot}, {logger});
     case 'Other':
       return {};
     default:
@@ -1685,8 +1695,8 @@ async function scaffoldCodeStyle({
   ].filter(Boolean)));
 }
 
-function liftCodeStyle(options) {
-  return applyEnhancers({options, enhancers: [eslintPlugin]});
+function liftCodeStyle(options, dependencies) {
+  return applyEnhancers({options, enhancers: [eslintPlugin], dependencies});
 }
 
 function codeStyleConfigured(options) {
@@ -1700,8 +1710,8 @@ var codeStylePlugin = /*#__PURE__*/Object.freeze({
   test: codeStyleConfigured
 });
 
-async function scaffoldJavascript(options) {
-  info('Initializing JavaScript project');
+async function scaffoldJavascript(options, {logger}) {
+  logger.info('Initializing JavaScript project');
 
   const {
     projectRoot,
@@ -1737,9 +1747,9 @@ async function scaffoldJavascript(options) {
     provideExample,
     packageManager,
     dialect
-  } = await prompt(ciServices, hosts, visibility, vcs, decisions, configs, pathWithinParent);
+  } = await prompt(ciServices, hosts, visibility, vcs, decisions, configs, pathWithinParent, {logger});
 
-  info('Writing project files', {level: 'secondary'});
+  logger.info('Writing project files', {level: 'secondary'});
 
   const {packageName} = await scaffoldPackage({
     projectRoot,
@@ -1749,7 +1759,7 @@ async function scaffoldJavascript(options) {
     license,
     author,
     description
-  });
+  }, {logger});
   const projectTypeResults = await scaffoldProjectType({
     projectType,
     projectRoot,
@@ -1763,7 +1773,7 @@ async function scaffoldJavascript(options) {
     dialect,
     provideExample,
     publishRegistry: configs.registries.publish
-  });
+  }, {logger});
   const verificationResults = await scaffoldVerification({
     projectRoot,
     dialect,
@@ -1777,7 +1787,7 @@ async function scaffoldJavascript(options) {
     pathWithinParent
   });
   const [nodeVersion, npmResults, dialectResults, codeStyleResults] = await Promise.all([
-    scaffoldNodeVersion({projectRoot, nodeVersionCategory}),
+    scaffoldNodeVersion({projectRoot, nodeVersionCategory}, {logger}),
     scaffoldNpmConfiguration({projectType, projectRoot}),
     scaffoldDialect({
       dialect,
@@ -1913,8 +1923,8 @@ async function liftJavaScript({
   pathWithinParent,
   enhancers = {},
   configs = {}
-}) {
-  info('Lifting JavaScript-specific details');
+}, dependencies) {
+  dependencies.logger.info('Lifting JavaScript-specific details');
 
   const [packageManager, packageContents] = await Promise.all([
     resolveCurrentPackageManager({projectRoot, packageManager: results.packageManager}),
@@ -1936,15 +1946,19 @@ async function liftJavaScript({
       packageManagers,
       registriesPlugin
     },
-    options: {packageManager, projectRoot, vcs, packageDetails: JSON.parse(packageContents), configs}
+    options: {packageManager, projectRoot, vcs, packageDetails: JSON.parse(packageContents), configs},
+    dependencies
   });
 
-  await liftPackageJson(deepmerge.all([{projectRoot, packageManager, vcs, pathWithinParent}, enhancerResults]));
+  await liftPackageJson(
+    deepmerge.all([{projectRoot, packageManager, vcs, pathWithinParent}, enhancerResults]),
+    dependencies
+  );
 
   return enhancerResults;
 }
 
-async function projectUsesJavaScript({projectRoot}) {
+async function projectUsesJavaScript({projectRoot}, {logger}) {
   const [nvmFound, jsPackageManagerFound] = await Promise.all([
     nodeVersionMangerInUse({projectRoot}),
     packageManagerInUse({projectRoot})
@@ -1952,7 +1966,7 @@ async function projectUsesJavaScript({projectRoot}) {
 
   const jsProjectFound = nvmFound || jsPackageManagerFound;
 
-  if (jsProjectFound) info('JavaScript Project Detected');
+  if (jsProjectFound) logger.info('JavaScript Project Detected');
 
   return jsProjectFound;
 }