@mschauer5/spfx-toolkit 1.0.27 → 1.0.28

package/src/commands/installer.command.ts

@@ -1,134 +1,134 @@
-import { detect } from 'detect-package-manager';
-import { getScriptByName } from './scripts.command';
-import { logger } from '../common/logger';
-import { util } from '../common';
-import { promises as fsPromises } from 'fs';
-// /**
-//  * Adds a command to the user's shell profile to run spfx-toolkit nvmrc use on terminal startup.
-//  * Supports bash, zsh (macOS/Linux) and PowerShell (Windows).
-//  */
-// export const addNvmrcToStartup = () => {
-//   const homedir = os.homedir();
-//   const isWin = process.platform === 'win32';
-//   let profilePath = '';
-//   let shellType = '';
-//   let lineToAdd = '';
-
-//   if (isWin) {
-//     // PowerShell profile
-//     const profileEnv = process.env.USERPROFILE || homedir;
-//     // Default PowerShell profile path
-//     profilePath = path.join(profileEnv, 'Documents', 'WindowsPowerShell', 'Microsoft.PowerShell_profile.ps1');
-//     shellType = 'PowerShell';
-//     lineToAdd = 'spfx-toolkit nvmrc use';
-//   } else {
-//     // Check for zsh or bash
-//     if (process.env.SHELL && process.env.SHELL.includes('zsh')) {
-//       profilePath = path.join(homedir, '.zshrc');
-//       shellType = 'zsh';
-//     } else {
-//       profilePath = path.join(homedir, '.bashrc');
-//       shellType = 'bash';
-//     }
-//     lineToAdd = 'spfx-toolkit nvmrc use';
-//   }
-
-//   // Check if profile exists, create if not
-//   if (!fs.existsSync(profilePath)) {
-//     fs.writeFileSync(profilePath, '', { encoding: 'utf-8' });
-//   }
-
-//   // Check if line already exists
-//   const profileContent = fs.readFileSync(profilePath, 'utf-8');
-//   if (!profileContent.includes(lineToAdd)) {
-//     fs.appendFileSync(profilePath, `\n# Added by spfx-toolkit\n${lineToAdd}\n`, { encoding: 'utf-8' });
-//     console.log(`Added '${lineToAdd}' to your ${shellType} profile: ${profilePath}`);
-//   } else {
-//     console.log(`'${lineToAdd}' is already present in your ${shellType} profile: ${profilePath}`);
-//   }
-// };
-
-const packageInstaller = async (name: string): Promise<{ dependencies: string[]; devDependencies: string[] }> => {
-  const globalPath = util.getGlobalConfigPaths();
-  const fileExists = await util.checkIfFileExistsAsync(globalPath.configPath, true);
-  if (!fileExists) {
-    return { dependencies: [], devDependencies: [] };
-  }
-
-  const data = await fsPromises.readFile(globalPath.configPath, 'utf-8');
-  const config = JSON.parse(data);
-  if (config && typeof config === 'object' && config.packages) {
-    const result = name in config.packages;
-    if (result) {
-      const packageValue = config.packages[name];
-      const dependencies = packageValue.dependencies ?? [];
-      const devDependencies = packageValue.devDependencies ?? [];
-
-      return { dependencies, devDependencies };
-    }
-
-    return { dependencies: [], devDependencies: [] };
-  }
-};
-
-export const install = async (name: string, fromScripts: boolean) => {
-  const usercommand = await detect();
-  const spawn = require('cross-spawn');
-
-  if (fromScripts) {
-    packageInstaller(name).then((results) => {
-      if (results.dependencies.length === 0 && results.devDependencies.length === 0) {
-        logger.error(`No package found with name ${name} in global package.json so can't install`);
-        return;
-      }
-      if (results.dependencies.length > 0) {
-        results.dependencies.unshift('install');
-        spawn.sync(usercommand, results.dependencies, { stdio: 'inherit' });
-      }
-      if (results.devDependencies.length > 0) {
-        results.devDependencies.unshift('--save-dev');
-        results.devDependencies.unshift('install');
-        spawn.sync(usercommand, results.devDependencies, { stdio: 'inherit' });
-      }
-    });
-
-    return;
-  }
-
-  if (name === undefined || name.length === 0) {
-    spawn.sync(usercommand, ['install'], { stdio: 'inherit' });
-    return;
-  }
-
-  const args = name.split(' ');
-  args.unshift('install');
-
-  spawn.sync(usercommand, args, { stdio: 'inherit' });
-  return;
-};
-
-export const uninstall = async (name: string, fromScripts: boolean) => {
-  const usercommand = await detect();
-  const spawn = require('cross-spawn');
-
-  if (!fromScripts) {
-    const getScriptByNameValue = await getScriptByName(`install:${name}`);
-    if (getScriptByNameValue !== undefined) {
-      const args = getScriptByNameValue.split(' ');
-
-      args.unshift('uninstall');
-
-      spawn.sync(usercommand, args, { stdio: 'inherit' });
-      return;
-    } else {
-      logger.error(`No install script found with name ${name} in global or local package.json so can't uninstall`);
-    }
-    return;
-  }
-
-  const args = name.split(' ');
-  args.unshift('uninstall');
-
-  spawn.sync(usercommand, args, { stdio: 'inherit' });
-  return;
-};
+import { detect } from 'detect-package-manager';
+import { getScriptByName } from './scripts.command';
+import { logger } from '../common/logger';
+import { util } from '../common';
+import { promises as fsPromises } from 'fs';
+// /**
+//  * Adds a command to the user's shell profile to run spfx-toolkit nvmrc use on terminal startup.
+//  * Supports bash, zsh (macOS/Linux) and PowerShell (Windows).
+//  */
+// export const addNvmrcToStartup = () => {
+//   const homedir = os.homedir();
+//   const isWin = process.platform === 'win32';
+//   let profilePath = '';
+//   let shellType = '';
+//   let lineToAdd = '';
+
+//   if (isWin) {
+//     // PowerShell profile
+//     const profileEnv = process.env.USERPROFILE || homedir;
+//     // Default PowerShell profile path
+//     profilePath = path.join(profileEnv, 'Documents', 'WindowsPowerShell', 'Microsoft.PowerShell_profile.ps1');
+//     shellType = 'PowerShell';
+//     lineToAdd = 'spfx-toolkit nvmrc use';
+//   } else {
+//     // Check for zsh or bash
+//     if (process.env.SHELL && process.env.SHELL.includes('zsh')) {
+//       profilePath = path.join(homedir, '.zshrc');
+//       shellType = 'zsh';
+//     } else {
+//       profilePath = path.join(homedir, '.bashrc');
+//       shellType = 'bash';
+//     }
+//     lineToAdd = 'spfx-toolkit nvmrc use';
+//   }
+
+//   // Check if profile exists, create if not
+//   if (!fs.existsSync(profilePath)) {
+//     fs.writeFileSync(profilePath, '', { encoding: 'utf-8' });
+//   }
+
+//   // Check if line already exists
+//   const profileContent = fs.readFileSync(profilePath, 'utf-8');
+//   if (!profileContent.includes(lineToAdd)) {
+//     fs.appendFileSync(profilePath, `\n# Added by spfx-toolkit\n${lineToAdd}\n`, { encoding: 'utf-8' });
+//     console.log(`Added '${lineToAdd}' to your ${shellType} profile: ${profilePath}`);
+//   } else {
+//     console.log(`'${lineToAdd}' is already present in your ${shellType} profile: ${profilePath}`);
+//   }
+// };
+
+const packageInstaller = async (name: string): Promise<{ dependencies: string[]; devDependencies: string[] }> => {
+  const globalPath = util.getGlobalConfigPaths();
+  const fileExists = await util.checkIfFileExistsAsync(globalPath.configPath, true);
+  if (!fileExists) {
+    return { dependencies: [], devDependencies: [] };
+  }
+
+  const data = await fsPromises.readFile(globalPath.configPath, 'utf-8');
+  const config = JSON.parse(data);
+  if (config && typeof config === 'object' && config.packages) {
+    const result = name in config.packages;
+    if (result) {
+      const packageValue = config.packages[name];
+      const dependencies = packageValue.dependencies ?? [];
+      const devDependencies = packageValue.devDependencies ?? [];
+
+      return { dependencies, devDependencies };
+    }
+
+    return { dependencies: [], devDependencies: [] };
+  }
+};
+
+export const install = async (name: string, fromScripts: boolean) => {
+  const usercommand = await detect();
+  const spawn = require('cross-spawn');
+
+  if (fromScripts) {
+    packageInstaller(name).then((results) => {
+      if (results.dependencies.length === 0 && results.devDependencies.length === 0) {
+        logger.error(`No package found with name ${name} in global package.json so can't install`);
+        return;
+      }
+      if (results.dependencies.length > 0) {
+        results.dependencies.unshift('install');
+        spawn.sync(usercommand, results.dependencies, { stdio: 'inherit' });
+      }
+      if (results.devDependencies.length > 0) {
+        results.devDependencies.unshift('--save-dev');
+        results.devDependencies.unshift('install');
+        spawn.sync(usercommand, results.devDependencies, { stdio: 'inherit' });
+      }
+    });
+
+    return;
+  }
+
+  if (name === undefined || name.length === 0) {
+    spawn.sync(usercommand, ['install'], { stdio: 'inherit' });
+    return;
+  }
+
+  const args = name.split(' ');
+  args.unshift('install');
+
+  spawn.sync(usercommand, args, { stdio: 'inherit' });
+  return;
+};
+
+export const uninstall = async (name: string, fromScripts: boolean) => {
+  const usercommand = await detect();
+  const spawn = require('cross-spawn');
+
+  if (!fromScripts) {
+    const getScriptByNameValue = await getScriptByName(`install:${name}`);
+    if (getScriptByNameValue !== undefined) {
+      const args = getScriptByNameValue.split(' ');
+
+      args.unshift('uninstall');
+
+      spawn.sync(usercommand, args, { stdio: 'inherit' });
+      return;
+    } else {
+      logger.error(`No install script found with name ${name} in global or local package.json so can't uninstall`);
+    }
+    return;
+  }
+
+  const args = name.split(' ');
+  args.unshift('uninstall');
+
+  spawn.sync(usercommand, args, { stdio: 'inherit' });
+  return;
+};

package/src/commands/nvmrc.command.ts

@@ -1,76 +1,76 @@
-export const addNvmrc = async () => {
-  const spawn = require('cross-spawn');
-  const result = spawn.sync('nvm', ['current'], { encoding: 'utf-8' });
-
-  if (result.status !== 0) {
-    console.error('Error detecting current Node version with nvm. Make sure nvm is installed and accessible from your PATH.');
-    return;
-  }
-
-  const currentVersion = result.stdout.trim();
-  const nvmrcContent = currentVersion;
-
-  const fs = require('fs');
-  fs.writeFileSync('.nvmrc', nvmrcContent, { encoding: 'utf-8' });
-  console.log(`.nvmrc file created with Node version: ${currentVersion}`);
-};
-
-export const useNvmrc = () => {
-  const fs = require('fs');
-  const spawn = require('cross-spawn');
-  const readlineSync = require('readline-sync');
-  let requiredVersion = '';
-  let source = '';
-
-  // Check .nvmrc first
-  const nvmrcPath = '.nvmrc';
-  if (fs.existsSync(nvmrcPath)) {
-    requiredVersion = fs.readFileSync(nvmrcPath, 'utf-8').trim();
-    source = '.nvmrc';
-  } else if (fs.existsSync('package.json')) {
-    // Fallback to package.json engines.node
-    try {
-      const pkg = JSON.parse(fs.readFileSync('package.json', 'utf-8'));
-      if (pkg.engines && pkg.engines.node) {
-        requiredVersion = pkg.engines.node.trim();
-        source = 'package.json';
-      }
-    } catch (e) {
-      console.error('Could not parse package.json:', e);
-    }
-  }
-
-  if (!requiredVersion) {
-    console.log('No .nvmrc or engines.node in package.json found.');
-    return;
-  }
-
-  const result = spawn.sync('nvm', ['current'], { encoding: 'utf-8' });
-  if (result.status !== 0) {
-    console.error('Error detecting current Node version with nvm. Make sure nvm is installed and accessible from your PATH.');
-    return;
-  }
-  const currentVersion = result.stdout.trim();
-
-  // Normalize for semver range (e.g., ">=14.0.0")
-  const semver = require('semver');
-  let needsSwitch = false;
-  if (source === 'package.json') {
-    needsSwitch = !semver.satisfies(currentVersion, requiredVersion);
-  } else {
-    needsSwitch = currentVersion !== requiredVersion;
-  }
-
-  if (needsSwitch) {
-    const response = readlineSync.question(`Current Node version is ${currentVersion}. Switch to ${requiredVersion} as per ${source}? (y/n) [y]: `);
-    if (response === 'y' || response === '') {
-      console.log(`Switching Node version to ${requiredVersion} as per ${source}`);
-      const switchResult = spawn.sync('nvm', ['use', requiredVersion], { stdio: 'inherit' });
-      if (switchResult.status !== 0) {
-        console.error(`Failed to switch Node version to ${requiredVersion}.`);
-      }
-    }
-  } else {
-    console.log(`Node version ${currentVersion} matches required version from ${source}.`);
-  }
-};
+export const addNvmrc = async () => {
+  const spawn = require('cross-spawn');
+  const result = spawn.sync('nvm', ['current'], { encoding: 'utf-8' });
+
+  if (result.status !== 0) {
+    console.error('Error detecting current Node version with nvm. Make sure nvm is installed and accessible from your PATH.');
+    return;
+  }
+
+  const currentVersion = result.stdout.trim();
+  const nvmrcContent = currentVersion;
+
+  const fs = require('fs');
+  fs.writeFileSync('.nvmrc', nvmrcContent, { encoding: 'utf-8' });
+  console.log(`.nvmrc file created with Node version: ${currentVersion}`);
+};
+
+export const useNvmrc = () => {
+  const fs = require('fs');
+  const spawn = require('cross-spawn');
+  const readlineSync = require('readline-sync');
+  let requiredVersion = '';
+  let source = '';
+
+  // Check .nvmrc first
+  const nvmrcPath = '.nvmrc';
+  if (fs.existsSync(nvmrcPath)) {
+    requiredVersion = fs.readFileSync(nvmrcPath, 'utf-8').trim();
+    source = '.nvmrc';
+  } else if (fs.existsSync('package.json')) {
+    // Fallback to package.json engines.node
+    try {
+      const pkg = JSON.parse(fs.readFileSync('package.json', 'utf-8'));
+      if (pkg.engines && pkg.engines.node) {
+        requiredVersion = pkg.engines.node.trim();
+        source = 'package.json';
+      }
+    } catch (e) {
+      console.error('Could not parse package.json:', e);
+    }
+  }
+
+  if (!requiredVersion) {
+    console.log('No .nvmrc or engines.node in package.json found.');
+    return;
+  }
+
+  const result = spawn.sync('nvm', ['current'], { encoding: 'utf-8' });
+  if (result.status !== 0) {
+    console.error('Error detecting current Node version with nvm. Make sure nvm is installed and accessible from your PATH.');
+    return;
+  }
+  const currentVersion = result.stdout.trim();
+
+  // Normalize for semver range (e.g., ">=14.0.0")
+  const semver = require('semver');
+  let needsSwitch = false;
+  if (source === 'package.json') {
+    needsSwitch = !semver.satisfies(currentVersion, requiredVersion);
+  } else {
+    needsSwitch = currentVersion !== requiredVersion;
+  }
+
+  if (needsSwitch) {
+    const response = readlineSync.question(`Current Node version is ${currentVersion}. Switch to ${requiredVersion} as per ${source}? (y/n) [y]: `);
+    if (response === 'y' || response === '') {
+      console.log(`Switching Node version to ${requiredVersion} as per ${source}`);
+      const switchResult = spawn.sync('nvm', ['use', requiredVersion], { stdio: 'inherit' });
+      if (switchResult.status !== 0) {
+        console.error(`Failed to switch Node version to ${requiredVersion}.`);
+      }
+    }
+  } else {
+    console.log(`Node version ${currentVersion} matches required version from ${source}.`);
+  }
+};

package/src/commands/projects.command.ts

@@ -1,37 +1,37 @@
-import { logger } from '../common/logger';
-import { promises as fsPromises } from 'fs';
-import { ensureGlobalPackageJsonExists, getGlobalConfigPaths } from '../common/util';
-import { openVSCodeInDirectory } from '../common/util';
-
-export const addProject = async (name: string) => {
-  const path = process.cwd();
-  if (!name) {
-    name = path.split('\\').pop();
-  }
-  await ensureGlobalPackageJsonExists();
-
-  const { configPath } = getGlobalConfigPaths();
-  const packageJsonContent = await fsPromises.readFile(configPath, 'utf-8');
-  const packageJson = JSON.parse(packageJsonContent);
-  if (!packageJson.projects) {
-    packageJson.projects = {};
-  }
-
-  packageJson.projects[name] = path;
-
-  await fsPromises.writeFile(configPath, JSON.stringify(packageJson, null, 2), 'utf-8');
-
-  logger.success(`Project '${name}' added for path: ${path}`);
-};
-
-export const openProject = async (name: string) => {
-  const { configPath } = getGlobalConfigPaths();
-  const packageJsonContent = await fsPromises.readFile(configPath, 'utf-8');
-  const packageJson = JSON.parse(packageJsonContent);
-  if (!packageJson.projects || !packageJson.projects[name]) {
-    logger.error(`Project name '${name}' not found in global package.json!`);
-    return;
-  }
-  const projectPath = packageJson.projects[name];
-  openVSCodeInDirectory(projectPath);
-};
+import { logger } from '../common/logger';
+import { promises as fsPromises } from 'fs';
+import { ensureGlobalPackageJsonExists, getGlobalConfigPaths } from '../common/util';
+import { openVSCodeInDirectory } from '../common/util';
+
+export const addProject = async (name: string) => {
+  const path = process.cwd();
+  if (!name) {
+    name = path.split('\\').pop();
+  }
+  await ensureGlobalPackageJsonExists();
+
+  const { configPath } = getGlobalConfigPaths();
+  const packageJsonContent = await fsPromises.readFile(configPath, 'utf-8');
+  const packageJson = JSON.parse(packageJsonContent);
+  if (!packageJson.projects) {
+    packageJson.projects = {};
+  }
+
+  packageJson.projects[name] = path;
+
+  await fsPromises.writeFile(configPath, JSON.stringify(packageJson, null, 2), 'utf-8');
+
+  logger.success(`Project '${name}' added for path: ${path}`);
+};
+
+export const openProject = async (name: string) => {
+  const { configPath } = getGlobalConfigPaths();
+  const packageJsonContent = await fsPromises.readFile(configPath, 'utf-8');
+  const packageJson = JSON.parse(packageJsonContent);
+  if (!packageJson.projects || !packageJson.projects[name]) {
+    logger.error(`Project name '${name}' not found in global package.json!`);
+    return;
+  }
+  const projectPath = packageJson.projects[name];
+  openVSCodeInDirectory(projectPath);
+};