@antelopejs/tooling-configs 0.2.16 → 0.2.18

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.
Files changed (51) hide show
  1. package/README.md +101 -52
  2. package/dist/bin/api-diff.mjs +430 -107
  3. package/dist/bin/body-check.d.mts +1 -0
  4. package/dist/bin/body-check.mjs +344 -0
  5. package/dist/bin/capture.d.mts +1 -0
  6. package/dist/bin/capture.mjs +559 -0
  7. package/dist/bin/check-size.mjs +3 -3
  8. package/dist/bin/checks.mjs +3 -3
  9. package/dist/bin/comment-proof.mjs +4 -3
  10. package/dist/bin/garden.mjs +6 -6
  11. package/dist/bin/ratchet.mjs +316 -10
  12. package/dist/bin/suppressions.mjs +118 -80
  13. package/dist/bin/sync.mjs +554 -153
  14. package/dist/bin/verify.mjs +240 -127
  15. package/dist/capture/index.d.mts +50 -0
  16. package/dist/capture/index.mjs +2 -0
  17. package/dist/{ceilings-BSw9p4YB.mjs → ceilings-B7KayYIG.mjs} +11 -3
  18. package/dist/{checks-BlWDFYio.mjs → checks-CxkSu2E6.mjs} +1 -1
  19. package/dist/{ci-workflow-DIsoEgMd.mjs → ci-workflow-ChW4He0r.mjs} +84 -3
  20. package/dist/{files-2FikHZ9F.mjs → files-DJ0TeaTU.mjs} +11 -5
  21. package/dist/formal/index.d.mts +40 -0
  22. package/dist/formal/index.mjs +205 -0
  23. package/dist/{json-BqvuCkqr.mjs → json-CG2L7YFl.mjs} +12 -8
  24. package/dist/oxc/anti-slop/index.mjs +869 -21
  25. package/dist/oxc/fmt.mjs +1 -1
  26. package/dist/oxc/guardrails/index.d.mts +1 -1
  27. package/dist/oxc/guardrails/index.mjs +736 -4
  28. package/dist/oxc/lint.d.mts +20 -3
  29. package/dist/oxc/lint.mjs +34 -10
  30. package/dist/oxlint-DIV-lLSS.mjs +98 -0
  31. package/dist/{package-Dtjt_lSa.mjs → package-BRTjkzt5.mjs} +29 -3
  32. package/dist/proof-stamp-DDDC0J6l.mjs +279 -0
  33. package/dist/ratchet-BAcLRYuM.mjs +448 -0
  34. package/dist/{renames-BGO4dWJ8.mjs → renames-L2owF5GD.mjs} +2 -2
  35. package/dist/scenes-DZVXkcxS.mjs +104 -0
  36. package/dist/shared-igPpEDpS.mjs +622 -0
  37. package/dist/{size-BVgNbLO6.mjs → size-DBatLT-F.mjs} +4 -4
  38. package/dist/suppression-base-9L8dlMQK.mjs +120 -0
  39. package/dist/suppression-budget-C0SkPO5R.mjs +535 -0
  40. package/dist/{suppressions-BJAngUxo.mjs → suppressions-DM60NkvL.mjs} +180 -18
  41. package/dist/templates-CypDm-j9.mjs +121 -0
  42. package/dist/typescript-CM0LrVP7.mjs +222 -0
  43. package/dist/verify/index.d.mts +6 -1
  44. package/dist/verify/index.mjs +1 -1
  45. package/package.json +31 -5
  46. package/dist/kinds-Bzyyi9yk.mjs +0 -25
  47. package/dist/ratchet-DRdIYwmv.mjs +0 -80
  48. package/dist/shared-CsXIMK3I.mjs +0 -34
  49. package/dist/staged-ratchet-CjoRfZaM.mjs +0 -236
  50. package/dist/suppression-budget-Yyf5_J5l.mjs +0 -283
  51. package/dist/typescript-C54ONh9m.mjs +0 -433
@@ -0,0 +1,622 @@
1
+ import { existsSync, lstatSync, readFileSync, readlinkSync } from "node:fs";
2
+ import { join } from "node:path";
3
+ //#region src/docs/technical-writing-skill.ts
4
+ /** The technical-writing skill, vendored unchanged from Upd4ting/agent-config `claude/skills/technical-writing/SKILL.md` at 4e0a848. */
5
+ const TECHNICAL_WRITING_SKILL = [
6
+ "---",
7
+ "name: technical-writing",
8
+ "description: \"Layered technical-writing standard: Diátaxis structure, Google developer style sentences, STE instruction rules, Global English syntax. Use for /technical-writing or when writing or reviewing docs, RFCs, readmes, PR descriptions, or commit messages.\"",
9
+ "disable-model-invocation: true",
10
+ "---",
11
+ "",
12
+ "# Technical writing",
13
+ "",
14
+ "In Claude Code, read [the Claude Code adapter](../../docs/harness/claude-code.md) once per session before you follow this skill. It maps the Cursor names in pstack skills to Claude Code.",
15
+ "",
16
+ "Write so a tired engineer understands on the first read. Apply all four layers.",
17
+ "",
18
+ "Three rules sit above the layers:",
19
+ "",
20
+ "- **Cut every word that does no work.** If the sentence survives without a word, the word goes. \"In order to\" is \"to\". \"It is important to note that\" is nothing.",
21
+ "- **Use the short, everyday word.** \"Use\", not \"utilize\". \"Help\", not \"facilitate\". \"Do\", not \"perform\". A long word has to buy its length with precision.",
22
+ "- **When a rule makes a sentence worse, fix the sentence another way or leave it alone.** A sentence that follows every rule and sounds like a machine wrote it has failed.",
23
+ "",
24
+ "The codebase is the word list. Write the real symbol, file, flag, or command name, not a synonym or a description of it.",
25
+ "",
26
+ "Don't invent jargon. Use the words a developer would say out loud: \"move\", \"delete\", \"a budget that only decreases\", not \"evacuate\", \"ratchet\", or \"endgame\". A named pattern is fine when the doc says what it means the first time. Propose a new offender and its replacement as an addition to `unslop`'s abstract-metaphor rule in your reply, with the diff. Don't edit that skill.",
27
+ "",
28
+ "## Vary the rhythm",
29
+ "",
30
+ "A doc can obey every layer and still read machine-written: every sentence clipped short, no view anywhere, nothing specific.",
31
+ "",
32
+ "- Mix sentence lengths on purpose. Short sentences land a point. Longer ones carry a fact with its condition or consequence.",
33
+ "- One thought per sentence does not mean one length per sentence. Split the sentence that carries two thoughts. Keep the long sentence that carries one.",
34
+ "- Have a view where the mode allows it. Explanation weighs trade-offs, so say what you make of them instead of listing pros and cons. Reference stays dry.",
35
+ "- Be specific over sterile. Not \"schema changes can cause issues\" but \"a column rename fails the build\".",
36
+ "",
37
+ "## Pick the mode first (Diátaxis)",
38
+ "",
39
+ "One document, one mode. Two questions pick it: does the content inform action (doing) or understanding (thinking), and does it serve learning or work?",
40
+ "",
41
+ "- Action + learning: **tutorial**.",
42
+ "- Action + work: **how-to**.",
43
+ "- Understanding + work: **reference**.",
44
+ "- Understanding + learning: **explanation**.",
45
+ "",
46
+ "Use the compass on a whole document or on one sentence.",
47
+ "",
48
+ "**Tutorial: learning by doing.** The learner's success is your job, not theirs. Open by saying what the learner will build, not what they will \"learn\". Every step produces a visible result, early and often. Tell them what they should see: the expected output, the prompt change, the log line. Cut explanation to one clause and a link. Stay concrete. Write as \"we\", in commands: \"First, do x. Now, do y.\"",
49
+ "",
50
+ "**How-to: steps to a goal.** Solve a problem a person has, not an operation the machine can perform. Assume competence and skip teaching. Action only: no digressions, no background, no completeness for its own sake. Link those instead. Allow forks and judgment: \"If you want x, do y.\" Name the guide by the task: \"How to calibrate the radar array\", not \"Radar array calibration\".",
51
+ "",
52
+ "**Reference: facts for lookup.** Only describe. No instruction, no persuasion, no opinion. Be dry, complete, and sure. State facts, options, limits, and errors with no hedging. Mirror the structure of the thing described, so code and docs can be navigated together. Put material where readers expect it. Generate from code where possible.",
53
+ "",
54
+ "**Explanation: understanding and why.** One bounded topic, readable away from the product. Each title should tolerate an implicit \"About...\" in front. Anchor on a real why question. Give context: design decisions, history, constraints, alternatives. Opinion is allowed here and nowhere else.",
55
+ "",
56
+ "Don't mix modes: no reference tables inside a tutorial, no tutorial hand-holding inside reference, no arguing inside a how-to. Split and link instead.",
57
+ "",
58
+ "## Write sentences to the reader (Google developer style)",
59
+ "",
60
+ "- Talk to the reader as \"you\", in the present tense. \"Will\" only for things that genuinely happen later.",
61
+ "- Say who does what: \"the compiler checks\", not \"is checked\". Passive is fine only when the actor is unknown or beside the point.",
62
+ "- Write instructions as commands: \"Click Submit.\" State facts plainly. Never \"should be done\".",
63
+ "- Put the condition before the instruction: \"To delete the document, click Delete.\"",
64
+ "- Put the common case first. Exceptions after.",
65
+ "- Sound like a knowledgeable friend. No buzzwords, no figurative language, no \"please\" in instructions, and never \"simply\", \"easy\", or \"quickly\" in a procedure. If it were simple, the reader would not be here.",
66
+ "- Don't pre-announce (\"we will soon support...\") and don't start consecutive sentences with the same phrase.",
67
+ "- Link with words that say where the link goes: the page title or a short description. Never \"click here\". Prefer a sentence of context on the page over a link off it.",
68
+ "- Headings carry the point, not just the topic (\"Pick the mode first\", not \"Modes\"). Sentence case. A task heading is a bare verb phrase (\"Create an instance\"). A concept heading is a noun phrase. One h1 per page, no skipped levels.",
69
+ "- Numbered lists for sequences, bullets for everything else. Introduce a list with a complete sentence. Keep items parallel.",
70
+ "- Code goes in code font. UI elements go in bold. Use serial commas. Drop \"etc.\" and say up front that a list is partial.",
71
+ "",
72
+ "## Make statements load one at a time (STE rules)",
73
+ "",
74
+ "- One instruction per sentence. One thought per sentence everywhere else.",
75
+ "- Split instructions longer than about 20 words and other sentences longer than about 25.",
76
+ "- Put the warning or condition before the step it guards: \"If hot oil touches your skin, injuries can occur.\"",
77
+ "- Keep \"the\" and \"a\": \"Remove backup file\" reads two ways. \"Remove the backup file\" reads one.",
78
+ "- Give each word one meaning and one job, then keep it. If \"check\" means inspect, don't also use it for restrain.",
79
+ "- Pick one word per action and stick to it: \"start\", not \"start\" here and \"initiate\" there.",
80
+ "- Write procedures as direct commands, never as narration and never in the passive: \"Install the component\", not \"the component must be installed\".",
81
+ "- Avoid \"-ing\" words where you can.",
82
+ "",
83
+ "## Leave no sentence open to two readings (Global English)",
84
+ "",
85
+ "- Keep words like \"only\" and \"not\" next to the word they change: \"only fails on growth\" and \"fails only on growth\" say different things.",
86
+ "- Break up long noun strings: \"the proto import budget check script\" becomes \"the script that checks the proto-import budget\".",
87
+ "- Make every \"it\", \"they\", and \"this\" point at one obvious thing. Repeat the noun when in doubt. Never use \"this\" or \"which\" to point at a whole clause.",
88
+ "- Don't drop verbs: \"Phase 1 moves the converters and Phase 2 the runtime\" leaves Phase 2 without one. Give it one.",
89
+ "- Keep the small words that show structure, such as \"that\" in \"Ensure that the switch is off\". Never trade clarity for word count.",
90
+ "- Repeat the article in a series when it prevents a misread: \"the client and the host\", not \"the client and host\", when they are two things.",
91
+ "- Say which parts \"and\" or \"or\" joins when a sentence can group two ways. \"Both...and\", \"either...or\", and \"if...then\" are free disambiguators.",
92
+ "- Use periods, not semicolons. Replace an em dash with a new sentence.",
93
+ "- Make text in parentheses a full grammatical unit or its own sentence. Never form plurals with \"(s)\".",
94
+ "- No slashes: write \"a, b, or both\" instead of \"a/b\" or \"and/or\".",
95
+ "- Call each thing by one name, everywhere. A doc that says \"the gate\", \"the ratchet\", and \"the budget check\" for one thing teaches three things. Don't churn what didn't change.",
96
+ "- Skip idioms, colloquialisms, Latin abbreviations, and metaphors.",
97
+ "",
98
+ "## Voice and repo specifics",
99
+ "",
100
+ "- Apply the **unslop** skill to every doc this skill touches. That skill owns the slop-pattern catalog: AI vocabulary, filler, hedging, formatting tells.",
101
+ "- PR descriptions and commit messages are writing too. Every layer except Diátaxis applies to them. A PR body is a briefing that a reviewer can read in under a minute. Do not paste swarm logs, SHA lists, or metric tables. Link them.",
102
+ "- Product UI strings are not documentation. Use your product's copy guidelines for those.",
103
+ "- Write real paths. Make every count or tree claim true at the commit that lands it, and include the command that regenerates it.",
104
+ "",
105
+ "## Worked example",
106
+ "",
107
+ "Before:",
108
+ "",
109
+ "> Configuration of the proto import ratchet budget script parameters is performed via budget.json. Note that it's important to remember that running with --write, which updates the committed budget to reflect the current count, should only be done when lowering it. If exceeded, CI fails.",
110
+ "",
111
+ "After:",
112
+ "",
113
+ "> `budget.mjs` reads the committed budget from `budget.json` and counts the files that import protos. If the count exceeds the budget, CI fails. Run `budget.mjs --write` only to lower the budget."
114
+ ].join("\n") + "\n";
115
+ //#endregion
116
+ //#region src/docs/names.ts
117
+ /**
118
+ * The one list of names the documentation standard knows. The `Names` check
119
+ * derives its substitutions from the misspellings, and the sentence-case
120
+ * heading rule (unslop rule 17) derives its exceptions from every name, so a
121
+ * name added here is accepted capitalized inside a heading and spelled one way
122
+ * everywhere.
123
+ */
124
+ const DOC_NAMES = [
125
+ {
126
+ name: "AntelopeJS",
127
+ misspellings: [
128
+ "Antelope JS",
129
+ "Antelope\\.js",
130
+ "antelopejs",
131
+ "Antelopejs",
132
+ "antelopeJS"
133
+ ]
134
+ },
135
+ { name: "AdonisJS" },
136
+ { name: "AI" },
137
+ { name: "Claude Code" },
138
+ { name: "Claude" },
139
+ { name: "ChatGPT" },
140
+ { name: "Codex" },
141
+ {
142
+ name: "DMS",
143
+ misspellings: ["Dms", "dms"]
144
+ },
145
+ { name: "API" },
146
+ { name: "AQL" },
147
+ { name: "CLI" },
148
+ { name: "CI" },
149
+ { name: "CORS" },
150
+ { name: "HA" },
151
+ { name: "HTTP" },
152
+ { name: "HTTPS" },
153
+ { name: "IP" },
154
+ { name: "JSON" },
155
+ { name: "YAML" },
156
+ { name: "SQL" },
157
+ { name: "TLS" },
158
+ { name: "URL" },
159
+ { name: "PR" },
160
+ { name: "PITR" },
161
+ { name: "3DS" },
162
+ { name: "DEBUG" },
163
+ { name: "TRACE" },
164
+ { name: "README" },
165
+ { name: "Markdown" },
166
+ { name: "TypeScript" },
167
+ { name: "JavaScript" },
168
+ { name: "Node.js" },
169
+ { name: "MongoDB" },
170
+ { name: "PostgreSQL" },
171
+ { name: "RethinkDB" },
172
+ { name: "Redis" },
173
+ { name: "GitHub" },
174
+ { name: "Docker" },
175
+ { name: "Vue" },
176
+ { name: "Nuxt" },
177
+ { name: "Inertia" },
178
+ { name: "Vale" },
179
+ { name: "Playwright" },
180
+ { name: "ESLint" },
181
+ { name: "OpenTelemetry" },
182
+ { name: "WebSocket" },
183
+ { name: "Zod" },
184
+ { name: "Stripe" },
185
+ { name: "Mollie" },
186
+ { name: "Cloud" },
187
+ { name: "Diátaxis" },
188
+ { name: "OAuth" },
189
+ { name: "JWT" },
190
+ { name: "MDC" },
191
+ { name: "TLA+" },
192
+ { name: "npm" },
193
+ { name: "pnpm" }
194
+ ];
195
+ //#endregion
196
+ //#region src/docs/unslop-rules.ts
197
+ /** The sections of the unslop skill, in the order they appear. */
198
+ const UNSLOP_GROUPS = [
199
+ "Content",
200
+ "Language",
201
+ "Style",
202
+ "Communication artifacts",
203
+ "Filler",
204
+ "Jargon",
205
+ "Plain speech"
206
+ ];
207
+ Object.fromEntries(DOC_NAMES.flatMap(({ name, misspellings = [] }) => misspellings.map((wrong) => [wrong, name])));
208
+ /** The numbered rules of the unslop skill. The skill's rule section and the Vale style are generated from this table. */
209
+ const UNSLOP_RULES = [
210
+ {
211
+ id: 3,
212
+ group: "Content",
213
+ text: "**Superficial -ing phrases.** \"highlighting...\", \"ensuring...\", \"reflecting...\", \"showcasing...\", \"fostering...\". Delete or expand with real sources."
214
+ },
215
+ {
216
+ id: 5,
217
+ group: "Content",
218
+ text: "**Vague attributions.** \"Experts believe\", \"Industry reports suggest\", \"Some critics argue\". Name the source or delete."
219
+ },
220
+ {
221
+ id: 7,
222
+ group: "Language",
223
+ text: "**AI vocabulary.** Additionally, crucial, delve, enduring, enhance, fostering, garner, interplay, intricate, landscape (abstract), pivotal, showcase, tapestry (abstract), testament, underscore, vibrant. Replace with plain words.",
224
+ check: {
225
+ kind: "existence",
226
+ message: "Replace the AI vocabulary word '%s' with a plain word (unslop rule 7).",
227
+ ignorecase: true,
228
+ tokens: [
229
+ "additionally",
230
+ "crucial",
231
+ "delve",
232
+ "delves",
233
+ "enduring",
234
+ "enhance",
235
+ "enhances",
236
+ "enhanced",
237
+ "enhancing",
238
+ "fostering",
239
+ "garner",
240
+ "garners",
241
+ "interplay",
242
+ "intricate",
243
+ "pivotal",
244
+ "showcase",
245
+ "showcases",
246
+ "showcasing",
247
+ "testament",
248
+ "underscore",
249
+ "underscores",
250
+ "vibrant"
251
+ ]
252
+ }
253
+ },
254
+ {
255
+ id: 8,
256
+ group: "Language",
257
+ text: "**Fancy ways to say \"is\".** \"serves as\", \"stands as\", \"boasts\", \"features\". Say \"is\" or \"has\".",
258
+ check: {
259
+ kind: "existence",
260
+ message: "Say 'is' or 'has' instead of '%s' (unslop rule 8).",
261
+ ignorecase: true,
262
+ tokens: [
263
+ "serves as",
264
+ "stands as",
265
+ "boasts"
266
+ ]
267
+ }
268
+ },
269
+ {
270
+ id: 9,
271
+ group: "Language",
272
+ text: "**\"Not just X, but Y.\"** State the point directly instead."
273
+ },
274
+ {
275
+ id: 10,
276
+ group: "Language",
277
+ text: "**Rule of three.** Don't force ideas into groups of three. Use the natural number."
278
+ },
279
+ {
280
+ id: 11,
281
+ group: "Language",
282
+ text: "**Synonym cycling.** Protagonist, main character, central figure, hero all in one paragraph. Pick one, repeat it."
283
+ },
284
+ {
285
+ id: 12,
286
+ group: "Language",
287
+ text: "**False ranges.** \"from X to Y\" where X and Y aren't on a meaningful scale. List topics directly."
288
+ },
289
+ {
290
+ id: 13,
291
+ group: "Style",
292
+ text: "**Em dash overuse.** Avoid em dashes entirely. Use periods or commas only (no parentheses, no en dashes, no hyphen-as-dash substitutes). If a thought needs separation, end the sentence or use a comma.",
293
+ check: {
294
+ kind: "existence",
295
+ message: "Use a period or a comma instead of a dash (unslop rule 13).",
296
+ nonword: true,
297
+ tokens: ["—", "–"]
298
+ }
299
+ },
300
+ {
301
+ id: 14,
302
+ group: "Style",
303
+ text: "**Colon overuse.** Colons are fine before a list or example, not as mid-sentence connectors. \"If you're coming from traditional automation: instead of registering event handlers, you describe conditions\" adds nothing with the colon. Rewrite to let the point stand on its own without comparison framing. \"Describing when the scheduler should fire works best as plain English.\" Same meaning, no crutch punctuation."
304
+ },
305
+ {
306
+ id: 15,
307
+ group: "Style",
308
+ text: "**Boldface overuse.** Don't bold every proper noun or acronym."
309
+ },
310
+ {
311
+ id: 16,
312
+ group: "Style",
313
+ text: "**Inline-header lists.** The tell is a bold label and colon that restates the line: \"**Performance:** Performance improved...\". Convert those to prose. A bold lead-in that ends in a period, names the item, and is followed by genuinely new detail (\"**Schema in TypeScript.** Tables live in one file.\") is fine, not a tell."
314
+ },
315
+ {
316
+ id: 17,
317
+ group: "Style",
318
+ text: "**Title case headings.** Use sentence case.",
319
+ check: {
320
+ kind: "capitalization",
321
+ message: "Use sentence case in headings (unslop rule 17).",
322
+ exceptions: DOC_NAMES.map(({ name }) => name)
323
+ }
324
+ },
325
+ {
326
+ id: 18,
327
+ group: "Style",
328
+ text: "**Decorative emojis.** Remove from headings and bullets.",
329
+ check: {
330
+ kind: "existence",
331
+ message: "Remove the decorative emoji (unslop rule 18).",
332
+ nonword: true,
333
+ tokens: ["[\\x{1F300}-\\x{1FAFF}]"]
334
+ }
335
+ },
336
+ {
337
+ id: 19,
338
+ group: "Style",
339
+ text: "**Curly quotes.** Use straight quotes.",
340
+ check: {
341
+ kind: "existence",
342
+ message: "Use a straight quote (unslop rule 19).",
343
+ nonword: true,
344
+ tokens: ["[‘’“”]"]
345
+ }
346
+ },
347
+ {
348
+ id: 20,
349
+ group: "Communication artifacts",
350
+ text: "**Chatbot phrases.** \"I hope this helps!\", \"Let me know if...\", \"Of course!\", \"Certainly!\", \"Found the smoking gun!\" Remove.",
351
+ check: {
352
+ kind: "existence",
353
+ message: "Remove the chatbot phrase '%s' (unslop rule 20).",
354
+ ignorecase: true,
355
+ tokens: [
356
+ "I hope this helps",
357
+ "Let me know if",
358
+ "Of course!",
359
+ "Certainly!"
360
+ ]
361
+ }
362
+ },
363
+ {
364
+ id: 22,
365
+ group: "Communication artifacts",
366
+ text: "**Sycophantic tone.** \"Great question! You're absolutely right!\" Respond directly.",
367
+ check: {
368
+ kind: "existence",
369
+ message: "Answer directly instead of '%s' (unslop rule 22).",
370
+ ignorecase: true,
371
+ tokens: ["Great question", "You're absolutely right"]
372
+ }
373
+ },
374
+ {
375
+ id: 23,
376
+ group: "Filler",
377
+ text: "**Filler phrases.** \"In order to\" becomes \"To\". \"Due to the fact that\" becomes \"Because\". Delete \"It is important to note that\".",
378
+ check: {
379
+ kind: "existence",
380
+ message: "Cut the filler phrase '%s' (unslop rule 23).",
381
+ ignorecase: true,
382
+ tokens: [
383
+ "in order to",
384
+ "due to the fact that",
385
+ "it is important to note that"
386
+ ]
387
+ }
388
+ },
389
+ {
390
+ id: 24,
391
+ group: "Filler",
392
+ text: "**Excessive hedging.** \"could potentially possibly be argued that it might\" becomes \"may\"."
393
+ },
394
+ {
395
+ id: 25,
396
+ group: "Filler",
397
+ text: "**Generic conclusions.** \"The future looks bright.\" State specific plans or facts."
398
+ },
399
+ {
400
+ id: 26,
401
+ group: "Jargon",
402
+ text: "**Abstract metaphor nouns.** Substrate (base), wedge, wedge in (add), vector (way, method), locus, vantage, nexus, primitive as a noun, harness as a metaphor, surface as in \"API surface\", bedrock, scaffolding as a metaphor, modality, paradigm, gold-plating (more than the job needs), ratchet as a metaphor (the mechanism's real name, or a limit that only tightens), evacuate for moving code (move out), endgame (the last phase), north star, flywheel. These read as technical but usually have a plainer concrete word. Pick the concrete word.",
403
+ check: {
404
+ kind: "existence",
405
+ message: "Use the concrete word instead of '%s' (unslop rule 26).",
406
+ ignorecase: true,
407
+ tokens: [
408
+ "substrate",
409
+ "wedge",
410
+ "nexus",
411
+ "locus",
412
+ "vantage",
413
+ "bedrock",
414
+ "north star",
415
+ "flywheel",
416
+ "endgame",
417
+ "paradigm",
418
+ "modality",
419
+ "gold-plating"
420
+ ]
421
+ }
422
+ },
423
+ {
424
+ id: 27,
425
+ group: "Plain speech",
426
+ text: "**Say what it does, not how it feels.** \"the database stays close at hand\", \"SQL you can read\", \"types that follow your schema\" name a feeling. The fix names the mechanism or a number: \"`.toSQL()` returns the exact string sent to the database\", \"a column rename fails the build\". Ask what the sentence tells the reader to do or know, then write that. If you can't restate it as a concrete instruction, fact, or number, cut it. One more check: if the sentence could appear unchanged in another project's docs, it says nothing about this one. Cut it."
427
+ },
428
+ {
429
+ id: 28,
430
+ group: "Plain speech",
431
+ text: "**Shorten or split dense sentences.** If the reader has to backtrack to parse a sentence, break it in two or drop clauses. One idea per sentence."
432
+ },
433
+ {
434
+ id: 29,
435
+ group: "Plain speech",
436
+ text: "**Active voice.** Prefer it. Catch \"is/are/was/were + past participle\" and name the actor: \"queries are validated\" becomes \"the compiler validates queries\", \"the file is parsed by the loader\" becomes \"the loader parses the file\". Passive is fine only when the actor is unknown or genuinely doesn't matter."
437
+ },
438
+ {
439
+ id: 30,
440
+ group: "Plain speech",
441
+ text: "**Cut adverbs, or use a stronger verb.** \"runs quickly\" becomes \"is fast\" or the number, and \"significantly improves\" becomes the measured delta. An adverb propping up a weak verb means the verb is wrong."
442
+ },
443
+ {
444
+ id: 31,
445
+ group: "Plain speech",
446
+ text: "**Prefer the plain word.** \"utilize\" and \"leverage\" become \"use\", \"facilitate\" becomes \"help\", \"numerous\" becomes \"many\", \"in the event that\" becomes \"if\". The fancier synonym is rarely clearer.",
447
+ check: {
448
+ kind: "substitution",
449
+ message: "Use '%s' instead of '%s' (unslop rule 31).",
450
+ ignorecase: true,
451
+ swap: {
452
+ utilize: "use",
453
+ utilizes: "uses",
454
+ utilizing: "using",
455
+ leverage: "use",
456
+ leverages: "uses",
457
+ leveraging: "using",
458
+ facilitate: "help",
459
+ numerous: "many",
460
+ "in the event that": "if"
461
+ }
462
+ }
463
+ },
464
+ {
465
+ id: 32,
466
+ group: "Plain speech",
467
+ text: "**Mannered prose.** Metaphor or flourish where a literal phrase exists: aphorisms (\"wire it or delete it\"), rhetorical fragments for effect, personified code (\"the plan holds it\"), figurative verbs (\"rides along\", \"stands on\"), stock framing phrases. \"A dial worth turning\" becomes \"a parameter worth varying\". Say what you mean. Rule 26 covers the metaphor nouns."
468
+ },
469
+ {
470
+ id: 33,
471
+ group: "Plain speech",
472
+ text: "**Over-compression.** Dropped articles, verbless fragments, symbol-speak, and abbreviations that make the reader decode instead of read. \"Parser rejects bad date → exit 2, no write\" becomes \"The parser rejects a bad date, exits with code 2, and writes nothing.\" Write whole sentences with their articles and verbs, and spell out arrows and abbreviations."
473
+ }
474
+ ];
475
+ `${String.raw`(?s)(?m)^::+[a-z][a-z0-9-]*[^\n]*\n---[ \t]*\n.*?^---[ \t]*$`}`;
476
+ /** The unslop skill's rule section, from its heading to the end of the file. */
477
+ function renderRuleSection(rules) {
478
+ return `## Patterns to detect and fix\n\nRule numbers are stable ids that other skills cite. A removed rule leaves a gap.\n\n${UNSLOP_GROUPS.map((group) => {
479
+ return `### ${group}\n\n${rules.filter((rule) => rule.group === group).map((rule) => `${rule.id}. ${rule.text}`).join("\n")}\n`;
480
+ }).join("\n")}`;
481
+ }
482
+ /** The unslop skill, vendored from Upd4ting/agent-config `claude/skills/unslop/SKILL.md` at 4e0a848. The rule section is rendered from the rules table; a test pins the whole text to the upstream copy. */
483
+ const UNSLOP_SKILL = [
484
+ "---",
485
+ "name: unslop",
486
+ "description: Cut AI tells from any writing.",
487
+ "disable-model-invocation: true",
488
+ "---",
489
+ "",
490
+ "# Unslop",
491
+ "",
492
+ "Edit text to remove AI patterns. Scan for the patterns below, then rewrite. Preserve meaning and match the intended tone."
493
+ ].join("\n") + "\n\n" + renderRuleSection(UNSLOP_RULES);
494
+ //#endregion
495
+ //#region src/guardrails/docs-skills.ts
496
+ /** The writing skills `antelopejs-sync` installs in every managed repository, by folder name. */
497
+ const DOCS_SKILLS = [{
498
+ name: "technical-writing",
499
+ text: TECHNICAL_WRITING_SKILL
500
+ }, {
501
+ name: "unslop",
502
+ text: UNSLOP_SKILL
503
+ }];
504
+ /** The file of a writing skill, relative to the repository root. */
505
+ function docsSkillPath(name) {
506
+ return `.agents/skills/${name}/SKILL.md`;
507
+ }
508
+ /** The `.claude/skills` link that exposes a writing skill to Claude Code. */
509
+ function docsSkillLink(name) {
510
+ return `.claude/skills/${name}`;
511
+ }
512
+ /** Every path under the agent directories that `antelopejs-sync` writes for the writing skills. */
513
+ function docsSkillPaths() {
514
+ return DOCS_SKILLS.flatMap(({ name }) => [docsSkillPath(name), docsSkillLink(name)]);
515
+ }
516
+ /** The changes that bring the vendored writing skills and their Claude links in line with this pack. */
517
+ function planDocsSkills(root) {
518
+ const actions = [];
519
+ const errors = [];
520
+ for (const { name, text } of DOCS_SKILLS) {
521
+ const path = docsSkillPath(name);
522
+ const file = join(root, path);
523
+ if (lstatSync(file, { throwIfNoEntry: false })?.isDirectory()) errors.push(`${path} is a folder. Move it away, then rerun antelopejs-sync.`);
524
+ else if (!existsSync(file) || readFileSync(file, "utf8") !== text) actions.push({
525
+ kind: "write",
526
+ path,
527
+ content: text
528
+ });
529
+ const link = docsSkillLink(name);
530
+ const target = `../../.agents/skills/${name}`;
531
+ const stat = lstatSync(join(root, link), { throwIfNoEntry: false });
532
+ if (stat === void 0) actions.push({
533
+ kind: "link",
534
+ path: link,
535
+ target
536
+ });
537
+ else if (!stat.isSymbolicLink()) errors.push(`${link} is not a symlink. Move it away, then rerun antelopejs-sync.`);
538
+ else if (readlinkSync(join(root, link)) !== target) actions.push({
539
+ kind: "link",
540
+ path: link,
541
+ target
542
+ });
543
+ }
544
+ return {
545
+ actions,
546
+ errors
547
+ };
548
+ }
549
+ //#endregion
550
+ //#region src/verify/kinds.ts
551
+ /** The repository kinds whose verification skill is synced from this pack. */
552
+ const VERIFY_KINDS = [
553
+ "interface",
554
+ "module",
555
+ "template"
556
+ ];
557
+ /** Whether `value` names a shared verification kind. */
558
+ function isVerifyKind(value) {
559
+ return VERIFY_KINDS.some((kind) => kind === value);
560
+ }
561
+ /** The skill folder of a kind, relative to the repository root. */
562
+ function skillFolder(kind) {
563
+ return `.agents/skills/verify-${kind}`;
564
+ }
565
+ /** The `.claude/skills` link that exposes a kind's skill folder to Claude Code. */
566
+ function claudeLink(kind) {
567
+ return `.claude/skills/verify-${kind}`;
568
+ }
569
+ /** Where the link points, relative to the link's own folder. */
570
+ function claudeLinkTarget(kind) {
571
+ return `../../${skillFolder(kind)}`;
572
+ }
573
+ /** The files `antelopejs-sync` writes into a shared skill folder; everything else there is the repository's own. */
574
+ const SYNCED_SKILL_FILES = [
575
+ "SKILL.md",
576
+ "package.json",
577
+ "tsconfig.json"
578
+ ];
579
+ /**
580
+ * Every path under the agent directories that `antelopejs-sync` writes for the shared skills:
581
+ * each kind's synced files and its `.claude/skills` link, which shows the whole folder, repository files included, a second time.
582
+ */
583
+ function syncedAgentPaths() {
584
+ return [...VERIFY_KINDS.flatMap((kind) => [...SYNCED_SKILL_FILES.map((file) => `${skillFolder(kind)}/${file}`), claudeLink(kind)]), ...docsSkillPaths()];
585
+ }
586
+ //#endregion
587
+ //#region src/oxc/shared.ts
588
+ /**
589
+ * Paths every AntelopeJS project generates or vendors, and that no linter should read.
590
+ * `.github/ISSUE_TEMPLATE/**` holds GitHub's legacy issue templates: Markdown with
591
+ * YAML frontmatter saved under a .yml extension, which a YAML formatter cannot parse.
592
+ * `build/**` and `output/**` match only at the repository root: a directory with
593
+ * either name under `src/` or another authored root is source, not build output.
594
+ */
595
+ const IGNORE_PATTERNS = [
596
+ "**/node_modules/**",
597
+ "**/dist/**",
598
+ "**/coverage/**",
599
+ "**/.antelope/**",
600
+ "**/.nuxt/**",
601
+ "**/.output/**",
602
+ "build/**",
603
+ "output/**",
604
+ "**/i18n-registry.generated.ts",
605
+ ".github/ISSUE_TEMPLATE/**"
606
+ ];
607
+ /** Agent tooling directories: assets we install, not source we own. */
608
+ const AGENT_IGNORE_PATTERNS = [
609
+ ".agent/**",
610
+ ".agents/**",
611
+ ".amp/**",
612
+ ".claude/**",
613
+ ".codex/**",
614
+ ".cursor/**",
615
+ ".gemini/**",
616
+ ".opencode/**",
617
+ ".windsurf/**"
618
+ ];
619
+ /** What `antelopejs-sync` writes under the agent directories, from the list it syncs; the repository's own files there stay linted. */
620
+ const SYNCED_AGENT_PATTERNS = syncedAgentPaths().flatMap((path) => [path, `${path}/**`]);
621
+ //#endregion
622
+ export { VERIFY_KINDS as a, isVerifyKind as c, SYNCED_SKILL_FILES as i, skillFolder as l, IGNORE_PATTERNS as n, claudeLink as o, SYNCED_AGENT_PATTERNS as r, claudeLinkTarget as s, AGENT_IGNORE_PATTERNS as t, planDocsSkills as u };
@@ -1,9 +1,9 @@
1
- import "./ceilings-BSw9p4YB.mjs";
2
- import { t as readCarriedCeilings } from "./renames-BGO4dWJ8.mjs";
3
- import { t as authoredSizes } from "./files-2FikHZ9F.mjs";
1
+ import "./ceilings-B7KayYIG.mjs";
2
+ import { t as readCarriedCeilings } from "./renames-L2owF5GD.mjs";
3
+ import { n as authoredSizes, o as isAgentFile } from "./files-DJ0TeaTU.mjs";
4
4
  //#region src/guardrails/size.ts
5
5
  function sizeFailure(file, size, limit) {
6
- return `${file}: ${size} bytes, ${size - limit} bytes over the ${limit}-byte ceiling. Split by responsibility into sibling modules, one cohesive group of exports each; keep the original path re-exporting only if it is a public entry point. Split a test file by behaviour under test, one file per describe. Do not minify, strip whitespace, or move code under an excluded path to pass.`;
6
+ return `${file}: ${size} bytes, ${size - limit} bytes over the ${limit}-byte ceiling. Split by responsibility into sibling modules, one cohesive group of exports each; keep the original path re-exporting only if it is a public entry point. Split a test file by behaviour under test, one file per describe. Do not minify, strip whitespace, or move code under an excluded path to pass.${isAgentFile(file) ? " A repository that began counting its agent files with this release records the ones it already has once, with `antelopejs-ratchet --update`." : ""}`;
7
7
  }
8
8
  function checkSize(root, files, staged = false) {
9
9
  const ceilings = readCarriedCeilings(root, staged);