knip.js — astro Source File

Source Code

// @ts-check
const testEntry = 'test/**/*.test.js';

/** @type {import('knip').KnipConfig} */
export default {
	ignore: ['**/test/**/{fixtures,_temp-fixtures}/**', '.github/scripts/**'],
	tags: ['-lintignore'],
	ignoreWorkspaces: [
		'examples/**',
		'**/{test,e2e}/**/{fixtures,_temp-fixtures}/**',
		'benchmark/**',
		'packages/language-tools/**/*',
	],
	workspaces: {
		'.': {
			ignoreDependencies: [
				'@astrojs/check', // Used by the build script but not as a standard module import
			],
			// In smoke tests, we checkout to the docs repo so those binaries are not present in this project
			// vsce and ovsx are only used in CI for publishing, and due to how we have to publish the VS Code extension have
			// to be installed in the vscode package, but knip is expecting them to be in the root node_modules
			ignoreBinaries: ['docgen', 'docgen:errors', 'playwright', 'vsce', 'ovsx'],
		},
		'packages/*': {
			entry: [testEntry],
		},
		'packages/astro': {
			entry: [
				// Can't be detected automatically since it's only in package.json#files
				'templates/**/*',
				testEntry,
				'test/types/**/*',
				'e2e/**/*.test.js',
				'test/units/teardown.js',
				// Can't detect this file when using inside a vite plugin
				'src/vite-plugin-app/createAstroServerApp.ts',
			],
			ignore: [
				'**/e2e/**/{fixtures,_temp-fixtures}/**',
				'performance/**/*',
				// This export is resolved dynamically in packages/astro/src/vite-plugin-app/index.ts
				'src/vite-plugin-app/createExports.ts',
			],
			// Those deps are used in tests but only referenced as strings
			ignoreDependencies: [
				'rehype-autolink-headings',
				'rehype-slug',
				'rehype-toc',
				'remark-code-titles',
				'@types/http-cache-semantics',
				// Dynamically imported by astro add cloudflare
				'@astrojs/cloudflare',
			],
		},
		'packages/db': {
			entry: [testEntry, 'test/types/**/*'],
		},
		'packages/integrations/*': {
			entry: [testEntry],
		},
		'packages/integrations/cloudflare': {
			entry: [testEntry],
			// False positive because of cloudflare:workers
			ignoreDependencies: ['cloudflare'],
		},
		'packages/integrations/mdx': {
			entry: [testEntry],
			// Required but not imported directly
			ignoreDependencies: ['@types/*'],
		},
		'packages/integrations/netlify': {
			entry: [testEntry],
			ignore: ['test/hosted/**'],
		},
		'packages/integrations/solid': {
			entry: [testEntry],
			// It's an optional peer dep (triggers a warning) but it's fine in this case
			ignoreDependencies: ['solid-devtools'],
		},
		'packages/integrations/vercel': {
			entry: [testEntry, 'test/test-image-service.js'],
			ignore: ['test/hosted/**'],
		},
		'packages/markdown/remark': {
			entry: [testEntry],
			// package.json#imports are not resolved at the moment
			ignore: ['src/import-plugin-browser.ts'],
		},
		'packages/upgrade': {
			entry: ['src/index.ts', testEntry],
		},
	},
};