From d2d23136c159b20a76497a4c225436c66bcdfbe3 Mon Sep 17 00:00:00 2001 From: Thomas Cardonne Date: Tue, 30 Jul 2024 23:46:47 +0200 Subject: [PATCH] feat: add config.d.ts in tsconfig included files Signed-off-by: Thomas Cardonne --- .changeset/afraid-fans-cross.md | 8 ++++++++ packages/cli/src/commands/repo/list-deprecations.ts | 4 ++-- packages/create-app/templates/default-app/tsconfig.json | 2 ++ tsconfig.json | 2 ++ 4 files changed, 14 insertions(+), 2 deletions(-) create mode 100644 .changeset/afraid-fans-cross.md diff --git a/.changeset/afraid-fans-cross.md b/.changeset/afraid-fans-cross.md new file mode 100644 index 0000000000..1901d8ce0f --- /dev/null +++ b/.changeset/afraid-fans-cross.md @@ -0,0 +1,8 @@ +--- +'@backstage/create-app': patch +'@backstage/cli': patch +--- + +Add `config.d.ts` files to the list of included file in `tsconfig.json`. + +This allows ESLint to detect issues or deprecations in those files. diff --git a/packages/cli/src/commands/repo/list-deprecations.ts b/packages/cli/src/commands/repo/list-deprecations.ts index 69fe51f78e..772038025a 100644 --- a/packages/cli/src/commands/repo/list-deprecations.ts +++ b/packages/cli/src/commands/repo/list-deprecations.ts @@ -17,7 +17,7 @@ import chalk from 'chalk'; import { ESLint } from 'eslint'; import { OptionValues } from 'commander'; -import { join as joinPath, relative as relativePath } from 'path'; +import { relative as relativePath } from 'path'; import { PackageGraph } from '@backstage/cli-node'; import { paths } from '../../lib/paths'; @@ -45,7 +45,7 @@ export async function command(opts: OptionValues) { const deprecations = []; for (const [index, pkg] of packages.entries()) { - const results = await eslint.lintFiles(joinPath(pkg.dir, 'src')); + const results = await eslint.lintFiles(pkg.dir); for (const result of results) { for (const message of result.messages) { if (message.ruleId !== 'deprecation/deprecation') { diff --git a/packages/create-app/templates/default-app/tsconfig.json b/packages/create-app/templates/default-app/tsconfig.json index ba3f90177d..2aa745d3a9 100644 --- a/packages/create-app/templates/default-app/tsconfig.json +++ b/packages/create-app/templates/default-app/tsconfig.json @@ -2,7 +2,9 @@ "extends": "@backstage/cli/config/tsconfig.json", "include": [ "packages/*/src", + "packages/*/config.d.ts", "plugins/*/src", + "plugins/*/config.d.ts", "plugins/*/dev", "plugins/*/migrations" ], diff --git a/tsconfig.json b/tsconfig.json index 789743363d..8d72a3315b 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -2,7 +2,9 @@ "extends": "@backstage/cli/config/tsconfig.json", "include": [ "packages/*/src", + "packages/*/config.d.ts", "plugins/*/src", + "plugins/*/config.d.ts", "plugins/*/dev", "plugins/*/migrations" ],