Improve a few notes here & there

webpro · webpro · commit f0fdef450a8b · 2025-12-24T08:01:30.000+01:00
diff --git a/AGENTS.md b/AGENTS.md
@@ -142,7 +142,8 @@ If requested to create a new plugin for a certain package/tool/framework:
 - Update the plugin's `types.ts`: add only relevant types, remove if unused.
 - Consult similar plugins and the tool's website to implement the plugin.
 - Update and fill out the blanks in the new files.
-- Don't forget: [run tests][18] individually first
+- Don't forget: [run tests][18] individually first.
+- Remove unused variables and empty arrays from the template.
 
 [1]: https://knip.dev
 [2]: ./packages/knip/src/types/module-graph.ts
diff --git a/packages/knip/test/plugins/_template.test.ts b/packages/knip/test/plugins/_template.test.ts
@@ -12,14 +12,12 @@ test('Find dependencies with the __PLUGIN_NAME__ plugin', async () => {
    * Ideally, plugin tests have no `issues` left and only `total` and `processed` values in `counters`.
    * This means for instance that a dependency used in a file, is also listed in package.json, resulting in zero issues.
    *
-   * See `binaries` issues? This is an integration test, Knip might search in `node_modules` for `package.json#bin`.
-   * Either we accept the missing binaries and count them as issues (`binaries: [n]`), or we add 2 fixture files:
-   * → `node_modules/package-name/package.json` with a `bin` pointing to an existing empty `./index.js` file
+   * Missing binaries? Add: node_modules/pkg/package.json with bin → ./index.js
    *
-   * Sometimes the "Publish preview & run ecosystem tests" workflow in CI (GitHub Action) fails, you can probably ignore.
-   * All other workflows should be green though!
+   * Failures in "Publish preview & run ecosystem tests" can usually be ignored, unless related to your changes.
+   * All other workflows should be green though.
    *
-   * Here's a link to the docs, just in case: https://knip.dev/writing-a-plugin
+   * Docs: https://knip.dev/writing-a-plugin
    *
    * Please remove this comment! 🔥
    */

Original file line number	Diff line number	Diff line change
`@@ -12,14 +12,12 @@ test('Find dependencies with the __PLUGIN_NAME__ plugin', async () => {`
`12`	`12`	* Ideally, plugin tests have no `issues` left and only `total` and `processed` values in `counters`.
`13`	`13`	`* This means for instance that a dependency used in a file, is also listed in package.json, resulting in zero issues.`
`14`	`14`	`*`
`15`		- * See `binaries` issues? This is an integration test, Knip might search in `node_modules` for `package.json#bin`.
`16`		- * Either we accept the missing binaries and count them as issues (`binaries: [n]`), or we add 2 fixture files:
`17`		- * → `node_modules/package-name/package.json` with a `bin` pointing to an existing empty `./index.js` file
	`15`	`+ * Missing binaries? Add: node_modules/pkg/package.json with bin → ./index.js`
`18`	`16`	`*`
`19`		`- * Sometimes the "Publish preview & run ecosystem tests" workflow in CI (GitHub Action) fails, you can probably ignore.`
`20`		`- * All other workflows should be green though!`
	`17`	`+ * Failures in "Publish preview & run ecosystem tests" can usually be ignored, unless related to your changes.`
	`18`	`+ * All other workflows should be green though.`
`21`	`19`	`*`
`22`		`- * Here's a link to the docs, just in case: https://knip.dev/writing-a-plugin`
	`20`	`+ * Docs: https://knip.dev/writing-a-plugin`
`23`	`21`	`*`
`24`	`22`	`* Please remove this comment! 🔥`
`25`	`23`	`*/`