@jtakeit/kit 0.1.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/bin/jtkit.mjs +17 -0
- package/elements/booking.js +48 -7
- package/lib/booking/render.mjs +39 -5
- package/lib/booking/words.mjs +262 -4
- package/lib/build-codes.mjs +29 -0
- package/lib/catalogue.mjs +50 -10
- package/lib/content.mjs +101 -0
- package/lib/kits.mjs +1 -1
- package/lib/lint.mjs +369 -0
- package/package.json +51 -13
- package/types/booking.d.ts +4 -0
- package/types/content.d.ts +9 -0
- package/types/lint.d.ts +19 -0
package/lib/catalogue.mjs
CHANGED
|
@@ -735,7 +735,35 @@ for (const file of sourceFiles(join(root, 'src'))) {
|
|
|
735
735
|
*/
|
|
736
736
|
|
|
737
737
|
/** The credential, presented the way the admin API reads it. */
|
|
738
|
-
|
|
738
|
+
/**
|
|
739
|
+
* The working tree's other jtk/ files, sent beside the catalogue so the
|
|
740
|
+
* second judge — the settings, the entries, a price table's gaps, an add-on
|
|
741
|
+
* nobody can take — answers in the same call, before any push (core
|
|
742
|
+
* wiki/71 · §3.2). Everything under jtk/ but the catalogue itself, as
|
|
743
|
+
* `{path, text}`; a site with no jtk/ yet sends none.
|
|
744
|
+
* @param {string} root
|
|
745
|
+
* @returns {{ path: string, text: string }[]}
|
|
746
|
+
*/
|
|
747
|
+
export function filesBeside(root) {
|
|
748
|
+
const dir = join(root, 'jtk');
|
|
749
|
+
if (!existsSync(dir)) return [];
|
|
750
|
+
/** @type {{ path: string, text: string }[]} */
|
|
751
|
+
const out = [];
|
|
752
|
+
const walk = (/** @type {string} */ at) => {
|
|
753
|
+
for (const entry of readdirSync(at, { withFileTypes: true })) {
|
|
754
|
+
const full = join(at, entry.name);
|
|
755
|
+
if (entry.isDirectory()) { walk(full); continue; }
|
|
756
|
+
if (!entry.name.endsWith('.json')) continue;
|
|
757
|
+
const rel = relative(root, full).split(sep).join('/');
|
|
758
|
+
if (rel === 'jtk/catalogue.json') continue;
|
|
759
|
+
out.push({ path: rel, text: readFileSync(full, 'utf8') });
|
|
760
|
+
}
|
|
761
|
+
};
|
|
762
|
+
walk(dir);
|
|
763
|
+
return out.sort((a, b) => a.path.localeCompare(b.path));
|
|
764
|
+
}
|
|
765
|
+
|
|
766
|
+
function judgeRequest(text, files) {
|
|
739
767
|
const api = (process.env.JTK_API ?? '').trim().replace(/\/+$/, '');
|
|
740
768
|
const token = (process.env.JTK_TOKEN ?? '').trim();
|
|
741
769
|
return {
|
|
@@ -753,7 +781,7 @@ function judgeRequest(text) {
|
|
|
753
781
|
accept: 'application/json',
|
|
754
782
|
'content-type': 'application/json',
|
|
755
783
|
},
|
|
756
|
-
body: JSON.stringify({ catalogue: text }),
|
|
784
|
+
body: JSON.stringify(files.length > 0 ? { catalogue: text, files } : { catalogue: text }),
|
|
757
785
|
},
|
|
758
786
|
};
|
|
759
787
|
}
|
|
@@ -782,13 +810,14 @@ as a bearer; anything else is taken for the \`sid\` cookie of a person signed in
|
|
|
782
810
|
to the admin. The MCP server itself reads neither variable — it is hosted, and
|
|
783
811
|
an agent connects to it through the browser.
|
|
784
812
|
|
|
785
|
-
An agent with the MCP server needs neither:
|
|
786
|
-
|
|
787
|
-
settings, the content —
|
|
813
|
+
An agent with the MCP server needs neither: \`validate_catalogue\` with the
|
|
814
|
+
catalogue and the jtk/ files beside it judges the whole working tree — this
|
|
815
|
+
catalogue, the settings, the content — before any push, every finding at once.`);
|
|
788
816
|
process.exit(1);
|
|
789
817
|
}
|
|
790
818
|
|
|
791
|
-
const
|
|
819
|
+
const files = filesBeside(root);
|
|
820
|
+
const { url, init } = judgeRequest(text, files);
|
|
792
821
|
|
|
793
822
|
let response;
|
|
794
823
|
try {
|
|
@@ -822,7 +851,18 @@ settings, the content — with the same judge and every finding at once.`);
|
|
|
822
851
|
return 0;
|
|
823
852
|
}
|
|
824
853
|
|
|
825
|
-
const
|
|
854
|
+
const all = verdict.findings ?? [];
|
|
855
|
+
// The files' findings — the settings, an entry, a price table — are the
|
|
856
|
+
// judge's alone, about files this checker never reads: printed as what
|
|
857
|
+
// they are, and not examined. The catalogue's own are the exam.
|
|
858
|
+
const ofFiles = all.filter((one) => /^jtk\//.test(one.path ?? ''));
|
|
859
|
+
const findings = all.filter((one) => !ofFiles.includes(one));
|
|
860
|
+
for (const one of ofFiles) {
|
|
861
|
+
console.error(` ✗ ${one.code} ${one.path}: ${one.says}`);
|
|
862
|
+
}
|
|
863
|
+
if (ofFiles.length > 0) {
|
|
864
|
+
console.error(` ${ofFiles.length} finding(s) in the files beside the catalogue (${files.length} sent) — refused at import until fixed.\n`);
|
|
865
|
+
}
|
|
826
866
|
// Advice is the judge's alone — rules about the bookings module it runs,
|
|
827
867
|
// which this checker has no copy of — so it is printed and not examined.
|
|
828
868
|
const advice = [...(verdict.advice ?? []), ...findings.filter((one) => isAdvice(one.code))];
|
|
@@ -845,10 +885,10 @@ settings, the content — with the same judge and every finding at once.`);
|
|
|
845
885
|
|
|
846
886
|
if (missed.length === 0 && invented.length === 0) {
|
|
847
887
|
console.log(
|
|
848
|
-
`judged by ${url} — contract ${verdict.contract}, ${findings.length} finding(s), ` +
|
|
849
|
-
|
|
888
|
+
`judged by ${url} — contract ${verdict.contract}, ${findings.length} finding(s) in the catalogue, ` +
|
|
889
|
+
`${ofFiles.length} in the ${files.length} file(s) beside it, and this checker said the same of the catalogue`,
|
|
850
890
|
);
|
|
851
|
-
return
|
|
891
|
+
return ofFiles.length;
|
|
852
892
|
}
|
|
853
893
|
|
|
854
894
|
console.error(`\njtk catalogue: the judge and this checker do not agree (contract ${verdict.contract})\n`);
|
package/lib/content.mjs
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The published content as one document, from the files in `jtk/`.
|
|
3
|
+
*
|
|
4
|
+
* The content lives in the repository as one file per page, because that is
|
|
5
|
+
* what makes a diff readable; everything that reads it — the build, the
|
|
6
|
+
* annotation lint — wants one document, because that is what a template
|
|
7
|
+
* renders from. This is the seam between the two, the same one the platform's
|
|
8
|
+
* build runs (`collect-content.mjs`), here so that `jtkit lint` can read a
|
|
9
|
+
* working tree the way the build will. Nothing over the network.
|
|
10
|
+
*/
|
|
11
|
+
import { readFile, readdir } from 'node:fs/promises';
|
|
12
|
+
import { join } from 'node:path';
|
|
13
|
+
|
|
14
|
+
/** @param {string} path */
|
|
15
|
+
async function readJSON(path) {
|
|
16
|
+
try {
|
|
17
|
+
return JSON.parse(await readFile(path, 'utf8'));
|
|
18
|
+
} catch (error) {
|
|
19
|
+
if (error.code === 'ENOENT') return null;
|
|
20
|
+
throw new Error(`${path}: ${error.message}`);
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/** Every content file under a directory, at any depth, sorted. @param {string} root */
|
|
25
|
+
async function contentFiles(root) {
|
|
26
|
+
/** @type {string[]} */
|
|
27
|
+
const found = [];
|
|
28
|
+
async function walk(/** @type {string} */ current) {
|
|
29
|
+
let entries;
|
|
30
|
+
try {
|
|
31
|
+
entries = await readdir(current, { withFileTypes: true });
|
|
32
|
+
} catch (error) {
|
|
33
|
+
if (error.code === 'ENOENT') return;
|
|
34
|
+
throw error;
|
|
35
|
+
}
|
|
36
|
+
for (const entry of entries) {
|
|
37
|
+
const path = join(current, entry.name);
|
|
38
|
+
if (entry.isDirectory()) await walk(path);
|
|
39
|
+
else if (entry.name.endsWith('.json')) found.push(path);
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
await walk(root);
|
|
43
|
+
return found.sort();
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* Which language a shared file is, out of its name: `shared.json` the site's
|
|
48
|
+
* own, `shared.de.json` German; null for a file that is not one.
|
|
49
|
+
* @param {string} name
|
|
50
|
+
*/
|
|
51
|
+
export function sharedLocaleOf(name) {
|
|
52
|
+
const match = /^shared(?:\.([a-z]{2}(?:-[a-z]{2})?))?\.json$/.exec(name);
|
|
53
|
+
return match === null ? null : (match[1] ?? '');
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* The document the build renders from. `jtk/site.json` is what publish writes;
|
|
58
|
+
* a working tree before its first publish has none, and the lint reads it
|
|
59
|
+
* anyway with the site's facts left empty — the annotations do not depend on
|
|
60
|
+
* them.
|
|
61
|
+
* @param {string} root the site's root, holding `jtk/`
|
|
62
|
+
* @param {{ dir?: string }} [options] `dir`: where `jtk/` is, relative to the root
|
|
63
|
+
*/
|
|
64
|
+
export async function collectContent(root, options = {}) {
|
|
65
|
+
const dir = join(root, options.dir ?? 'jtk');
|
|
66
|
+
const site = (await readJSON(join(dir, 'site.json'))) ?? {};
|
|
67
|
+
const pages = [];
|
|
68
|
+
for (const file of await contentFiles(join(dir, 'content'))) {
|
|
69
|
+
const page = await readJSON(file);
|
|
70
|
+
if (page === null) continue;
|
|
71
|
+
if (typeof page.path !== 'string') throw new Error(`${file}: no "path" — cannot tell which page this is`);
|
|
72
|
+
const collected = { path: page.path, seo: page.seo ?? {}, blocks: page.blocks ?? [] };
|
|
73
|
+
if (typeof page.collection === 'string' && page.collection !== '') {
|
|
74
|
+
collected.collection = page.collection;
|
|
75
|
+
collected.visible = page.visible !== false;
|
|
76
|
+
}
|
|
77
|
+
pages.push(collected);
|
|
78
|
+
}
|
|
79
|
+
pages.sort((a, b) => (a.path === '/' ? -1 : b.path === '/' ? 1 : a.path.localeCompare(b.path)));
|
|
80
|
+
|
|
81
|
+
const shared = [];
|
|
82
|
+
for (const name of (await readdir(dir).catch(() => [])).sort()) {
|
|
83
|
+
const locale = sharedLocaleOf(name);
|
|
84
|
+
if (locale === null) continue;
|
|
85
|
+
const file = await readJSON(join(dir, name));
|
|
86
|
+
if (file?.blocks?.length) shared.push({ ...(locale === '' ? {} : { locale }), blocks: file.blocks });
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
return {
|
|
90
|
+
schema_version: site.schema_version ?? 1,
|
|
91
|
+
content_rev: site.content_rev ?? 0,
|
|
92
|
+
site: {
|
|
93
|
+
slug: site.slug ?? '',
|
|
94
|
+
locale: site.locale ?? 'uk',
|
|
95
|
+
media_base: site.media_base ?? '',
|
|
96
|
+
business: site.business ?? {},
|
|
97
|
+
},
|
|
98
|
+
pages,
|
|
99
|
+
...(shared.length > 0 ? { shared } : {}),
|
|
100
|
+
};
|
|
101
|
+
}
|
package/lib/kits.mjs
CHANGED
|
@@ -108,7 +108,7 @@ export function checkKit(kit, from) {
|
|
|
108
108
|
/** The language a kit's words are taken in: the site's, or English where the kit has not got it. */
|
|
109
109
|
export function kitLanguage(locale) {
|
|
110
110
|
const lang = String(locale ?? '').slice(0, 2);
|
|
111
|
-
return ['uk', 'en', 'de'].includes(lang) ? lang : 'en';
|
|
111
|
+
return ['uk', 'en', 'de', 'ru', 'es', 'it', 'pt', 'fr'].includes(lang) ? lang : 'en';
|
|
112
112
|
}
|
|
113
113
|
|
|
114
114
|
/**
|
package/lib/lint.mjs
ADDED
|
@@ -0,0 +1,369 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The annotation lint: the built pages against the content and the catalogue.
|
|
3
|
+
*
|
|
4
|
+
* «Every content field carries data-jtk-path» is not a convention — it is a
|
|
5
|
+
* gate. An element that loses its annotation breaks the visual editor
|
|
6
|
+
* SILENTLY: the sheet stops opening when the client taps that heading, and
|
|
7
|
+
* nobody finds out for a week. The lint compares two things it did not write
|
|
8
|
+
* — the content and the HTML the site produced — never the component source,
|
|
9
|
+
* so it works with any template, including one an agent wrote this afternoon.
|
|
10
|
+
*
|
|
11
|
+
* The platform's build runs this lint on every demo build. It is here so that
|
|
12
|
+
* a site can run it on its own `dist/` before any push (`jtkit lint`, core
|
|
13
|
+
* wiki/71 · §3.2): the same checks, the same codes, the same sentences, and
|
|
14
|
+
* every finding at once rather than one build round each.
|
|
15
|
+
*
|
|
16
|
+
* `lint()` returns findings rather than printing and exiting, so a script, a
|
|
17
|
+
* test and the build can each do what they do with them. The order and the
|
|
18
|
+
* early stops are the build's: a page that says noindex stops the lint, as it
|
|
19
|
+
* stops the build.
|
|
20
|
+
*/
|
|
21
|
+
import { readFile, readdir } from 'node:fs/promises';
|
|
22
|
+
import { join, relative } from 'node:path';
|
|
23
|
+
import { CODES, said } from './build-codes.mjs';
|
|
24
|
+
import { collectContent } from './content.mjs';
|
|
25
|
+
|
|
26
|
+
export { CODES, said };
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* The kinds a person edits by tapping the thing itself. A URL, a boolean or
|
|
30
|
+
* an alt text is edited in the panel beside it, so requiring an annotated
|
|
31
|
+
* element for those would fail every honest template.
|
|
32
|
+
*/
|
|
33
|
+
export const TAPPABLE = new Set(['text', 'textarea', 'richtext_lite', 'markdown', 'media']);
|
|
34
|
+
|
|
35
|
+
/** @param {any} field */
|
|
36
|
+
function tappable(field) {
|
|
37
|
+
if (!TAPPABLE.has(field.kind)) return false;
|
|
38
|
+
if (field.client_editable === false) return false;
|
|
39
|
+
if (field.no_tap_target === true) return false;
|
|
40
|
+
return true;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
/** @param {string} url */
|
|
44
|
+
function hostOf(url) {
|
|
45
|
+
try {
|
|
46
|
+
return new URL(url).host.toLowerCase();
|
|
47
|
+
} catch {
|
|
48
|
+
return '';
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/** A robots.txt whose `User-agent: *` group says `Disallow: /` and nothing narrower. @param {string} text */
|
|
53
|
+
function disallowsEverybody(text) {
|
|
54
|
+
let everybody = false;
|
|
55
|
+
for (const raw of text.split(/\r?\n/)) {
|
|
56
|
+
const line = raw.replace(/#.*$/, '').trim();
|
|
57
|
+
if (line === '') continue;
|
|
58
|
+
const [key, ...rest] = line.split(':');
|
|
59
|
+
const value = rest.join(':').trim();
|
|
60
|
+
if (key.trim().toLowerCase() === 'user-agent') everybody = value === '*';
|
|
61
|
+
else if (everybody && key.trim().toLowerCase() === 'disallow' && value === '/') return true;
|
|
62
|
+
}
|
|
63
|
+
return false;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
/** @param {string} path */
|
|
67
|
+
async function readOrEmpty(path) {
|
|
68
|
+
try {
|
|
69
|
+
return await readFile(path, 'utf8');
|
|
70
|
+
} catch {
|
|
71
|
+
return '';
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
/** @param {string} dir */
|
|
76
|
+
async function htmlFiles(dir) {
|
|
77
|
+
/** @type {string[]} */
|
|
78
|
+
const out = [];
|
|
79
|
+
let entries;
|
|
80
|
+
try {
|
|
81
|
+
entries = await readdir(dir, { withFileTypes: true });
|
|
82
|
+
} catch {
|
|
83
|
+
return out;
|
|
84
|
+
}
|
|
85
|
+
for (const entry of entries) {
|
|
86
|
+
const path = join(dir, entry.name);
|
|
87
|
+
if (entry.isDirectory()) out.push(...(await htmlFiles(path)));
|
|
88
|
+
else if (entry.name.endsWith('.html')) out.push(path);
|
|
89
|
+
}
|
|
90
|
+
return out;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
/** Every path a built page is expected to carry, for one page's blocks. */
|
|
94
|
+
export function expectedPaths(blocks, typeOf) {
|
|
95
|
+
/** @type {string[]} */
|
|
96
|
+
const paths = [];
|
|
97
|
+
blocks.forEach((block, index) => {
|
|
98
|
+
const blockType = typeOf(block.type);
|
|
99
|
+
if (blockType === undefined) return;
|
|
100
|
+
for (const field of blockType.fields ?? []) {
|
|
101
|
+
const value = block[field.key];
|
|
102
|
+
if (value === undefined || value === null || value === '') continue;
|
|
103
|
+
if (field.kind === 'media' && field.multiple === true) {
|
|
104
|
+
if (!Array.isArray(value) || !tappable(field)) continue;
|
|
105
|
+
value.forEach((item, itemIndex) => {
|
|
106
|
+
if (item === null || typeof item !== 'object' || !item.src) return;
|
|
107
|
+
paths.push(`blocks[${index}].${field.key}[${itemIndex}].src`);
|
|
108
|
+
});
|
|
109
|
+
continue;
|
|
110
|
+
}
|
|
111
|
+
if (field.kind === 'list') {
|
|
112
|
+
if (!Array.isArray(value)) continue;
|
|
113
|
+
value.forEach((item, itemIndex) => {
|
|
114
|
+
for (const sub of field.of ?? []) {
|
|
115
|
+
const subValue = item[sub.key];
|
|
116
|
+
if (!tappable(sub)) continue;
|
|
117
|
+
if (subValue === undefined || subValue === null || subValue === '') continue;
|
|
118
|
+
paths.push(`blocks[${index}].${field.key}[${itemIndex}].${sub.key}`);
|
|
119
|
+
}
|
|
120
|
+
});
|
|
121
|
+
continue;
|
|
122
|
+
}
|
|
123
|
+
if (tappable(field)) paths.push(`blocks[${index}].${field.key}`);
|
|
124
|
+
}
|
|
125
|
+
});
|
|
126
|
+
return paths;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
/** Every form on the page that posts to the platform's enquiry endpoint. @param {string} html */
|
|
130
|
+
function leadForms(html) {
|
|
131
|
+
const out = [];
|
|
132
|
+
for (const [form] of html.matchAll(/<form\b[^>]*>[\s\S]*?<\/form>/gi)) {
|
|
133
|
+
const action = attrOf(form.slice(0, form.indexOf('>') + 1), 'action') ?? '';
|
|
134
|
+
if (/(^|\/)api\/lead\/?(\?|#|$)/.test(action)) out.push(form);
|
|
135
|
+
}
|
|
136
|
+
return out;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
/** The names of a form's controls, buttons left out. @param {string} form */
|
|
140
|
+
function controlsOf(form) {
|
|
141
|
+
const names = new Set();
|
|
142
|
+
for (const [tag] of form.matchAll(/<(?:input|select|textarea)\b[^>]*>/gi)) {
|
|
143
|
+
const type = (attrOf(tag, 'type') ?? '').toLowerCase();
|
|
144
|
+
if (type === 'submit' || type === 'button' || type === 'reset' || type === 'image') continue;
|
|
145
|
+
const name = attrOf(tag, 'name');
|
|
146
|
+
if (name !== undefined && name !== '') names.add(name);
|
|
147
|
+
}
|
|
148
|
+
return names;
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
/** @param {string} tag @param {string} name */
|
|
152
|
+
function attrOf(tag, name) {
|
|
153
|
+
const quoted = new RegExp(`\\s${name}\\s*=\\s*(?:"([^"]*)"|'([^']*)'|([^\\s>]+))`, 'i').exec(tag);
|
|
154
|
+
if (quoted === null) return undefined;
|
|
155
|
+
return quoted[1] ?? quoted[2] ?? quoted[3];
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
/**
|
|
159
|
+
* Whether a block collects enquiries — as the API judges it, not only as the
|
|
160
|
+
* file says: a catalogue written before `collects` existed says nothing, and
|
|
161
|
+
* a block with a `form` switch is one that can put a form on the page.
|
|
162
|
+
* @param {any} blockType
|
|
163
|
+
*/
|
|
164
|
+
function collectsEnquiry(blockType) {
|
|
165
|
+
if (blockType === undefined) return false;
|
|
166
|
+
if (blockType.collects === 'enquiry') return true;
|
|
167
|
+
if (blockType.collects !== undefined && blockType.collects !== '') return false;
|
|
168
|
+
return (blockType.fields ?? []).some((field) => field.key === 'form' && field.kind === 'bool');
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
const OWN_CONTROLS = new Set(['name', 'phone', 'email', 'contact', 'message', 'website']);
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* @typedef {{ code: string, says: string }} Finding
|
|
175
|
+
* @typedef {{ findings: Finding[], ok: boolean, pages: number, shared: boolean, line: string }} Verdict
|
|
176
|
+
*/
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Lint a built site.
|
|
180
|
+
*
|
|
181
|
+
* @param {object} options
|
|
182
|
+
* @param {string} [options.root] the site's root, holding `jtk/` — the working directory by default
|
|
183
|
+
* @param {string} [options.dist] the built pages — `dist` under the root by default
|
|
184
|
+
* @param {string} [options.siteURL] the address the build is for (`SITE_URL`); empty skips the host checks
|
|
185
|
+
* @param {any} [options.catalogue] the catalogue, read from `jtk/catalogue.json` when left out
|
|
186
|
+
* @param {any} [options.content] the content document, collected from `jtk/` when left out
|
|
187
|
+
* @returns {Promise<Verdict>}
|
|
188
|
+
*/
|
|
189
|
+
export async function lint(options = {}) {
|
|
190
|
+
const root = options.root ?? process.cwd();
|
|
191
|
+
const distDir = options.dist ?? join(root, 'dist');
|
|
192
|
+
/** @type {Finding[]} */
|
|
193
|
+
const findings = [];
|
|
194
|
+
const fault = (code, says) => findings.push({ code, says });
|
|
195
|
+
const verdict = (line = '') => ({ findings, ok: findings.length === 0, pages: 0, shared: false, line });
|
|
196
|
+
|
|
197
|
+
// The catalogue: refused rather than skipped when missing. A lint that
|
|
198
|
+
// quietly passes when it cannot find its catalogue is worse than no lint.
|
|
199
|
+
let registry = options.catalogue;
|
|
200
|
+
if (registry === undefined) {
|
|
201
|
+
const file = join(root, 'jtk', 'catalogue.json');
|
|
202
|
+
try {
|
|
203
|
+
registry = JSON.parse(await readFile(file, 'utf8'));
|
|
204
|
+
} catch (error) {
|
|
205
|
+
if (error.code !== 'ENOENT') throw new Error(`could not read ${file}: ${error.message}`);
|
|
206
|
+
fault(CODES.CATALOGUE_MISSING, `no jtk/catalogue.json — this site has no block catalogue, so nothing can check that its content is annotated`);
|
|
207
|
+
return verdict();
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
const typeOf = (name) => registry?.blocks?.find((block) => block.type === name);
|
|
211
|
+
const content = options.content ?? (await collectContent(root));
|
|
212
|
+
|
|
213
|
+
// What every build promises search engines, read off the files themselves.
|
|
214
|
+
{
|
|
215
|
+
const host = hostOf(options.siteURL ?? '');
|
|
216
|
+
const front = await readOrEmpty(join(distDir, 'index.html'));
|
|
217
|
+
if (/<meta[^>]+name=["']robots["'][^>]*noindex/i.test(front) || /<meta[^>]+content=["'][^"']*noindex[^"']*["'][^>]*name=["']robots["']/i.test(front)) {
|
|
218
|
+
fault(CODES.NOINDEX, "the front page says noindex — nothing in a page decides whether it is indexed; the edge keeps a preview out of the index, and a build is always made for the site's address");
|
|
219
|
+
return verdict();
|
|
220
|
+
}
|
|
221
|
+
if (disallowsEverybody(await readOrEmpty(join(distDir, 'robots.txt')))) {
|
|
222
|
+
fault(CODES.ROBOTS_DISALLOW, 'robots.txt says Disallow: / for every crawler');
|
|
223
|
+
return verdict();
|
|
224
|
+
}
|
|
225
|
+
const sitemap = await readOrEmpty(join(distDir, 'sitemap.xml'));
|
|
226
|
+
if (sitemap !== '') {
|
|
227
|
+
const locs = [...sitemap.matchAll(/<loc>\s*([^<\s]+)\s*<\/loc>/g)].map((m) => m[1]);
|
|
228
|
+
const foreign = host === '' ? [] : locs.filter((loc) => hostOf(loc) !== host);
|
|
229
|
+
if (locs.length === 0 || foreign.length > 0) {
|
|
230
|
+
fault(CODES.SITEMAP_EMPTY, locs.length === 0 ? 'sitemap.xml lists no pages' : `sitemap.xml lists pages on ${hostOf(foreign[0])}, and this build is for ${host} (SITE_URL)`);
|
|
231
|
+
return verdict();
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
const canonical = /<link[^>]+rel=["']canonical["'][^>]*href=["']([^"']+)["']/i.exec(front)?.[1] ?? /<link[^>]+href=["']([^"']+)["'][^>]*rel=["']canonical["']/i.exec(front)?.[1];
|
|
235
|
+
if (host !== '' && canonical !== undefined && hostOf(canonical) !== '' && hostOf(canonical) !== host) {
|
|
236
|
+
fault(CODES.CANONICAL_ELSEWHERE, `the front page's canonical is on ${hostOf(canonical)}, and this build is for ${host} (SITE_URL)`);
|
|
237
|
+
return verdict();
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
const htmlByPath = new Map();
|
|
242
|
+
for (const file of await htmlFiles(distDir)) {
|
|
243
|
+
const rel = '/' + relative(distDir, file).replaceAll('\\', '/');
|
|
244
|
+
htmlByPath.set(rel.replace(/\/index\.html$/, '').replace(/\.html$/, '') || '/', await readFile(file, 'utf8'));
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
// The form against the contract of an enquiry.
|
|
248
|
+
const sharedBlocks = (content.shared ?? []).flatMap((document) => document.blocks ?? []);
|
|
249
|
+
const siteCollects = (registry?.blocks ?? []).some(collectsEnquiry);
|
|
250
|
+
const pageByPath = new Map((content.pages ?? []).map((page) => [page.path, page]));
|
|
251
|
+
const asksOf = (blocks) => {
|
|
252
|
+
const keys = new Set();
|
|
253
|
+
for (const block of blocks) {
|
|
254
|
+
const blockType = typeOf(block.type);
|
|
255
|
+
if (!collectsEnquiry(blockType)) continue;
|
|
256
|
+
for (const ask of blockType.asks ?? []) keys.add(ask.key);
|
|
257
|
+
}
|
|
258
|
+
return keys;
|
|
259
|
+
};
|
|
260
|
+
let formFaults = 0;
|
|
261
|
+
for (const [where, html] of htmlByPath) {
|
|
262
|
+
for (const form of leadForms(html)) {
|
|
263
|
+
const controls = controlsOf(form);
|
|
264
|
+
const page = pageByPath.get(where);
|
|
265
|
+
const near = [...(page?.blocks ?? []), ...sharedBlocks];
|
|
266
|
+
const nearCollects = near.some((block) => collectsEnquiry(typeOf(block.type)));
|
|
267
|
+
if (!nearCollects && !siteCollects) {
|
|
268
|
+
fault(CODES.FORM_UNDECLARED, `${where}: a form posts to /api/lead and no block says collects: "enquiry"`);
|
|
269
|
+
formFaults++;
|
|
270
|
+
continue;
|
|
271
|
+
}
|
|
272
|
+
const asks = nearCollects ? asksOf(near) : asksOf((registry?.blocks ?? []).map((block) => ({ type: block.type })));
|
|
273
|
+
const lacking = [];
|
|
274
|
+
if (!controls.has('name')) lacking.push('a name control');
|
|
275
|
+
if (!controls.has('contact') && !controls.has('phone') && !controls.has('email')) lacking.push('a contact, phone or email control');
|
|
276
|
+
if (!controls.has('website')) lacking.push('the honeypot website');
|
|
277
|
+
if (lacking.length > 0) {
|
|
278
|
+
fault(CODES.FORM_INCOMPLETE, `${where}: the enquiry form has no ${lacking.join(', no ')}`);
|
|
279
|
+
formFaults++;
|
|
280
|
+
}
|
|
281
|
+
for (const control of controls) {
|
|
282
|
+
if (OWN_CONTROLS.has(control) || asks.has(control)) continue;
|
|
283
|
+
fault(CODES.FORM_FIELD_UNDECLARED, `${where}: the enquiry form asks for "${control}" and no block declares it in asks — the inbox would show a key, not a label`);
|
|
284
|
+
formFaults++;
|
|
285
|
+
}
|
|
286
|
+
}
|
|
287
|
+
}
|
|
288
|
+
if (formFaults > 0) return verdict(`${formFaults} enquiry form fault(s)`);
|
|
289
|
+
|
|
290
|
+
// The text that is on every page: a shared field the whole site annotates nowhere.
|
|
291
|
+
for (const document of content.shared ?? []) {
|
|
292
|
+
const language = document.locale === undefined ? '' : ` (${document.locale})`;
|
|
293
|
+
for (const path of expectedPaths(document.blocks ?? [], typeOf)) {
|
|
294
|
+
const shared = `shared:${path}`;
|
|
295
|
+
if (![...htmlByPath.values()].some((html) => html.includes(`data-jtk-path="${shared}"`))) {
|
|
296
|
+
fault(CODES.SHARED_NOT_RENDERED, `${shared}${language} is on no page — a shared field nothing renders is a control that edits nothing`);
|
|
297
|
+
}
|
|
298
|
+
}
|
|
299
|
+
}
|
|
300
|
+
|
|
301
|
+
// Entries of a collection without pages: on their listing, annotated there.
|
|
302
|
+
const pageless = new Set((registry?.collections ?? []).filter((one) => one.pages === false).map((one) => one.name));
|
|
303
|
+
const everywhere = [...htmlByPath.values()].join('\n');
|
|
304
|
+
const listable = (page) => page.visible !== false;
|
|
305
|
+
for (const one of registry?.collections ?? []) {
|
|
306
|
+
if (one.pages !== false) continue;
|
|
307
|
+
const hasEntries = (content.pages ?? []).some((page) => page.collection === one.name && listable(page));
|
|
308
|
+
if (hasEntries && !htmlByPath.has(one.prefix)) {
|
|
309
|
+
fault(CODES.PAGE_NOT_BUILT, `${one.prefix}: the collection "${one.name}" has no pages of its own and lists its entries here, and the build did not produce this page — make the prefix the page that lists them, or build one there`);
|
|
310
|
+
}
|
|
311
|
+
}
|
|
312
|
+
for (const page of content.pages ?? []) {
|
|
313
|
+
if (page.collection !== undefined && pageless.has(page.collection)) {
|
|
314
|
+
if (!listable(page)) continue;
|
|
315
|
+
for (const path of expectedPaths(page.blocks ?? [], typeOf)) {
|
|
316
|
+
if (!everywhere.includes(`data-jtk-path="page:${page.path}:${path}"`)) {
|
|
317
|
+
fault(CODES.UNANNOTATED_FIELD, `${page.path}: ${path} is on no page — an entry without a page of its own has to be annotated on its listing`);
|
|
318
|
+
}
|
|
319
|
+
}
|
|
320
|
+
continue;
|
|
321
|
+
}
|
|
322
|
+
const html = htmlByPath.get(page.path);
|
|
323
|
+
if (html === undefined) {
|
|
324
|
+
const listedOnly = (registry?.collections ?? []).find((one) => one.pages === false && page.path.startsWith(`${one.prefix}/`));
|
|
325
|
+
const hint = page.collection === undefined && listedOnly !== undefined
|
|
326
|
+
? ` — it sits under the "${listedOnly.name}" collection's prefix and names no collection; an entry says "collection": "${listedOnly.name}" and is annotated on the listing instead`
|
|
327
|
+
: '';
|
|
328
|
+
fault(CODES.PAGE_NOT_BUILT, `${page.path}: the content has this page and the build did not produce it${hint}`);
|
|
329
|
+
continue;
|
|
330
|
+
}
|
|
331
|
+
for (const path of expectedPaths(page.blocks ?? [], typeOf)) {
|
|
332
|
+
if (!html.includes(`data-jtk-path="${path}"`)) fault(CODES.UNANNOTATED_FIELD, `${page.path}: ${path} is not annotated`);
|
|
333
|
+
}
|
|
334
|
+
}
|
|
335
|
+
|
|
336
|
+
// A tile that names a page nobody has, or a field that page has not got.
|
|
337
|
+
const CROSS = /data-jtk-path="page:([^:"]*):([^"]+)"/g;
|
|
338
|
+
for (const [where, html] of htmlByPath) {
|
|
339
|
+
for (const [, address, inner] of html.matchAll(CROSS)) {
|
|
340
|
+
const named = pageByPath.get(address);
|
|
341
|
+
if (named === undefined) {
|
|
342
|
+
fault(CODES.ANNOTATION_UNKNOWN, `${where}: annotates page:${address}: and this site has no such page`);
|
|
343
|
+
continue;
|
|
344
|
+
}
|
|
345
|
+
if (!expectedPaths(named.blocks ?? [], typeOf).includes(inner)) {
|
|
346
|
+
fault(CODES.ANNOTATION_UNKNOWN, `${where}: annotates ${inner} on ${address}, which that page's document has no field for`);
|
|
347
|
+
}
|
|
348
|
+
}
|
|
349
|
+
}
|
|
350
|
+
|
|
351
|
+
const withShared = content.shared === undefined ? '' : ' and the shared text';
|
|
352
|
+
const out = verdict(findings.length > 0
|
|
353
|
+
? `${findings.length} unannotated field(s) — the visual editor would silently stop working on them`
|
|
354
|
+
: `every content field on ${content.pages?.length ?? 0} page(s)${withShared} is annotated`);
|
|
355
|
+
out.pages = content.pages?.length ?? 0;
|
|
356
|
+
out.shared = content.shared !== undefined;
|
|
357
|
+
return out;
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
/**
|
|
361
|
+
* The command: print the findings the way the build does, and exit 1 on any.
|
|
362
|
+
* @param {{ root?: string, dist?: string, siteURL?: string }} options
|
|
363
|
+
*/
|
|
364
|
+
export async function lintCommand(options) {
|
|
365
|
+
const out = await lint(options);
|
|
366
|
+
for (const one of out.findings) console.error(' ' + said(one.code, one.says));
|
|
367
|
+
if (out.line !== '') (out.ok ? console.log : console.error)(' ' + out.line);
|
|
368
|
+
return out.ok ? 0 : 1;
|
|
369
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jtakeit/kit",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"description": "The framework-free half of a site on jtakeit: the booking form as an element and as markup, for Astro through @jtakeit/astro and for any other generator directly",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -8,20 +8,58 @@
|
|
|
8
8
|
"jtkit": "bin/jtkit.mjs"
|
|
9
9
|
},
|
|
10
10
|
"exports": {
|
|
11
|
-
".": {
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
"./
|
|
16
|
-
|
|
17
|
-
|
|
11
|
+
".": {
|
|
12
|
+
"types": "./types/index.d.ts",
|
|
13
|
+
"default": "./index.mjs"
|
|
14
|
+
},
|
|
15
|
+
"./booking": {
|
|
16
|
+
"types": "./types/booking.d.ts",
|
|
17
|
+
"default": "./lib/booking/render.mjs"
|
|
18
|
+
},
|
|
19
|
+
"./booking/words": {
|
|
20
|
+
"types": "./types/words.d.ts",
|
|
21
|
+
"default": "./lib/booking/words.mjs"
|
|
22
|
+
},
|
|
23
|
+
"./lead": {
|
|
24
|
+
"types": "./types/lead.d.ts",
|
|
25
|
+
"default": "./lib/lead/render.mjs"
|
|
26
|
+
},
|
|
27
|
+
"./money": {
|
|
28
|
+
"types": "./types/money.d.ts",
|
|
29
|
+
"default": "./lib/money.mjs"
|
|
30
|
+
},
|
|
31
|
+
"./meta": {
|
|
32
|
+
"types": "./types/meta.d.ts",
|
|
33
|
+
"default": "./lib/meta.mjs"
|
|
34
|
+
},
|
|
35
|
+
"./kits": {
|
|
36
|
+
"types": "./types/kits.d.ts",
|
|
37
|
+
"default": "./lib/kits.mjs"
|
|
38
|
+
},
|
|
18
39
|
"./catalogue": "./lib/catalogue.mjs",
|
|
19
40
|
"./codes": "./lib/codes.mjs",
|
|
20
|
-
"./elements/booking": {
|
|
21
|
-
|
|
22
|
-
|
|
41
|
+
"./elements/booking": {
|
|
42
|
+
"types": "./types/elements-booking.d.ts",
|
|
43
|
+
"default": "./elements/booking.js"
|
|
44
|
+
},
|
|
45
|
+
"./elements/lead": {
|
|
46
|
+
"types": "./types/elements-lead.d.ts",
|
|
47
|
+
"default": "./elements/lead.js"
|
|
48
|
+
},
|
|
49
|
+
"./elements/alive": {
|
|
50
|
+
"types": "./types/alive.d.ts",
|
|
51
|
+
"default": "./elements/alive.js"
|
|
52
|
+
},
|
|
23
53
|
"./booking.css": "./booking.css",
|
|
24
|
-
"./lead.css": "./lead.css"
|
|
54
|
+
"./lead.css": "./lead.css",
|
|
55
|
+
"./lint": {
|
|
56
|
+
"types": "./types/lint.d.ts",
|
|
57
|
+
"default": "./lib/lint.mjs"
|
|
58
|
+
},
|
|
59
|
+
"./content": {
|
|
60
|
+
"types": "./types/content.d.ts",
|
|
61
|
+
"default": "./lib/content.mjs"
|
|
62
|
+
}
|
|
25
63
|
},
|
|
26
64
|
"files": [
|
|
27
65
|
"index.mjs",
|
|
@@ -38,7 +76,7 @@
|
|
|
38
76
|
},
|
|
39
77
|
"repository": {
|
|
40
78
|
"type": "git",
|
|
41
|
-
"url": "https://github.com/jtakeit/
|
|
79
|
+
"url": "https://github.com/jtakeit/jtakeit-kit.git",
|
|
42
80
|
"directory": "kit"
|
|
43
81
|
},
|
|
44
82
|
"keywords": [
|
package/types/booking.d.ts
CHANGED
|
@@ -3,6 +3,10 @@ export interface Named {
|
|
|
3
3
|
title: string;
|
|
4
4
|
takes?: number;
|
|
5
5
|
costs?: number;
|
|
6
|
+
/** A price by the hour of the week instead of `costs`: rows of a day, a span and a price. The list says «from …»; the price is the slot's. */
|
|
7
|
+
rates?: { day: string; from: number; until: number; costs: number }[];
|
|
8
|
+
/** `'person'` for a price times the party — a class per place, shoes; the list says so and the running total multiplies. */
|
|
9
|
+
per?: 'booking' | 'person';
|
|
6
10
|
group?: string;
|
|
7
11
|
}
|
|
8
12
|
|