Commit183a5cd

committed

add markdown validation to build script

Signed-off-by: shmck <shawn.j.mckay@gmail.com>

1 parent3feef7c commit183a5cdCopy full SHA for 183a5cd

File tree

+18

-7

lines changed

+18

-7

lines changed

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name":"@coderoad/cli",`
`3`		`-"version":"0.2.0",`
	`3`	`+"version":"0.2.1",`
`4`	`4`	`"description":"A CLI to build the configuration file for Coderoad Tutorials",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"coderoad",`
`@@ -25,7 +25,7 @@`
`25`	`25`	`],`
`26`	`26`	`"main":"bin/coderoad",`
`27`	`27`	`"bin": {`
`28`		`-"@coderoad/coderoad":"bin/coderoad",`
	`28`	`+"@coderoad/cli":"bin/coderoad",`
`29`	`29`	`"coderoad":"bin/coderoad"`
`30`	`30`	`},`
`31`	`31`	`"scripts": {`

Lines changed: 13 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ import { getCommits, CommitLogObject } from "./utils/commits";`
`8`	`8`	`importskeletonSchemafrom"./schema/skeleton";`
`9`	`9`	`importtutorialSchemafrom"./schema/tutorial";`
`10`	`10`	`import{validateSchema}from"./utils/validateSchema";`
	`11`	`+import{validateMarkdown}from"./utils/validateMarkdown";`
`11`	`12`	`import*asTfrom"../typings/tutorial";`
`12`	`13`
`13`	`14`	`constwrite=util.promisify(fs.writeFile);`
`@@ -72,6 +73,18 @@ async function build(args: string[]) {`
`72`	`73`	`return;`
`73`	`74`	`}`
`74`	`75`
	`76`	`+// validate markdown loosely`
	`77`	`+try{`
	`78`	`+constisValid=validateMarkdown(_markdown);`
	`79`	`+if(!isValid){`
	`80`	`+console.warn("Invalid markdown");`
	`81`	`+}`
	`82`	`+}catch(e){`
	`83`	`+console.error("Error validating markdown:");`
	`84`	`+console.error(e.message);`
	`85`	`+return;`
	`86`	`+}`
	`87`	`+`
`75`	`88`	`// parse yaml skeleton config`
`76`	`89`	`letskeleton;`
`77`	`90`	`try{`

Lines changed: 3 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,6 @@ const validations: Validation[] = [`
`27`	`27`	message:"should have a level `##` with a format of `L[0-9]+`",
`28`	`28`	`validate:(t)=>{`
`29`	`29`	`constheaders=t.match(/^#{2}\s(.+)$/gm)\|\|[];`
`30`		`-console.log("level headers",headers);`
`31`	`30`	`for(constheaderofheaders){`
`32`	`31`	`if(!header.match(/^#{2}\s(L\d+)\s(.+)$/)){`
`33`	`32`	`returnfalse;`
`@@ -40,7 +39,6 @@ const validations: Validation[] = [`
`40`	`39`	message:"should have a step `###` with a format of `L[0-9]+S[0-9]+`",
`41`	`40`	`validate:(t)=>{`
`42`	`41`	`constheaders=t.match(/^#{3}\s(.+)$/gm)\|\|[];`
`43`		`-console.log("step headers",headers);`
`44`	`42`	`for(constheaderofheaders){`
`45`	`43`	`if(!header.match(/^#{3}\s(L\d+)S\d+/)){`
`46`	`44`	`returnfalse;`
`@@ -62,9 +60,9 @@ export function validateMarkdown(md: string): boolean {`
`62`	`60`	`for(constvofvalidations){`
`63`	`61`	`if(!v.validate(text)){`
`64`	`62`	`valid=false;`
`65`		`-//if (process.env.NODE_ENV !== "test") {`
`66`		`-console.warn(v.message);`
`67`		`-//}`
	`63`	`+if(process.env.NODE_ENV!=="test"){`
	`64`	`+console.warn(v.message);`
	`65`	`+}`
`68`	`66`	`}`
`69`	`67`	`}`
`70`	`68`

Comments

(0)