- Notifications
You must be signed in to change notification settings - Fork2
Feature/validate markdown#33
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
4 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
4 changes: 2 additions & 2 deletionspackage.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletionssrc/build.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
70 changes: 70 additions & 0 deletionssrc/utils/validateMarkdown.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| type Validation = { | ||
| message: string; | ||
| validate: (t: string) => boolean; | ||
| }; | ||
| const validations: Validation[] = [ | ||
| { | ||
| message: "should start with a title", | ||
| validate: (t) => !!t.match(/^#\s.+/), | ||
| }, | ||
| { | ||
| message: "should not have multiple `#` headers", | ||
| validate: (t) => !t.match(/[\n\r]#\s/), | ||
| }, | ||
| { | ||
| message: "should have a summary description under the title", | ||
| validate: (t) => { | ||
| const [summary] = t.split(/[\n\r]##/) || [""]; | ||
| const description = summary | ||
| .split(/\n/) | ||
| .slice(1) | ||
| .filter((l) => l.length); | ||
| return !!description.length; | ||
| }, | ||
| }, | ||
| { | ||
| message: "should have a level `##` with a format of `L[0-9]+`", | ||
| validate: (t) => { | ||
| const headers = t.match(/^#{2}\s(.+)$/gm) || []; | ||
| for (const header of headers) { | ||
| if (!header.match(/^#{2}\s(L\d+)\s(.+)$/)) { | ||
| return false; | ||
| } | ||
| } | ||
| return true; | ||
| }, | ||
| }, | ||
| { | ||
| message: "should have a step `###` with a format of `L[0-9]+S[0-9]+`", | ||
| validate: (t) => { | ||
| const headers = t.match(/^#{3}\s(.+)$/gm) || []; | ||
| for (const header of headers) { | ||
| if (!header.match(/^#{3}\s(L\d+)S\d+/)) { | ||
| return false; | ||
| } | ||
| } | ||
| return true; | ||
| }, | ||
| }, | ||
| ]; | ||
| const codeBlockRegex = /```[a-z]*\n[\s\S]*?\n```/gm; | ||
| export function validateMarkdown(md: string): boolean { | ||
| // remove codeblocks which might contain any valid combinations | ||
| const text = md.replace(codeBlockRegex, ""); | ||
| let valid = true; | ||
| for (const v of validations) { | ||
| if (!v.validate(text)) { | ||
| valid = false; | ||
| if (process.env.NODE_ENV !== "test") { | ||
| console.warn(v.message); | ||
| } | ||
| } | ||
| } | ||
| return valid; | ||
| } |
134 changes: 134 additions & 0 deletionstests/markdown.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| import { validateMarkdown } from "../src/utils/validateMarkdown"; | ||
| describe("validate markdown", () => { | ||
| it("should return false if missing a summary title (#)", () => { | ||
| const md = ` | ||
| Description. | ||
| ## L1 Put Level's title here | ||
| > Level's summary: a short description of the level's content in one line. | ||
| Some text that describes the level`; | ||
| expect(validateMarkdown(md)).toBe(false); | ||
| }); | ||
| it("should return false if contains multiple `#` headers", () => { | ||
| const md1 = `# A Title | ||
| Description. | ||
| # Another Title | ||
| ## L1 Put Level's title here | ||
| > Level's summary: a short description of the level's content in one line. | ||
| Some text that describes the level`; | ||
| const md2 = `# A Title | ||
| Description. | ||
| ## L1 Put Level's title here | ||
| > Level's summary: a short description of the level's content in one line. | ||
| Some text that describes the level | ||
| # Another title | ||
| `; | ||
| expect(validateMarkdown(md1)).toBe(false); | ||
| expect(validateMarkdown(md2)).toBe(false); | ||
| }); | ||
| it("should return false if missing a summary description", () => { | ||
| const md = `# A Title | ||
| ## L1 Put Level's title here | ||
| > Level's summary: a short description of the level's content in one line. | ||
| Some text that describes the level | ||
| `; | ||
| expect(validateMarkdown(md)).toBe(false); | ||
| }); | ||
| it("should return false if `##` doesn't preface a level", () => { | ||
| const md = `# A Title | ||
| A description | ||
| ## Put Level's title here | ||
| > Level's summary: a short description of the level's content in one line. | ||
| Some text that describes the level | ||
| `; | ||
| expect(validateMarkdown(md)).toBe(false); | ||
| }); | ||
| it("should return false if `###` doesn't preface a step", () => { | ||
| const md = `# A Title | ||
| A description | ||
| ## Put Level's title here | ||
| > Level's summary: a short description of the level's content in one line. | ||
| Some text that describes the level | ||
| ### A Step | ||
| First step | ||
| `; | ||
| }); | ||
| it("should return true for valid markdown", () => { | ||
| const md = `# Title | ||
| Description. | ||
| ## L1 Put Level's title here | ||
| > Level's summary: a short description of the level's content in one line. | ||
| Some text that describes the level | ||
| ### L1S1 | ||
| First Step`; | ||
| expect(validateMarkdown(md)).toBe(true); | ||
| }); | ||
| it("should ignore markdown content in codeblocks", () => { | ||
| const md = `# Title | ||
| Description. | ||
| \`\`\`md | ||
| # A codeblock | ||
| Should not be a problem | ||
| \`\`\` | ||
| ## L1 Put Level's title here | ||
| > Level's summary: a short description of the level's content in one line. | ||
| Some text that describes the level | ||
| \`\`\` | ||
| ## Another Level in markdown | ||
| Should not be an issue | ||
| \`\`\` | ||
| ### L1S1 | ||
| First Step`; | ||
| expect(validateMarkdown(md)).toBe(true); | ||
| }); | ||
| }); |
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.