Handle var interpolations in shell cmd scripts (resolve #1867)

Author: webpro

knip.json

@@ -14,7 +14,8 @@
       "entry": ["{remark,scripts}/*.ts"]
     },
     "packages/vscode-knip": {
-      "entry": ["src/index.js!", "scripts/*.js", "test/*.mjs"]
+      "entry": ["src/index.js!", "scripts/*.js", "test/*.mjs"],
+      "ignoreBinaries": ["vsce", "ovsx"]
     }
   }
 }

packages/knip/fixtures/plugin-config/child-process-exec/index.ts

@@ -36,6 +36,12 @@ execFileSync('apricot', undefined, { cwd: '/tmp' });
 execFile('cherry', ['commit', '-m', 'ship it && phantomdeploy']);
 spawn('grape', ['render', 'a | phantomgrep']);
 
+const target = 'prod';
+execSync(`fig deploy --target=${target}`);
+exec(`melon ${target} --watch`);
+const bin = 'watermelon';
+execSync(`${bin} phantomserve`);
+
 // not referenced: dynamic command, and a non-child_process `.exec`
 const dynamic = 'kiwi';
 execSync(dynamic);

packages/knip/fixtures/plugin-config/script-visitors-bun/script.ts

@@ -7,3 +7,6 @@ await $`bun boxen I ❤ unicorns`;
 await $`oh-my not supported yet`;
 
 await $`ls *.*`;
+
+const directoryPath = '/tmp/repo';
+await $`git -C ${directoryPath} config fetch.prune false`;

packages/knip/fixtures/plugin-config/script-visitors-execa/execa-docs.mjs

@@ -9,3 +9,5 @@ await Promise.all([$`executable1; echo 1`, $`executable2; echo 2`, $`executable3
 
 const name = 'content';
 await $`mkdir /tmp/${name}`;
+
+await $`git -C ${name} config fetch.prune false`;

packages/knip/fixtures/plugin-config/script-visitors-execa/methods.mjs

@@ -15,3 +15,6 @@ await execaNode('execa-node.mjs');
 await execaNode`execa-node-tag.mjs`;
 
 await execa('node', ['build && phantomexeca']);
+
+const dir = '/tmp';
+await execaCommand(`git -C ${dir} config fetch.prune false`);

packages/knip/fixtures/plugin-config/script-visitors-zx/zx-docs.mjs

@@ -9,3 +9,5 @@ await Promise.all([$`sleep 1; echo 1`, $`sleep 2; echo 2`, $`sleep 3; echo 3`]);
 
 const name = 'content';
 await $`mkdir /tmp/${name}`;
+
+await $`git -C ${name} config fetch.prune false`;

packages/knip/src/binaries/index.ts

@@ -1,3 +1,4 @@
+import { SCRIPT_INTERPOLATION } from '../constants.ts';
 import type { GetInputsFromScripts } from '../types/config.ts';
 import { fromBinary, type Input, isBinary, isDependency } from '../util/input.ts';
 import { timerify } from '../util/Performance.ts';
@@ -10,6 +11,7 @@ const getInputsFromScripts: GetInputsFromScripts = (npmScripts, options) => {
 
   for (const input of results) {
     if (!input.specifier) continue;
+    if (input.specifier.includes(SCRIPT_INTERPOLATION)) continue;
     if (isDependency(input) && input.specifier.startsWith('http')) continue;
     if (isBinary(input) && !/^\b/.test(fromBinary(input))) continue;
     inputs.add(input);

packages/knip/src/constants.ts

@@ -251,6 +251,8 @@ export const SIDE_EFFECTS = '__side-effects';
 
 export const OPAQUE = '__opaque';
 
+export const SCRIPT_INTERPOLATION = '$__knip__';
+
 export const IMPORT_FLAGS = {
   NONE: 0,
   RE_EXPORT: 1 << 0,

packages/knip/src/plugins/execa/visitors/execa.ts

@@ -1,5 +1,5 @@
 import type { PluginVisitorContext, PluginVisitorObject } from '../../../types/config.ts';
-import { getSafeScriptFromArgs, getStringValue, isStringLiteral } from '../../../typescript/ast-nodes.ts';
+import { getSafeScriptFromArgs, getScriptFromArg, getScriptFromTemplate } from '../../../typescript/ast-nodes.ts';
 
 const tags = new Set(['$', '$sync']);
 const methods = new Set(['execa', 'execaSync', 'execaCommand', 'execaCommandSync', 'execaNode', '$sync']);
@@ -14,15 +14,10 @@ export function createExecaVisitor(ctx: PluginVisitorContext): PluginVisitorObje
           : tag.type === 'CallExpression' && tag.callee.type === 'Identifier'
             ? tag.callee.name
             : undefined;
-      if (tagName === 'execaNode') {
-        for (const q of node.quasi.quasis) {
-          if (q.value.raw) ctx.addScript(`node ${q.value.raw}`);
-        }
-      } else if (tagName && tags.has(tagName)) {
-        for (const q of node.quasi.quasis) {
-          if (q.value.raw) ctx.addScript(q.value.raw);
-        }
-      }
+      const isNode = tagName === 'execaNode';
+      if (!isNode && !(tagName && tags.has(tagName))) return;
+      const script = getScriptFromTemplate(node.quasi);
+      if (script) ctx.addScript(isNode ? `node ${script}` : script);
     },
     CallExpression(node) {
       if (node.callee.type !== 'Identifier' || !methods.has(node.callee.name)) return;
@@ -31,10 +26,8 @@ export function createExecaVisitor(ctx: PluginVisitorContext): PluginVisitorObje
         const script = getSafeScriptFromArgs(node.arguments[0], node.arguments[1]);
         if (script) ctx.addScript(`node ${script}`);
       } else if (fnName.startsWith('execaCommand')) {
-        if (node.arguments[0] && isStringLiteral(node.arguments[0])) {
-          const val = getStringValue(node.arguments[0]);
-          if (val) ctx.addScript(val);
-        }
+        const script = getScriptFromArg(node.arguments[0]);
+        if (script) ctx.addScript(script);
       } else {
         const script = getSafeScriptFromArgs(node.arguments[0], node.arguments[1]);
         if (script) ctx.addScript(script);

packages/knip/src/plugins/zx/visitors/zx.ts

@@ -1,13 +1,13 @@
 import type { PluginVisitorContext, PluginVisitorObject } from '../../../types/config.ts';
+import { getScriptFromTemplate } from '../../../typescript/ast-nodes.ts';
 
 export function createZxVisitor(ctx: PluginVisitorContext): PluginVisitorObject {
   return {
     TaggedTemplateExpression(node) {
       if (!ctx.sourceText.startsWith('#!/usr/bin/env zx')) return;
       if (node.tag.type === 'Identifier' && node.tag.name === '$') {
-        for (const q of node.quasi.quasis) {
-          if (q.value.raw) ctx.addScript(q.value.raw);
-        }
+        const script = getScriptFromTemplate(node.quasi);
+        if (script) ctx.addScript(script);
       }
     },
   };