Skip to content

feat: prefer package.json description over README-inferred #1107

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

Merged
taras merged 1 commit into from
Mar 3, 2026
+11 −0
Merged

feat: prefer package.json description over README-inferred #1107

Show file tree
Hide file tree
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
8 changes: 8 additions & 0 deletions www/lib/package/node.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ const ExportsSchema = z.union([
export const PackageJsonSchema = z.object({
name: z.string().optional(),
version: z.string().optional(),
description: z.string().optional(),
exports: ExportsSchema.optional(),
license: z.string().optional(),
dependencies: z.record(z.string()).optional(),
Expand Down Expand Up @@ -193,6 +194,7 @@ export function createNodePackage(
return {
name: packageJson.name,
version: packageJson.version,
description: packageJson.description,
exports: normalizeExports(packageJson.exports),
license: packageJson.license,
imports: buildImports(packageJson),
Expand Down Expand Up @@ -284,6 +286,12 @@ export function createNodePackage(
},

*getDescription(): Operation<string> {
// Prefer manifest description over README-inferred description
let manifest = yield* this.getManifest();
if (manifest.description) {
return manifest.description;
}
// Fall back to README-inferred description
let readme = yield* this.getReadme();
return yield* useDescription(readme);
},
Expand Down
3 changes: 3 additions & 0 deletions www/lib/package/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ export interface PackageManifest {
/** Package version */
version?: string;

/** Package description from package.json */
description?: string;

/**
* Normalized exports - always Record<string, string>.
* For Node packages, uses the "development" condition.
Expand Down
Loading