Skip to content

fix: do not resolve documented subpath patterns as filenames #210

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
pathscale merged 1 commit into from
Jul 26, 2026
Merged

fix: do not resolve documented subpath patterns as filenames #210

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: 13 additions & 0 deletions scripts/check-package.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,19 @@ if (existsSync("README.md")) {
for (const spec of specifiers) {
const subpath = spec === pkg.name ? "." : `./${spec.slice(pkg.name.length + 1)}`;

// A specifier containing `*` is prose describing a family of subpaths
// ("also @pathscale/ui/hooks/*"), not something anyone imports literally.
// Require that an exports key covers the pattern; do not resolve it to a file.
if (subpath.includes("*")) {
if (!Object.keys(pkg.exports ?? {}).includes(subpath)) {
failures.push({
rule: "README documents a subpath pattern that is not exported",
detail: `${spec} has no matching "exports" key`,
});
}
continue;
}

// Find the exports key that would match, honouring a single wildcard segment.
const key = Object.keys(pkg.exports ?? {}).find((k) => {
if (k === subpath) return true;
Expand Down
Loading