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.

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

fix: more permissive usage bounds and headings #2042

Merged
merged 1 commit into from
Mar 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 18 additions & 2 deletions src/options/readUsageFromReadme.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ describe(readUsageFromReadme, () => {
expect(usage).toBeUndefined();
});

it("returns undefined when ## Usage found and ## Development is not found", () => {
it("returns existing content when ## Usage is found and a next important heading is not found", () => {
const usage = readUsageFromReadme("## Usage\n\nContents.");

expect(usage).toBeUndefined();
expect(usage).toBe(`\n\nContents.`);
});

it("returns undefined when there is no content between ## Usage and ## Development", () => {
Expand All @@ -26,4 +26,20 @@ describe(readUsageFromReadme, () => {

expect(usage).toBe("Content.");
});

it("returns the content when content exists between ## Usage and ## Contributing", () => {
const usage = readUsageFromReadme(
"## Usage\n\n Content.\n## Contributing",
);

expect(usage).toBe("Content.");
});

it("returns the content when content exists between ## Usage and ## Contributors", () => {
const usage = readUsageFromReadme(
"## Usage\n\n Content.\n## Contributors",
);

expect(usage).toBe("Content.");
});
});
17 changes: 7 additions & 10 deletions src/options/readUsageFromReadme.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
const startDevelopment = "## Development";
const startUsage = "## Usage";

export function readUsageFromReadme(readme: string) {
Expand All @@ -7,17 +6,15 @@ export function readUsageFromReadme(readme: string) {
return undefined;
}

const indexOfDevelopment = readme.indexOf(
startDevelopment,
indexOfUsage + startUsage.length,
);
if (indexOfDevelopment === -1) {
return undefined;
const offset = indexOfUsage + startUsage.length;
const indexOfNextKnownHeading = readme
.slice(offset)
.search(/## (?:Development|Contributing|Contributors)/);
if (indexOfNextKnownHeading === -1) {
return readme.slice(offset);
}

const usage = readme
.slice(indexOfUsage + startUsage.length, indexOfDevelopment)
.trim();
const usage = readme.slice(offset, indexOfNextKnownHeading + offset).trim();

return usage ? usage : undefined;
}