mirror of
https://github.com/jparkerweb/plan2code.git
synced 2026-11-16 20:45:33 -08:00
Sync upstream into v2.7.0: the git board skill replaces git-commit (ticket-free), and console docs and tests are split up
AI Assisted
This commit is contained in:
1 parent
6114914dd6
commit
f328406bb5
103 files changed
+17636
-9991
No files matched your search
@@ -6,7 +6,9 @@ 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 DOCS = ['README.md', 'docs/index.html', 'QUICK-REFERENCE.md', '.readme/walkthrough.md'];
|
||||
// Docs that carry the install command themselves; the walkthrough links to the README for it.
|
||||
const WITH_INSTALL = new Set(['README.md', 'docs/index.html', 'QUICK-REFERENCE.md']);
|
||||
const EM_DASH = String.fromCharCode(0x2014);
|
||||
|
||||
function read(file) {
|
||||
@@ -28,19 +30,25 @@ function blockOf(file) {
|
||||
|
||||
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.ok(block.includes(needle), `${file} is missing "${needle}" in its "Before you start" block`);
|
||||
}
|
||||
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`);
|
||||
});
|
||||
|
||||
if (!WITH_INSTALL.has(file)) continue;
|
||||
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`);
|
||||
});
|
||||
|
||||
test(`${file} says what a silent install means and how to see why`, () => {
|
||||
const text = read(file);
|
||||
assert.match(text, /no output at all/, `${file} does not say what no output means`);
|
||||
assert.ok(text.includes('git ls-remote https://github.com/jparkerweb/plan2code.git'), `${file} is missing the git ls-remote check`);
|
||||
});
|
||||
}
|
||||
Reference in new issue
Block a user