mirror of
https://github.com/jparkerweb/plan2code.git
synced 2026-11-16 20:45:33 -08:00
Add a Before you start block to the newcomer docs and a test to keep them in step
AI Assisted
This commit is contained in:
1 parent
b639c8945d
commit
3469a74cc1
12 files changed
+117
-25
No files matched your search
@@ -0,0 +1,46 @@
|
||||
// Keeps the "Before you start" guidance identical in meaning across the newcomer docs.
|
||||
import { test } from 'node:test';
|
||||
import assert from 'node:assert/strict';
|
||||
import { readFileSync } from 'node:fs';
|
||||
import { dirname, join } from 'node:path';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
|
||||
const ROOT = join(dirname(fileURLToPath(import.meta.url)), '..');
|
||||
const DOCS = ['README.md', 'docs/index.html', 'QUICK-REFERENCE.md'];
|
||||
const EM_DASH = String.fromCharCode(0x2014);
|
||||
|
||||
function read(file) {
|
||||
return readFileSync(join(ROOT, file), 'utf8');
|
||||
}
|
||||
|
||||
// The first "Before you start" block: from its heading to the next heading (Markdown)
|
||||
// or the end of its container (HTML).
|
||||
function blockOf(file) {
|
||||
const text = read(file);
|
||||
const start = text.search(/^#{2,3} Before you start$|<h3>Before you start<\/h3>/m);
|
||||
assert.ok(start >= 0, `${file} has no "Before you start" block`);
|
||||
const rest = text.slice(start);
|
||||
const body = rest.indexOf('\n') + 1;
|
||||
const next = file.endsWith('.html') ? rest.indexOf('</div>') : rest.slice(body).search(/^#{1,3} /m);
|
||||
const end = file.endsWith('.html') ? next : next < 0 ? -1 : body + next;
|
||||
return end > 0 ? rest.slice(0, end) : rest;
|
||||
}
|
||||
|
||||
for (const file of DOCS) {
|
||||
test(`${file} tells a newcomer how to get started`, () => {
|
||||
const text = read(file);
|
||||
const block = blockOf(file);
|
||||
for (const needle of ['Node.js 18', 'node --version', 'nodejs.org', '/plan2code', '$plan2code']) {
|
||||
assert.ok(text.includes(needle), `${file} is missing "${needle}"`);
|
||||
}
|
||||
assert.match(block, /project you want to (work on|work in)/, `${file} does not say to start from your project`);
|
||||
assert.ok(!block.includes(EM_DASH), `${file} has an em dash in its "Before you start" block`);
|
||||
});
|
||||
|
||||
test(`${file} puts the guidance before the install command`, () => {
|
||||
const text = read(file);
|
||||
const guide = text.indexOf('Before you start');
|
||||
const install = text.indexOf('npx --allow-git');
|
||||
assert.ok(guide >= 0 && install >= 0 && guide < install, `${file}: "Before you start" must come before the npx line`);
|
||||
});
|
||||
}
|
||||
Reference in new issue
Block a user