Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[WORKAROUND] fix(tsdocs): disable some repos to gen tsdocs #10223

Merged
merged 1 commit into from
Dec 6, 2023
Merged

[WORKAROUND] fix(tsdocs): disable some repos to gen tsdocs #10223

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion packages/tsdocs/src/monorepo-api-extractor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ import path from 'path';
import {
DEFAULT_APIDOCS_EXTRACTION_PATH,
ExtractorOptions,
getPackagesWithTsDocs,
LernaPackage,
getPackagesWithTsDocs,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this change seems to be introduced by running npm run lint:fix 🤷

typeScriptPath,
} from './helper';
const debug = debugFactory('loopback:tsdocs');
Expand Down Expand Up @@ -67,6 +67,17 @@ export async function runExtractorForMonorepo(options: ExtractorOptions = {}) {
const errors: Record<string, unknown> = {};

for (const pkg of packages) {
// TODO: api-extractor failed to generate apidocs for the repos below.
// Excluding them for now
// https://github.com/loopbackio/loopback-next/issues/10205
if (
pkg.name === '@loopback/typeorm' ||
pkg.name === '@loopback/boot' ||
pkg.name === '@loopback/express' ||
pkg.name === '@loopback/repository' ||
pkg.name === '@loopback/service-proxy'
)
continue;
Comment on lines +73 to +80
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: can we add a comment linking back to the Github issue?

/* istanbul ignore if */
const err = invokeExtractorForPackage(pkg, options);
if (err != null) {
Expand Down