feat: skip reinstalling already installed plugin (#7)

src/install-plugins.ts

@@ -0,0 +1,137 @@
+import { spawn } from 'node:child_process'
+import fs from 'node:fs'
+
+import { PLUGINS_PACKAGE_JSON_PATH, PLUGIN_STORE_PATH } from './paths.js'
+import { splitPluginNameAndVersion } from './utils.js'
+
+const npmExecutable = process.platform.startsWith('win') ? 'npm.cmd' : 'npm'
+
+function listStoreDependencies(): [string, string][] {
+  try {
+    const packageJson = JSON.parse(
+      fs.readFileSync(PLUGINS_PACKAGE_JSON_PATH, 'utf-8'),
+    ) as unknown
+
+    if (
+      typeof packageJson === 'object' &&
+      packageJson &&
+      'dependencies' in packageJson &&
+      typeof packageJson.dependencies === 'object' &&
+      packageJson.dependencies
+    ) {
+      return Object.entries(packageJson.dependencies)
+    }
+
+    return []
+  } catch {
+    return []
+  }
+}
+
+function filterPluginsToInstall(pluginNames: string[]) {
+  const storeDependencies = listStoreDependencies()
+  const pluginsToInstall: string[] = []
+  const installedPlugins: string[] = []
+
+  pluginNames.forEach(rawPluginName => {
+    let { name: pluginName, version: pluginVersion } =
+      splitPluginNameAndVersion(rawPluginName)
+    if (
+      pluginVersion &&
+      (pluginVersion.startsWith('^') || pluginVersion.startsWith('~'))
+    ) {
+      pluginVersion = pluginVersion.slice(1)
+    }
+
+    const isPluginInstalled = storeDependencies.some(
+      ([dependencyName, dependencyVersion]) => {
+        if (dependencyName !== pluginName) {
+          return false
+        }
+
+        if (!pluginVersion) {
+          return true
+        }
+
+        if (
+          dependencyVersion.startsWith('^') ||
+          dependencyVersion.startsWith('~')
+        ) {
+          dependencyVersion = dependencyVersion.slice(1)
+        }
+
+        return dependencyVersion.startsWith(pluginVersion)
+      },
+    )
+
+    if (isPluginInstalled) {
+      installedPlugins.push(pluginName)
+    } else {
+      pluginsToInstall.push(rawPluginName)
+    }
+  })
+
+  return {
+    pluginsToInstall,
+    installedPlugins,
+  }
+}
+
+export async function installPlugins(pluginNames: string[]) {
+  if (!pluginNames.length) {
+    return
+  }
+
+  if (!fs.existsSync(PLUGIN_STORE_PATH)) {
+    fs.mkdirSync(PLUGIN_STORE_PATH)
+  }
+
+  if (!fs.existsSync(PLUGINS_PACKAGE_JSON_PATH)) {
+    fs.writeFileSync(PLUGINS_PACKAGE_JSON_PATH, '{}', { encoding: 'utf-8' })
+  }
+
+  const { pluginsToInstall, installedPlugins } =
+    filterPluginsToInstall(pluginNames)
+
+  if (installedPlugins.length) {
+    console.log('\n----- Already installed ----\n')
+    installedPlugins.forEach(pluginName => console.log(` - ${pluginName}`))
+  }
+
+  if (pluginsToInstall.length) {
+    console.log('\n---- Installing plugins ----\n')
+    pluginsToInstall.forEach(pluginName => console.log(` - ${pluginName}`))
+
+    const child = spawn(
+      npmExecutable,
+      [
+        'install',
+        '--ignore-scripts',
+        '--no-package-lock',
+        '--no-lockfile',
+        '--omit=dev',
+        '--install-strategy=shallow',
+        '--no-bin-links',
+        '--no-global',
+        ...pluginsToInstall,
+      ],
+      {
+        cwd: PLUGIN_STORE_PATH,
+        env: Object.assign({}, process.env, { NODE_ENV: 'production' }),
+        stdio: 'inherit',
+      },
+    )
+
+    return await new Promise<void>((resolve, reject) => {
+      child.on('error', err => {
+        reject(err)
+      })
+      child.on('exit', code => {
+        if (code === 0) {
+          return resolve()
+        }
+        reject()
+      })
+    })
+  }
+}

src/main.ts

@@ -1,17 +1,16 @@
 import { resolve } from 'import-meta-resolve'
 
-import { installNpmPackages } from './install-npm-packages.js'
+import { installPlugins } from './install-plugins.js'
 import { parseArgs } from './parse-args.js'
 import { PLUGINS_PACKAGE_JSON_PATH } from './paths.js'
+import { splitPluginNameAndVersion } from './utils.js'
 
 export async function run(args: string[]) {
   const { prettierArgs, pluginNames } = parseArgs(args)
 
   if (pluginNames.length) {
     try {
-      console.log('\n---- Installing plugins ----\n')
-      pluginNames.forEach(pluginName => console.log(' - ' + pluginName))
-      await installNpmPackages(pluginNames)
+      await installPlugins(pluginNames)
       console.log('\n----- Running prettier -----\n')
     } catch {
       process.exit(1)
@@ -22,7 +21,7 @@ export async function run(args: string[]) {
 
   const pnpPlugins: string[] = []
   pluginNames.forEach(pluginName => {
-    pluginName = pluginName.split('@')[0]
+    pluginName = splitPluginNameAndVersion(pluginName).name
     const resolved = resolve(pluginName, PLUGINS_PACKAGE_JSON_PATH.href)
     pnpPlugins.push('--plugin', resolved)
   })

src/parse-args.ts

@@ -1,3 +1,5 @@
+import { splitPluginNameAndVersion } from './utils.js'
+
 function extendPluginName(shortName: string) {
   return 'prettier-plugin-' + shortName
 }
@@ -11,7 +13,9 @@ export function parseArgs(args: string[]): {
 
   function pushPluginName(pluginName: string) {
     const isDuplicated = pluginNames.some(
-      name => name.split('@')[0] === pluginName.split('@')[0],
+      name =>
+        splitPluginNameAndVersion(name).name ===
+        splitPluginNameAndVersion(pluginName).name,
     )
 
     if (isDuplicated) {

src/utils.ts

@@ -0,0 +1,19 @@
+export function splitPluginNameAndVersion(packageName: string): {
+  name: string
+  version: string | undefined
+} {
+  let name = ''
+
+  if (packageName.startsWith('@')) {
+    name = '@'
+    packageName = packageName.slice(1)
+  }
+
+  name += packageName.split('@')[0]
+  const version = packageName.split('@')[1]
+
+  return {
+    name,
+    version,
+  }
+}

tests/integration/__tests__/__snapshots__/cli.test.ts.snap

@@ -30,6 +30,60 @@ exports[`prettier-pnp cli > should install plugins with specific version 2`] = `
 "
 `;
 
+exports[`prettier-pnp cli > should not try to install already installed plugins (with fixed version) 2`] = `
+"
+----- Already installed ----
+
+ - prettier-plugin-curly
+
+----- Running prettier -----
+
+/** --- FIXTURE --- */
+
+const a = 5;
+
+if (false) {
+  true;
+}
+"
+`;
+
+exports[`prettier-pnp cli > should not try to install already installed plugins (with fixed version) 3`] = `
+"
+----- Already installed ----
+
+ - prettier-plugin-curly
+
+----- Running prettier -----
+
+/** --- FIXTURE --- */
+
+const a = 5;
+
+if (false) {
+  true;
+}
+"
+`;
+
+exports[`prettier-pnp cli > should not try to install already installed plugins (with fixed version) 4`] = `
+"
+----- Already installed ----
+
+ - prettier-plugin-curly
+
+----- Running prettier -----
+
+/** --- FIXTURE --- */
+
+const a = 5;
+
+if (false) {
+  true;
+}
+"
+`;
+
 exports[`prettier-pnp cli > should pass rest args to prettier 1`] = `
 "/** --- FIXTURE --- */