diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 9ee005c..96bb4e5 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -21,7 +21,7 @@ jobs: with: bun-version: latest - run: bun test - fmt: + pretty: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -29,3 +29,4 @@ jobs: with: bun-version: latest - run: bun fmt:ci + - run: bun lint diff --git a/bun.lockb b/bun.lockb index dfed919..8a29fd7 100755 Binary files a/bun.lockb and b/bun.lockb differ diff --git a/lint.ts b/lint.ts new file mode 100644 index 0000000..235cf35 --- /dev/null +++ b/lint.ts @@ -0,0 +1,61 @@ +import { readFile, readdir, stat } from "fs/promises"; +import * as path from "path"; +import * as marked from "marked"; + +const files = await readdir(".", { withFileTypes: true }); +const dirs = files.filter( + (f) => f.isDirectory() && !f.name.startsWith(".") && f.name !== "node_modules" +); + +let badExit = false + +// Ensures that each README has the proper format. +// Exits with 0 if all is good! +for (const dir of dirs) { + const readme = path.join(dir.name, "README.md"); + // Ensure exists + try { + await stat(readme); + } catch (ex) { + throw new Error(`Missing README.md in ${dir.name}`); + } + const content = await readFile(readme, "utf8"); + const tokens = marked.lexer(content); + // Ensure there is an h1 and some text, then a code block + + let h1 = false; + let code = false; + let paragraph = false; + + for (const token of tokens) { + if (token.type === "heading" && token.depth === 1) { + h1 = true; + continue; + } + if (h1 && token.type === "heading") { + break; + } + if (token.type === "paragraph") { + paragraph = true; + continue; + } + if (token.type === "code") { + code = true; + continue; + } + } + if (!h1) { + console.error(dir.name, "missing h1") + } + if (!paragraph) { + console.error(dir.name, "missing paragraph after h1") + } + if (!code) { + console.error(dir.name, "missing example code block after paragraph") + } + badExit = true +} + +if (badExit) { + process.exit(1) +} diff --git a/package.json b/package.json index c42b502..9dacc26 100644 --- a/package.json +++ b/package.json @@ -3,10 +3,12 @@ "scripts": { "test": "bun test", "fmt": "bun x prettier -w **/*.ts **/*.md *.md && terraform fmt **/*.tf", - "fmt:ci": "bun x prettier --check **/*.ts **/*.md *.md && terraform fmt -check **/*.tf" + "fmt:ci": "bun x prettier --check **/*.ts **/*.md *.md && terraform fmt -check **/*.tf", + "lint": "bun run lint.ts" }, "devDependencies": { - "bun-types": "^1.0.3" + "bun-types": "^1.0.3", + "marked": "^9.0.3" }, "peerDependencies": { "typescript": "^5.0.0" diff --git a/tsconfig.json b/tsconfig.json index 86140a5..dfa1fff 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -2,6 +2,7 @@ "compilerOptions": { "target": "esnext", "module": "esnext", + "moduleResolution": "nodenext", "types": ["bun-types"] } }