@form8ion/javascript 12.2.0 → 12.4.0

package/lib/index.mjs

@@ -1,7 +1,7 @@
 import { questionNames as questionNames$2, questions } from '@travi/language-scaffolder-prompts';
 import deepmerge from 'deepmerge';
 import { fileTypes, fileExists, validateOptions, applyEnhancers, writeConfigFile } from '@form8ion/core';
-import { scaffoldChoice, projectTypes as projectTypes$1, packageManagers, mergeIntoExistingPackageJson, dialects as dialects$1, writePackageJson, DEV_DEPENDENCY_TYPE, PROD_DEPENDENCY_TYPE } from '@form8ion/javascript-core';
+import { scaffoldChoice, projectTypes as projectTypes$1, packageManagers as packageManagers$1, mergeIntoExistingPackageJson, dialects as dialects$1, writePackageJson, DEV_DEPENDENCY_TYPE, PROD_DEPENDENCY_TYPE } 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';
@@ -22,11 +22,11 @@ import { resolve } from 'path';
 import filedirname from 'filedirname';
 import * as huskyPlugin from '@form8ion/husky';
 import { scaffold as scaffold$3 } from '@form8ion/husky';
+import { promises as promises$1 } from 'node:fs';
 import { stringify, parse } from 'ini';
 import { scaffold as scaffold$2 } from '@form8ion/prettier';
 import * as eslintPlugin from '@form8ion/eslint';
 import { scaffold as scaffold$1, test as test$1 } from '@form8ion/eslint';
-import { promises as promises$1 } from 'node:fs';
 import sortProperties from 'sort-object-keys';
 
 const questionNames$1 = {
@@ -214,7 +214,7 @@ async function scaffoldCodeStyle ({
   ].filter(Boolean)));
 }
 
-function lifter$3 (options) {
+function lifter$4 (options) {
   return applyEnhancers({options, enhancers: [eslintPlugin]});
 }
 
@@ -225,7 +225,7 @@ function tester$3 (options) {
 var codeStylePlugin = /*#__PURE__*/Object.freeze({
   __proto__: null,
   scaffold: scaffoldCodeStyle,
-  lift: lifter$3,
+  lift: lifter$4,
   test: tester$3
 });
 
@@ -260,7 +260,7 @@ function tester$2 ({projectRoot}) {
   return fileExists(`${projectRoot}/.npmrc`);
 }
 
-async function lifter$2 ({projectRoot}) {
+async function lifter$3 ({projectRoot}) {
   const pathToConfig = `${projectRoot}/.npmrc`;
 
   const {
@@ -278,7 +278,7 @@ var npmConfigPlugin = /*#__PURE__*/Object.freeze({
   __proto__: null,
   scaffold: scaffoldNpmConfig,
   test: tester$2,
-  lift: lifter$2
+  lift: lifter$3
 });
 
 async function test({projectRoot}) {
@@ -302,22 +302,22 @@ var enginesEnhancer = /*#__PURE__*/Object.freeze({
 });
 
 function buildDocumentationCommand (packageManager) {
-  if (packageManagers.NPM === packageManager) return 'npm run generate:md';
-  if (packageManagers.YARN === packageManager) return 'yarn generate:md';
+  if (packageManagers$1.NPM === packageManager) return 'npm run generate:md';
+  if (packageManagers$1.YARN === packageManager) return 'yarn generate:md';
 
   throw new Error(
     `The ${packageManager} package manager is currently not supported. `
-    + `Only ${Object.values(packageManagers).join(' and ')} are currently supported.`
+    + `Only ${Object.values(packageManagers$1).join(' and ')} are currently supported.`
   );
 }
 
 function getInstallationCommand(packageManager) {
-  if (packageManagers.NPM === packageManager) return 'npm install';
-  if (packageManagers.YARN === packageManager) return 'yarn add';
+  if (packageManagers$1.NPM === packageManager) return 'npm install';
+  if (packageManagers$1.YARN === packageManager) return 'yarn add';
 
   throw new Error(
     `The ${packageManager} package manager is currently not supported. `
-    + `Only ${Object.values(packageManagers).join(' and ')} are currently supported.`
+    + `Only ${Object.values(packageManagers$1).join(' and ')} are currently supported.`
   );
 }
 
@@ -751,7 +751,7 @@ function vcsRepositoryHostedOnGithub(vcs) {
   return vcs && 'github' === vcs.host;
 }
 
-async function lifter$1 ({projectRoot, packageDetails, vcs}) {
+async function lifter$2 ({projectRoot, packageDetails, vcs}) {
   if (await isPackage({projectRoot, packageDetails})) return liftPackage$1({projectRoot, packageDetails});
   if (await isCli({projectRoot, packageDetails})) return liftCli({projectRoot, packageDetails});
 
@@ -770,7 +770,7 @@ var projectTypes = /*#__PURE__*/Object.freeze({
   __proto__: null,
   scaffold: scaffoldProjectType,
   test: tester$1,
-  lift: lifter$1
+  lift: lifter$2
 });
 
 function write ({projectRoot, config}) {
@@ -798,7 +798,7 @@ async function scaffoldBabel ({projectRoot, preset}) {
   };
 }
 
-async function lifter ({results, projectRoot}) {
+async function lifter$1 ({results, projectRoot}) {
   await addIgnore({ignore: results.buildDirectory, projectRoot});
 
   return {};
@@ -852,7 +852,7 @@ var dialects = /*#__PURE__*/Object.freeze({
   __proto__: null,
   scaffold: scaffoldDialect,
   test: predicate,
-  lift: lifter
+  lift: lifter$1
 });
 
 function buildPackageDetails ({
@@ -945,7 +945,7 @@ function defineVcsHostDetails (vcs, pathWithinParent) {
 }
 
 const details = {
-  [packageManagers.NPM]: {
+  [packageManagers$1.NPM]: {
     installationCommand: 'install',
     installationFlags: {
       [DEV_DEPENDENCY_TYPE]: `save-${DEV_DEPENDENCY_TYPE}`,
@@ -953,7 +953,7 @@ const details = {
       exact: 'save-exact'
     }
   },
-  [packageManagers.YARN]: {
+  [packageManagers$1.YARN]: {
     installationCommand: 'add',
     installationFlags: {
       [DEV_DEPENDENCY_TYPE]: DEV_DEPENDENCY_TYPE,
@@ -975,7 +975,7 @@ function getExactFlag(manager) {
   return details[manager].installationFlags.exact;
 }
 
-async function install$1 (dependencies, dependenciesType, projectRoot, packageManager = packageManagers.NPM) {
+async function install$1 (dependencies, dependenciesType, projectRoot, packageManager = packageManagers$1.NPM) {
   if (dependencies.length) {
     info(`Installing ${dependenciesType} dependencies`, {level: 'secondary'});
 
@@ -1057,20 +1057,64 @@ async function liftPackage ({
   }
 }
 
+function determineLockfilePathFor (packageManager) {
+  const lockfilePaths = {
+    [packageManagers$1.NPM]: 'package-lock.json',
+    [packageManagers$1.YARN]: 'yarn.lock'
+  };
+
+  return lockfilePaths[packageManager];
+}
+
+function npmIsUsed ({projectRoot}) {
+  return fileExists(`${projectRoot}/${determineLockfilePathFor(packageManagers$1.NPM)}`);
+}
+
+function yarnIsUsed ({projectRoot}) {
+  return fileExists(`${projectRoot}/${determineLockfilePathFor(packageManagers$1.YARN)}`);
+}
+
+async function jsPackageManagerIsUsed ({projectRoot}) {
+  const [npmFound, yarnFound] = await Promise.all([
+    npmIsUsed({projectRoot}),
+    yarnIsUsed({projectRoot})
+  ]);
+
+  return npmFound || yarnFound;
+}
+
+async function liftCorepack () {
+  await execa('corepack', ['use', 'npm@latest']);
+}
+
+async function lifter () {
+  await liftCorepack();
+
+  return {};
+}
+
 async function resolvePackageManager ({projectRoot, packageManager}) {
   if (packageManager) return packageManager;
 
-  if (await fileExists(`${projectRoot}/package-lock.json`)) {
-    return packageManagers.NPM;
+  if (await npmIsUsed({projectRoot})) {
+    return packageManagers$1.NPM;
   }
 
-  if (await fileExists(`${projectRoot}/yarn.lock`)) {
-    return packageManagers.YARN;
+  if (await yarnIsUsed({projectRoot})) {
+    return packageManagers$1.YARN;
   }
 
   throw new Error('Package-manager could not be determined');
 }
 
+var packageManagers = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  test: jsPackageManagerIsUsed,
+  lift: lifter,
+  determineCurrent: resolvePackageManager,
+  defineLockfilePath: determineLockfilePathFor
+});
+
 async function lift ({projectRoot, vcs, results, pathWithinParent}) {
   info('Lifting JavaScript-specific details');
 
@@ -1097,7 +1141,8 @@ async function lift ({projectRoot, vcs, results, pathWithinParent}) {
       dialects,
       codeStylePlugin,
       npmConfigPlugin,
-      projectTypes
+      projectTypes,
+      packageManagers
     ],
     options: {packageManager, projectRoot, vcs, packageDetails: JSON.parse(packageContents)}
   });
@@ -1326,8 +1371,8 @@ async function prompt(
       name: questionNames$1.PACKAGE_MANAGER,
       message: 'Which package manager will be used with this project?',
       type: 'list',
-      choices: Object.values(packageManagers),
-      default: packageManagers.NPM
+      choices: Object.values(packageManagers$1),
+      default: packageManagers$1.NPM
     },
     {
       name: questionNames$1.PROJECT_TYPE,
@@ -1441,13 +1486,17 @@ async function scaffoldNodeVersion ({projectRoot, nodeVersionCategory}) {
 
   const version = await determineLatestVersionOf(nodeVersionCategory);
 
-  await promises.writeFile(`${projectRoot}/.nvmrc`, version);
+  await promises$1.writeFile(`${projectRoot}/.nvmrc`, version);
 
   await install(nodeVersionCategory);
 
   return version;
 }
 
+function nvmIsUsed ({projectRoot}) {
+  return fileExists(`${projectRoot}/.nvmrc`);
+}
+
 function buildBadgesDetails (contributors) {
   return deepmerge.all(contributors).badges;
 }
@@ -1540,16 +1589,7 @@ function buildAllowedHostsList ({packageManager, registries}) {
   ];
 }
 
-const lockfileLintSupportedPackageManagers = [packageManagers.NPM, packageManagers.YARN];
-
-function determineLockfilePathFor(packageManager) {
-  const lockfilePaths = {
-    [packageManagers.NPM]: 'package-lock.json',
-    [packageManagers.YARN]: 'yarn.lock'
-  };
-
-  return lockfilePaths[packageManager];
-}
+const lockfileLintSupportedPackageManagers = [packageManagers$1.NPM, packageManagers$1.YARN];
 
 function lockfileLintSupports(packageManager) {
   return lockfileLintSupportedPackageManagers.includes(packageManager);
@@ -1761,13 +1801,16 @@ async function scaffolder (options) {
 }
 
 async function tester ({projectRoot}) {
-  const [nvmIsConfigured, packageLockExists, yarnLockExists] = await Promise.all([
-    fileExists(`${projectRoot}/.nvmrc`),
-    fileExists(`${projectRoot}/package-lock.json`),
-    fileExists(`${projectRoot}/yarn.lock`)
+  const [nvmFound, jsPackageManagerFound] = await Promise.all([
+    nvmIsUsed({projectRoot}),
+    jsPackageManagerIsUsed({projectRoot})
   ]);
 
-  return nvmIsConfigured || packageLockExists || yarnLockExists;
+  const jsProjectFound = nvmFound || jsPackageManagerFound;
+
+  if (jsProjectFound) info('JavaScript Project Detected');
+
+  return jsProjectFound;
 }
 
 const questionNames = {...questionNames$2, ...questionNames$1};