From 489a54e1fb35d8cdb4bec839c0e76a073a8e3eb6 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Thu, 9 May 2024 17:23:59 +0300 Subject: [PATCH] fix(docblock-generator): eslint errors + missing await (#7281) * chore: add missing await in docblock generator * add fix for undefined symbol * fix dirname path --- .../docblock-generator/src/classes/helpers/formatter.ts | 5 ++++- .../packages/docblock-generator/src/classes/kinds/default.ts | 2 +- .../docblock-generator/src/commands/run-git-changes.ts | 2 +- .../docblock-generator/src/commands/run-git-commit.ts | 2 +- .../packages/docblock-generator/src/commands/run-release.ts | 2 +- www/utils/packages/docblock-generator/src/utils/dirname.ts | 4 ++-- .../docblock-generator/src/utils/get-monorepo-root.ts | 2 +- 7 files changed, 11 insertions(+), 8 deletions(-) diff --git a/www/utils/packages/docblock-generator/src/classes/helpers/formatter.ts b/www/utils/packages/docblock-generator/src/classes/helpers/formatter.ts index 929a22ebe6..7a18c1362c 100644 --- a/www/utils/packages/docblock-generator/src/classes/helpers/formatter.ts +++ b/www/utils/packages/docblock-generator/src/classes/helpers/formatter.ts @@ -106,7 +106,10 @@ class Formatter { this.eslintConfig = ( await import( - path.relative(dirname(), path.join(this.cwd, ".eslintrc.js")) + path.relative( + dirname(import.meta.url), + path.join(this.cwd, ".eslintrc.js") + ) ) ).default as Linter.Config diff --git a/www/utils/packages/docblock-generator/src/classes/kinds/default.ts b/www/utils/packages/docblock-generator/src/classes/kinds/default.ts index e20d864b14..1a502cc8c5 100644 --- a/www/utils/packages/docblock-generator/src/classes/kinds/default.ts +++ b/www/utils/packages/docblock-generator/src/classes/kinds/default.ts @@ -474,7 +474,7 @@ class DefaultKindGenerator { } if ( - symbolType.symbol.valueDeclaration && + symbolType.symbol?.valueDeclaration && "heritageClauses" in symbolType.symbol.valueDeclaration ) { return this.isEntity({ diff --git a/www/utils/packages/docblock-generator/src/commands/run-git-changes.ts b/www/utils/packages/docblock-generator/src/commands/run-git-changes.ts index 78818f6d81..50ce7c4ab4 100644 --- a/www/utils/packages/docblock-generator/src/commands/run-git-changes.ts +++ b/www/utils/packages/docblock-generator/src/commands/run-git-changes.ts @@ -40,7 +40,7 @@ export default async function runGitChanges({ ...options, }) - oasGenerator.run() + await oasGenerator.run() } console.log(`Finished generating docs for ${files.length} files.`) diff --git a/www/utils/packages/docblock-generator/src/commands/run-git-commit.ts b/www/utils/packages/docblock-generator/src/commands/run-git-commit.ts index a88034d413..1ed2cd2332 100644 --- a/www/utils/packages/docblock-generator/src/commands/run-git-commit.ts +++ b/www/utils/packages/docblock-generator/src/commands/run-git-commit.ts @@ -48,7 +48,7 @@ export default async function ( ...options, }) - oasGenerator.run() + await oasGenerator.run() } console.log(`Finished generating docs for ${filteredFiles.length} files.`) diff --git a/www/utils/packages/docblock-generator/src/commands/run-release.ts b/www/utils/packages/docblock-generator/src/commands/run-release.ts index 62df087bea..5af53a24c1 100644 --- a/www/utils/packages/docblock-generator/src/commands/run-release.ts +++ b/www/utils/packages/docblock-generator/src/commands/run-release.ts @@ -46,7 +46,7 @@ export default async function ({ type, tag, ...options }: CommonCliOptions) { ...options, }) - oasGenerator.run() + await oasGenerator.run() } console.log(`Finished generating docs for ${filteredFiles.length} files.`) diff --git a/www/utils/packages/docblock-generator/src/utils/dirname.ts b/www/utils/packages/docblock-generator/src/utils/dirname.ts index fbdb8f6a90..4e4a89bd72 100644 --- a/www/utils/packages/docblock-generator/src/utils/dirname.ts +++ b/www/utils/packages/docblock-generator/src/utils/dirname.ts @@ -1,8 +1,8 @@ import path from "path" import { fileURLToPath } from "url" -export default function dirname() { - const __filename = fileURLToPath(import.meta.url) +export default function dirname(fileUrl: string) { + const __filename = fileURLToPath(fileUrl) return path.dirname(__filename) } diff --git a/www/utils/packages/docblock-generator/src/utils/get-monorepo-root.ts b/www/utils/packages/docblock-generator/src/utils/get-monorepo-root.ts index 2d8ac2af00..b5040b0ffc 100644 --- a/www/utils/packages/docblock-generator/src/utils/get-monorepo-root.ts +++ b/www/utils/packages/docblock-generator/src/utils/get-monorepo-root.ts @@ -10,6 +10,6 @@ import dirname from "./dirname.js" export default function getMonorepoRoot() { return ( process.env.MONOREPO_ROOT_PATH || - path.join(dirname(), "..", "..", "..", "..", "..", "..") + path.join(dirname(import.meta.url), "..", "..", "..", "..", "..", "..") ) }