adds support for package.json shared prettier configuration

webpro-nl · Nov 27, 2023 · 7cdabc5 · 7cdabc5
1 parent 5c59fdc
commit 7cdabc5
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/packages/knip/fixtures/plugins/prettier/package.json b/packages/knip/fixtures/plugins/prettier/package.json
@@ -0,0 +1,3 @@
+{
+  "prettier": "@company/prettier-config"
+}
diff --git a/packages/knip/src/plugins/prettier/index.ts b/packages/knip/src/plugins/prettier/index.ts
@@ -27,6 +27,11 @@ const findPrettierDependencies: GenericPluginCallback = async (configFilePath, {
     ? manifest.prettier
     : await load(configFilePath);
 
+  // https://prettier.io/docs/en/configuration.html#sharing-configurations
+  if (typeof localConfig === 'string') {
+    return [localConfig];
+  }
+
   return localConfig && Array.isArray(localConfig.plugins)
     ? localConfig.plugins.filter((plugin): plugin is string => typeof plugin === 'string')
     : [];

diff --git a/packages/knip/test/plugins/prettier.test.ts b/packages/knip/test/plugins/prettier.test.ts
@@ -5,8 +5,14 @@ import { resolve, join } from '../../src/util/path.js';
 
 const cwd = resolve('fixtures/plugins/prettier');
 
-test('Find dependencies in Prettier configuration', async () => {
+test('Find dependencies in Prettier configuration (.prettierrc)', async () => {
   const configFilePath = join(cwd, '.prettierrc');
   const dependencies = await prettier.findDependencies(configFilePath, {});
   assert.deepEqual(dependencies, ['prettier-plugin-xml']);
 });
+
+test('Find dependencies in Prettier configuration (package.json)', async () => {
+  const configFilePath = join(cwd, 'package.json');
+  const dependencies = await prettier.findDependencies(configFilePath, {});
+  assert.deepEqual(dependencies, ['@company/prettier-config']);
+});