@7n/rules 1.25.1 → 1.27.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/CHANGELOG.md +20 -0
- package/bin/n-rules.js +16 -1
- package/package.json +2 -1
- package/rules/doc-files/docgen-crc/docs/main.md +1 -1
- package/rules/doc-files/docgen-crc/main.mjs +5 -12
- package/rules/doc-files/docgen-gen/docs/main.md +1 -1
- package/rules/doc-files/docgen-gen/main.mjs +12 -4
- package/rules/doc-files/docgen-scan/docs/main.md +2 -2
- package/rules/doc-files/docgen-scan/main.mjs +6 -13
- package/rules/js/eslint/concern.json +1 -0
- package/schemas/concern.json +4 -0
- package/scripts/lib/concern-meta.mjs +14 -1
- package/scripts/lib/docs/concern-meta.md +3 -6
- package/scripts/lib/docs/plugin-api.md +1 -2
- package/scripts/lib/docs/resolve-plugins.md +1 -1
- package/scripts/lib/lint-surface/docs/ladder.md +3 -5
- package/scripts/lib/lint-surface/docs/run-fix.md +3 -2
- package/scripts/lib/lint-surface/ladder.mjs +18 -9
- package/scripts/lib/lint-surface/run-fix.mjs +15 -2
- package/scripts/lib/plugin-api.mjs +33 -4
- package/scripts/lib/resolve-plugins.mjs +2 -1
- package/scripts/utils/docs/test-helpers.md +2 -1
- package/skills/doc-files/SKILL.md +1 -1
- package/skills/taze/SKILL.md +31 -79
- package/skills/taze/js/docs/orchestrate.md +9 -12
- package/skills/taze/js/orchestrate.mjs +25 -153
- package/rules/doc-files/docgen-extract/concern.json +0 -3
- package/rules/doc-files/docgen-extract/docs/main.md +0 -38
- package/rules/doc-files/docgen-extract/main.mjs +0 -275
- package/rules/doc-files/units/concern.json +0 -3
- package/rules/doc-files/units/docs/main.md +0 -31
- package/rules/doc-files/units/main.mjs +0 -19
- package/rules/doc-files/units-js/concern.json +0 -3
- package/rules/doc-files/units-js/docs/main.md +0 -32
- package/rules/doc-files/units-js/main.mjs +0 -141
- package/skills/taze/js/diff.mjs +0 -140
- package/skills/taze/js/docs/diff.md +0 -55
|
@@ -1,275 +0,0 @@
|
|
|
1
|
-
/** @see ./docs/docgen-extract.md */
|
|
2
|
-
|
|
3
|
-
import { isRunAsCli } from '../../../scripts/cli-entry.mjs'
|
|
4
|
-
import { readFileSync } from 'node:fs'
|
|
5
|
-
|
|
6
|
-
const BUILTIN_MODULES = new Set([
|
|
7
|
-
'fs',
|
|
8
|
-
'path',
|
|
9
|
-
'crypto',
|
|
10
|
-
'os',
|
|
11
|
-
'util',
|
|
12
|
-
'stream',
|
|
13
|
-
'events',
|
|
14
|
-
'http',
|
|
15
|
-
'https',
|
|
16
|
-
'url',
|
|
17
|
-
'child_process',
|
|
18
|
-
'process',
|
|
19
|
-
'assert',
|
|
20
|
-
'buffer',
|
|
21
|
-
'zlib',
|
|
22
|
-
'readline'
|
|
23
|
-
])
|
|
24
|
-
|
|
25
|
-
const JSDOC_OPEN_RE = /^\s*\/\*\*?/
|
|
26
|
-
const JSDOC_CLOSE_RE = /\*\/\s*$/
|
|
27
|
-
const STAR_PREFIX_RE = /^\s*\*?\s?/
|
|
28
|
-
const PARAM_LINE_RE = /^@param[ \t]{1,8}(?:\{[^}]{0,200}\}[ \t]{1,8})?\[?([\w.]{1,80})\]?[ \t]{0,8}(.{0,400})$/
|
|
29
|
-
const RETURNS_LINE_RE = /^@returns?[ \t]{1,8}(?:\{[^}]{0,200}\}[ \t]{1,8})?(.{0,400})$/
|
|
30
|
-
const FILE_HEADER_RE = /^\s*\/\*\*([\s\S]*?)\*\//
|
|
31
|
-
const PRECEDING_JSDOC_RE = /\/\*\*(?:(?!\*\/)[\s\S])*\*\/\s*$/
|
|
32
|
-
const EXPORT_DECL_RE = /export\s+(?:async\s+)?(function|const|class)\s+(\w+)/g
|
|
33
|
-
// Top-level function/class декларації (колонка 0) — для R6: службові функції,
|
|
34
|
-
// які не експортуються, не мають протікати у Поведінку/API як «публічні».
|
|
35
|
-
const TOP_FN_DECL_RE = /^(?:export\s+)?(?:default\s+)?(?:async\s+)?(?:function\*?|class)\s+(\w+)/gm
|
|
36
|
-
const IMPORT_FROM_RE = /^import[ \t]{1,8}[\s\S]{0,300}?from\s{1,8}['"]([^'"]+)['"]/gm
|
|
37
|
-
const NODE_PREFIX_RE = /^node:/
|
|
38
|
-
const INTERNAL_IMPORT_RE = /import[ \t]{1,8}([^'"]{0,300}?)from[ \t]{1,8}['"]\.[^'"]{1,300}['"]/g
|
|
39
|
-
const NAMED_BRACES_RE = /\{([^}]{1,400})\}/
|
|
40
|
-
const IDENT_RE = /^[\w$]{1,80}$/
|
|
41
|
-
const IMPORT_AS_RE = /[ \t]{1,8}as[ \t]{1,8}.{0,200}/
|
|
42
|
-
const WRITE_FS_RE = /\b(writeFile|mkdir|rmdir|unlink|appendFile|createWriteStream|rm\()/
|
|
43
|
-
const CATCH_RE = /catch\s*\(/
|
|
44
|
-
const TRY_RE = /\btry\s*\{/
|
|
45
|
-
// Falsy-return як «fail-safe» — лише коли воно в catch/error-гілці (інакше це
|
|
46
|
-
// звичайний guard `if (!x) return null`, не обробка помилки). Уникає over-claim.
|
|
47
|
-
const FALSY_RETURN_RE = /catch[\s\S]{0,400}?return\s+(false|null|''|"")/
|
|
48
|
-
// Мережа: окрім явного fetch/http, ловимо абстраговані клієнти (graphql/db/rpc/
|
|
49
|
-
// octokit/.request/.query). Хибний false-negative тут = небезпечна гарантія
|
|
50
|
-
// «без мережі», тож свідомо схиляємось до over-detection (м'якший бік помилки).
|
|
51
|
-
const NETWORK_RE =
|
|
52
|
-
/\bfetch\(|https?:\/\/|\bhttps?\.|axios|\bgot\(|graphql|\.request\(|\.query\(|\.mutate\(|octokit|node-fetch|undici|\bgrpc\b|websocket/i
|
|
53
|
-
// Будь-який `throw` назовні → НЕ можна гарантувати «fail-safe / без винятків».
|
|
54
|
-
const THROW_RE = /\bthrow\s/
|
|
55
|
-
// Запис у БД / зовнішню мутацію → НЕ read-only (навіть якщо нема ФС-запису).
|
|
56
|
-
// Розбито на кілька простіших патернів (та сама семантика через OR у `isMutation`),
|
|
57
|
-
// щоб уникнути надмірної складності одного великого regex.
|
|
58
|
-
const MUTATION_CALL_RE = /\b(insert|update|delete|upsert|drop|destroy|save)[A-Za-z]*\s*[(,]/
|
|
59
|
-
const MUTATION_NAME_RE = /[Mm]utation\b|\bmut[A-Z]\w*/
|
|
60
|
-
const MUTATION_METHOD_RE = /\.(save|create|update|delete|insert|destroy|mutate)\(/
|
|
61
|
-
// Raw-SQL tagged-template виклики (напр. `pgWrite\`UPDATE ...\``) — DML-ключове
|
|
62
|
-
// слово стоїть на початку тіла шаблону, не перед `(`, тож JS-орієнтовані
|
|
63
|
-
// патерни вище його не ловлять. Сигнал мінімальний, але навмисний: тег-функція
|
|
64
|
-
// (ідентифікатор впритул перед `` ` ``) + DML-keyword одразу після відкриття —
|
|
65
|
-
// уникає false positive на звичайних рядках/коментарях, де немає теg-виклику.
|
|
66
|
-
const SQL_TAGGED_MUTATION_RE = /\b\w+`\s*(?:UPDATE|INSERT|MERGE\s+INTO|DELETE\s+FROM|UPSERT)\b/i
|
|
67
|
-
/**
|
|
68
|
-
* @param {string} src вміст файлу
|
|
69
|
-
* @returns {boolean} чи є ознаки мутації БД / зовнішнього стану
|
|
70
|
-
*/
|
|
71
|
-
const isMutation = src =>
|
|
72
|
-
MUTATION_CALL_RE.test(src) ||
|
|
73
|
-
MUTATION_NAME_RE.test(src) ||
|
|
74
|
-
MUTATION_METHOD_RE.test(src) ||
|
|
75
|
-
SQL_TAGGED_MUTATION_RE.test(src)
|
|
76
|
-
// Кеш — лише за ІМЕНОВАНИМ маркером (`cache`/`Cache`/`memoize`), не за будь-яким
|
|
77
|
-
// `new Map()`: акумулятор (напр. `byPath = new Map()`) — не кеш, а хибна гарантія
|
|
78
|
-
// «Кешує результати» гірша за пропуск (фабрикація > мовчання).
|
|
79
|
-
const CACHE_RE = /cache|memoi[sz]e/i
|
|
80
|
-
|
|
81
|
-
/**
|
|
82
|
-
* Прибирає `/** */`-обрамлення й `*`-префікси, повертає чистий текст рядками.
|
|
83
|
-
* @param {string} raw сирий JSDoc-блок з обрамленням
|
|
84
|
-
* @returns {string} очищений текст без обрамлення й префіксів
|
|
85
|
-
*/
|
|
86
|
-
function cleanJsDoc(raw) {
|
|
87
|
-
return raw
|
|
88
|
-
.replace(JSDOC_OPEN_RE, '')
|
|
89
|
-
.replace(JSDOC_CLOSE_RE, '')
|
|
90
|
-
.split('\n')
|
|
91
|
-
.map(l => l.replace(STAR_PREFIX_RE, '').trimEnd())
|
|
92
|
-
.join('\n')
|
|
93
|
-
.trim()
|
|
94
|
-
}
|
|
95
|
-
|
|
96
|
-
/**
|
|
97
|
-
* Опис (без @-тегів) + параметри з `@param` як «name — опис».
|
|
98
|
-
* @param {string} raw сирий JSDoc-блок
|
|
99
|
-
* @returns {{desc:string, params:Array<{name:string, desc:string}>, ret:string}} розпарсений опис, параметри й опис повернення
|
|
100
|
-
*/
|
|
101
|
-
function parseJsDoc(raw) {
|
|
102
|
-
const text = cleanJsDoc(raw)
|
|
103
|
-
const lines = text.split('\n')
|
|
104
|
-
const descLines = []
|
|
105
|
-
const params = []
|
|
106
|
-
let ret = ''
|
|
107
|
-
for (const l of lines) {
|
|
108
|
-
const pm = l.match(PARAM_LINE_RE)
|
|
109
|
-
if (pm) {
|
|
110
|
-
const desc = pm[2].trim()
|
|
111
|
-
// «опис.» — JSDoc-заглушка без сенсу; не тягнемо її як факт
|
|
112
|
-
params.push({ name: pm[1], desc: desc === 'опис.' ? '' : desc })
|
|
113
|
-
continue
|
|
114
|
-
}
|
|
115
|
-
const rm = l.match(RETURNS_LINE_RE)
|
|
116
|
-
if (rm) {
|
|
117
|
-
ret = rm[1].trim()
|
|
118
|
-
continue
|
|
119
|
-
}
|
|
120
|
-
if (l.startsWith('@')) continue
|
|
121
|
-
descLines.push(l)
|
|
122
|
-
}
|
|
123
|
-
return { desc: descLines.join('\n').trim(), params, ret }
|
|
124
|
-
}
|
|
125
|
-
|
|
126
|
-
/**
|
|
127
|
-
* Провідний блок-коментар файлу (намір), якщо він перед першим import/кодом.
|
|
128
|
-
* @param {string} src вміст файлу
|
|
129
|
-
* @returns {string} текст header-коментаря або порожній рядок
|
|
130
|
-
*/
|
|
131
|
-
function extractFileHeader(src) {
|
|
132
|
-
const m = src.match(FILE_HEADER_RE)
|
|
133
|
-
if (!m) return ''
|
|
134
|
-
// має бути на самому початку (до import/код)
|
|
135
|
-
if (src.slice(0, m.index).trim() !== '') return ''
|
|
136
|
-
return parseJsDoc(m[0]).desc
|
|
137
|
-
}
|
|
138
|
-
|
|
139
|
-
/**
|
|
140
|
-
* Блок-коментар, що стоїть ВПРИТУЛ перед позицією (лише пробіли між ними).
|
|
141
|
-
* `(?:(?!\*/)[\s\S])*` гарантує, що тіло не містить `*/`, тож захоплюється рівно один
|
|
142
|
-
* найближчий блок — без жадібного «перестрибування» через імпорти/код.
|
|
143
|
-
* @param {string} prefix вміст файлу до позиції експорту
|
|
144
|
-
* @returns {string|null} JSDoc-блок або null якщо немає
|
|
145
|
-
*/
|
|
146
|
-
function precedingJsDoc(prefix) {
|
|
147
|
-
const m = prefix.match(PRECEDING_JSDOC_RE)
|
|
148
|
-
return m ? m[0] : null
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
/**
|
|
152
|
-
* Експорти + JSDoc, що безпосередньо передує кожному.
|
|
153
|
-
* @param {string} src вміст файлу
|
|
154
|
-
* @returns {Array<object>} список експортів із метаданими
|
|
155
|
-
*/
|
|
156
|
-
function extractExports(src) {
|
|
157
|
-
const out = []
|
|
158
|
-
for (const m of src.matchAll(EXPORT_DECL_RE)) {
|
|
159
|
-
const [, kind, name] = m
|
|
160
|
-
const jsdocRaw = precedingJsDoc(src.slice(0, m.index))
|
|
161
|
-
out.push({ name, kind, ...(jsdocRaw ? parseJsDoc(jsdocRaw) : { desc: '', params: [], ret: '' }) })
|
|
162
|
-
}
|
|
163
|
-
return out
|
|
164
|
-
}
|
|
165
|
-
|
|
166
|
-
/**
|
|
167
|
-
* Імпорти, класифіковані на stdlib / npm / internal.
|
|
168
|
-
* @param {string} src вміст файлу
|
|
169
|
-
* @returns {{stdlib:Array<string>, npm:Array<string>, internal:Array<string>}} розкласифіковані шляхи імпортів
|
|
170
|
-
*/
|
|
171
|
-
function extractImports(src) {
|
|
172
|
-
const internal = new Set(),
|
|
173
|
-
npm = new Set(),
|
|
174
|
-
stdlib = new Set()
|
|
175
|
-
for (const m of src.matchAll(IMPORT_FROM_RE)) {
|
|
176
|
-
const s = m[1]
|
|
177
|
-
if (s.startsWith('node:') || BUILTIN_MODULES.has(s.split('/', 1)[0])) stdlib.add(s.replace(NODE_PREFIX_RE, ''))
|
|
178
|
-
else if (s.startsWith('.') || s.startsWith('/')) internal.add(s)
|
|
179
|
-
else npm.add(s)
|
|
180
|
-
}
|
|
181
|
-
return { stdlib: [...stdlib], npm: [...npm], internal: [...internal] }
|
|
182
|
-
}
|
|
183
|
-
|
|
184
|
-
/**
|
|
185
|
-
* Імена символів, імпортованих із внутрішніх модулів — їх модель не має згадувати.
|
|
186
|
-
* @param {string} src вміст файлу
|
|
187
|
-
* @returns {Array<string>} список імен внутрішніх символів
|
|
188
|
-
*/
|
|
189
|
-
function extractInternalSymbols(src) {
|
|
190
|
-
const out = new Set()
|
|
191
|
-
for (const m of src.matchAll(INTERNAL_IMPORT_RE)) {
|
|
192
|
-
const clause = m[1]
|
|
193
|
-
const named = clause.match(NAMED_BRACES_RE)
|
|
194
|
-
if (named) {
|
|
195
|
-
for (const n of named[1].split(',')) {
|
|
196
|
-
const name = n.replace(IMPORT_AS_RE, '').trim()
|
|
197
|
-
if (name) out.add(name)
|
|
198
|
-
}
|
|
199
|
-
}
|
|
200
|
-
const defName = clause.replace(NAMED_BRACES_RE, '').replaceAll(',', ' ').trim().split(' ', 1)[0]
|
|
201
|
-
if (defName && IDENT_RE.test(defName)) out.add(defName)
|
|
202
|
-
}
|
|
203
|
-
return [...out]
|
|
204
|
-
}
|
|
205
|
-
|
|
206
|
-
/**
|
|
207
|
-
* Імена top-level функцій/класів, які НЕ експортуються (службові помічники).
|
|
208
|
-
* Модель не має подавати їх як «публічні функції» у Поведінці/API (R6).
|
|
209
|
-
* Const-стрілки свідомо не ловимо — менше false-positive на змістовних константах.
|
|
210
|
-
* @param {string} src вміст файлу
|
|
211
|
-
* @returns {Array<string>} список імен неекспортованих функцій/класів
|
|
212
|
-
*/
|
|
213
|
-
function extractLocalSymbols(src) {
|
|
214
|
-
const exported = new Set(Array.from(src.matchAll(EXPORT_DECL_RE), m => m[2]))
|
|
215
|
-
const out = new Set()
|
|
216
|
-
for (const m of src.matchAll(TOP_FN_DECL_RE)) {
|
|
217
|
-
if (!exported.has(m[1])) out.add(m[1])
|
|
218
|
-
}
|
|
219
|
-
return [...out]
|
|
220
|
-
}
|
|
221
|
-
|
|
222
|
-
/**
|
|
223
|
-
* Поведінкові маркери — евристики регулярками.
|
|
224
|
-
* @param {string} src вміст файлу
|
|
225
|
-
* @returns {object} набір прапорців-евристик
|
|
226
|
-
*/
|
|
227
|
-
function extractMarkers(src) {
|
|
228
|
-
// помітні «пропуски»: dir/segment-літерали у фільтрах
|
|
229
|
-
const skips = new Set()
|
|
230
|
-
for (const lit of ['.github', '.git', 'node_modules', 'base/', 'ua/', '.firebase']) {
|
|
231
|
-
if (src.includes(`'${lit}`) || src.includes(`"${lit}`) || src.includes(`/${lit}`)) skips.add(lit)
|
|
232
|
-
}
|
|
233
|
-
return {
|
|
234
|
-
// «Фабрикація > мовчання»: прапорець true лише за high-confidence; інакше
|
|
235
|
-
// guaranteesFromMarkers/factsSummary його ОПУСКАЮТЬ (не стверджують протилежне).
|
|
236
|
-
readOnly: !WRITE_FS_RE.test(src) && !isMutation(src), // ні ФС-запису, ні DB-мутацій
|
|
237
|
-
catchesErrors: (CATCH_RE.test(src) || TRY_RE.test(src)) && !THROW_RE.test(src), // fail-safe лише якщо НЕ кидає
|
|
238
|
-
returnsFalsyOnFail: FALSY_RETURN_RE.test(src) && !THROW_RE.test(src),
|
|
239
|
-
network: NETWORK_RE.test(src),
|
|
240
|
-
caches: CACHE_RE.test(src),
|
|
241
|
-
skips: [...skips]
|
|
242
|
-
}
|
|
243
|
-
}
|
|
244
|
-
/**
|
|
245
|
-
* Головний екстрактор: код файлу → факт-лист.
|
|
246
|
-
* @param {string} src вміст файлу
|
|
247
|
-
* @param {string} relPath шлях (для контексту/мови екстрактора)
|
|
248
|
-
* @returns {{relPath:string, lang:string, header:string, exports:Array, imports:object, markers:object}} структура фактів про файл
|
|
249
|
-
*/
|
|
250
|
-
export function extractFacts(src, relPath) {
|
|
251
|
-
const lang = relPath.split('.').pop()
|
|
252
|
-
if (!['js', 'mjs', 'ts'].includes(lang)) {
|
|
253
|
-
return { relPath, lang, unsupported: true, header: '', exports: [], imports: {}, markers: {} }
|
|
254
|
-
}
|
|
255
|
-
return {
|
|
256
|
-
relPath,
|
|
257
|
-
lang,
|
|
258
|
-
header: extractFileHeader(src),
|
|
259
|
-
exports: extractExports(src),
|
|
260
|
-
imports: extractImports(src),
|
|
261
|
-
internalSymbols: extractInternalSymbols(src),
|
|
262
|
-
localSymbols: extractLocalSymbols(src),
|
|
263
|
-
markers: extractMarkers(src)
|
|
264
|
-
}
|
|
265
|
-
}
|
|
266
|
-
|
|
267
|
-
// CLI для інспекції: node docgen-extract.mjs <file>
|
|
268
|
-
if (isRunAsCli(import.meta.url)) {
|
|
269
|
-
const file = process.argv[2]
|
|
270
|
-
if (!file) {
|
|
271
|
-
throw new Error('Usage: node docgen-extract.mjs <file>')
|
|
272
|
-
}
|
|
273
|
-
const facts = extractFacts(readFileSync(file, 'utf8'), file)
|
|
274
|
-
console.log(JSON.stringify(facts, null, 2))
|
|
275
|
-
}
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
type: JS Module
|
|
3
|
-
title: main.mjs
|
|
4
|
-
resource: npm/rules/doc-files/units/main.mjs
|
|
5
|
-
docgen:
|
|
6
|
-
crc: 8acdefc1
|
|
7
|
-
model: omlx/gemma-4-e4b-it-OptiQ-4bit
|
|
8
|
-
score: 100
|
|
9
|
-
issues: judge:inaccurate:0.98
|
|
10
|
-
judgeModel: openai-codex/gpt-5.4-mini
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
## Огляд
|
|
14
|
-
|
|
15
|
-
Цей файл забезпечує аналіз вмісту файлів різного мовного формату для вилучення інформації про юніти. Він обробляє вміст, визначаючи відповідний метод вилучення для JavaScript-подібних або Rust-файлів. Публічна функція `extractUnits` виконує механізм вилучення юнітних даних з коду.
|
|
16
|
-
|
|
17
|
-
## Поведінка
|
|
18
|
-
|
|
19
|
-
1. Метод `extractUnits` приймає вміст файлу та його відносний шлях.
|
|
20
|
-
2. Визначається розширення файлу за його відносним шляхом.
|
|
21
|
-
3. Якщо розширення відповідає JavaScript-подібним мовам (js, mjs, ts, jsx, tsx, cts, mts), викликається відповідна функція для вилучення юнітів на основі AST.
|
|
22
|
-
4. Якщо розширення 'rs', викликається відповідна функція для вилучення юнітів шляхом парсингу за допомогою регулярних виразів та підрахунку блоків.
|
|
23
|
-
5. Якщо розширення не підтримується або файл не може бути проаналізований, метод повертає null.
|
|
24
|
-
|
|
25
|
-
## Публічний API
|
|
26
|
-
|
|
27
|
-
- extractUnits — Витягує одиниці виміру, визначаючи метод аналізу на основі розширення файлу (від AST для JS/TS до простого пошуку для Vue/Py).
|
|
28
|
-
|
|
29
|
-
## Гарантії поведінки
|
|
30
|
-
|
|
31
|
-
- Read-only: не виконує операцій запису (ФС/БД).
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
/** @see ./docs/units.md */
|
|
2
|
-
|
|
3
|
-
import { extractUnitsJs } from '../units-js/main.mjs'
|
|
4
|
-
|
|
5
|
-
const JS_EXT = new Set(['js', 'mjs', 'ts', 'jsx', 'tsx', 'cts', 'mts'])
|
|
6
|
-
|
|
7
|
-
/**
|
|
8
|
-
* Мовно-агностичний фасад юніт-шару. Диспатчить за розширенням:
|
|
9
|
-
* js/mjs/ts → oxc AST; інші мови (rs — lang-плагін, extension-point
|
|
10
|
-
* `doc-files`.extractUnits; vue/py) → null (whole-file шлях).
|
|
11
|
-
* @param {string} src вміст файлу
|
|
12
|
-
* @param {string} relPath шлях файлу
|
|
13
|
-
* @returns {Array<object>|null} юніти або null, якщо мова ще не підтримана / файл не парситься
|
|
14
|
-
*/
|
|
15
|
-
export function extractUnits(src, relPath) {
|
|
16
|
-
const ext = (relPath.split('.').pop() || '').toLowerCase()
|
|
17
|
-
if (JS_EXT.has(ext)) return extractUnitsJs(src, relPath)
|
|
18
|
-
return null
|
|
19
|
-
}
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
type: JS Module
|
|
3
|
-
title: main.mjs
|
|
4
|
-
resource: npm/rules/doc-files/units-js/main.mjs
|
|
5
|
-
docgen:
|
|
6
|
-
crc: 395188f4
|
|
7
|
-
model: omlx/gemma-4-e4b-it-OptiQ-4bit
|
|
8
|
-
score: 100
|
|
9
|
-
issues: judge:inaccurate:0.99
|
|
10
|
-
judgeModel: openai-codex/gpt-5.4-mini
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
## Огляд
|
|
14
|
-
|
|
15
|
-
Будь ласка, надайте секцію «overview», яку необхідно переписати.
|
|
16
|
-
|
|
17
|
-
## Поведінка
|
|
18
|
-
|
|
19
|
-
1. Функція extractUnitsJs аналізує вміст файлу, щоб виявити ідентифіковані юніти (функції, класи, const-функції).
|
|
20
|
-
2. Вона визначає, які юніти є експортованими та обробляє їх для включення до списку.
|
|
21
|
-
3. Для кожного знайденого юніту вона витягує відповідний опис з JSDoc, що передує його оголошенню.
|
|
22
|
-
4. Зібрана інформація про юніт включає його назву, тип (функція, клас, const), прапор експорту, діапазон у вихідному коді та повний вихідний код.
|
|
23
|
-
5. Система виявляє всі виклики інших юнітів у тілі коду кожного юніта.
|
|
24
|
-
6. В результаті повертається список об'єктів, де кожен об'єкт описує один юніт, і в якому вказано лише посилання на інші виявлені юніти.
|
|
25
|
-
|
|
26
|
-
## Публічний API
|
|
27
|
-
|
|
28
|
-
extractUnitsJs — знаходить та витягує на верхньому рівні логічні блоки (функції/класи/константи) з файлів JavaScript/TypeScript, які є частиною юніт-шару. Включає інформацію про експорт та взаємодії з іншими юнітами.
|
|
29
|
-
|
|
30
|
-
## Гарантії поведінки
|
|
31
|
-
|
|
32
|
-
- Read-only: не виконує операцій запису (ФС/БД).
|
|
@@ -1,141 +0,0 @@
|
|
|
1
|
-
/** @see ./docs/units-js.md */
|
|
2
|
-
|
|
3
|
-
import { parseProgramOrNull, walkAstWithAncestors } from '../../../scripts/utils/ast-scan-utils.mjs'
|
|
4
|
-
|
|
5
|
-
// JSDoc-блок, що стоїть впритул перед позицією (лише пробіли між ними).
|
|
6
|
-
const JSDOC_BEFORE_RE = /\/\*\*(?:(?!\*\/)[\s\S])*\*\/\s*$/
|
|
7
|
-
const JSDOC_OPEN_RE = /^\s*\/\*\*?/
|
|
8
|
-
const JSDOC_CLOSE_RE = /\*\/\s*$/
|
|
9
|
-
const STAR_PREFIX_RE = /^\s*\*?\s?/
|
|
10
|
-
|
|
11
|
-
/**
|
|
12
|
-
* Очищає JSDoc від обрамлення `/** */` і `*`-префіксів.
|
|
13
|
-
* @param {string} raw сирий блок або порожній рядок
|
|
14
|
-
* @returns {string} текст опису без тегів-обрамлення
|
|
15
|
-
*/
|
|
16
|
-
function cleanDoc(raw) {
|
|
17
|
-
if (!raw) return ''
|
|
18
|
-
return raw
|
|
19
|
-
.replace(JSDOC_OPEN_RE, '')
|
|
20
|
-
.replace(JSDOC_CLOSE_RE, '')
|
|
21
|
-
.split('\n')
|
|
22
|
-
.map(l => l.replace(STAR_PREFIX_RE, '').trimEnd())
|
|
23
|
-
.join('\n')
|
|
24
|
-
.trim()
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
/**
|
|
28
|
-
* JSDoc, що передує позиції `start` у джерелі (або порожній рядок).
|
|
29
|
-
* @param {string} src вміст файлу
|
|
30
|
-
* @param {number} start зміщення початку декларації
|
|
31
|
-
* @returns {string} очищений опис
|
|
32
|
-
*/
|
|
33
|
-
function precedingDoc(src, start) {
|
|
34
|
-
const m = src.slice(0, start).match(JSDOC_BEFORE_RE)
|
|
35
|
-
return cleanDoc(m ? m[0] : '')
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
/**
|
|
39
|
-
* Імʼя функції, що викликається (проста Identifier або `obj.method`).
|
|
40
|
-
* @param {Record<string, unknown>} node CallExpression
|
|
41
|
-
* @returns {string|null} імʼя callee або null
|
|
42
|
-
*/
|
|
43
|
-
function calleeName(node) {
|
|
44
|
-
const c = node.callee
|
|
45
|
-
if (!c || typeof c !== 'object') return null
|
|
46
|
-
if (c.type === 'Identifier') return c.name
|
|
47
|
-
if (c.type === 'MemberExpression' && !c.computed && c.property?.type === 'Identifier') return c.property.name
|
|
48
|
-
return null
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
/**
|
|
52
|
-
* Множина імен, що викликаються у тілі вузла (сирі callee — фільтрація на ребра
|
|
53
|
-
* call-graph робиться у `extractUnitsJs` після збору всіх імен юнітів).
|
|
54
|
-
* @param {unknown} node AST-вузол юніта
|
|
55
|
-
* @returns {Set<string>} імена викликів
|
|
56
|
-
*/
|
|
57
|
-
function collectCalls(node) {
|
|
58
|
-
const names = new Set()
|
|
59
|
-
walkAstWithAncestors(node, [], n => {
|
|
60
|
-
if (n.type !== 'CallExpression') {
|
|
61
|
-
return
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
const name = calleeName(n)
|
|
65
|
-
if (name) names.add(name)
|
|
66
|
-
})
|
|
67
|
-
return names
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
/**
|
|
71
|
-
* Будує юніт із декларації, додає у `units`. Розпізнає function/class та
|
|
72
|
-
* const-функції (`const x = () => {}` / `function expression`).
|
|
73
|
-
* @param {Record<string, unknown>} decl декларація (function/class/variable)
|
|
74
|
-
* @param {boolean} exported чи експортується
|
|
75
|
-
* @param {number} docStart зміщення для пошуку JSDoc (зовнішній export-вузол)
|
|
76
|
-
* @param {string} src вміст файлу
|
|
77
|
-
* @param {Array<object>} units акумулятор
|
|
78
|
-
* @returns {void}
|
|
79
|
-
*/
|
|
80
|
-
function pushUnits(decl, exported, docStart, src, units) {
|
|
81
|
-
if (!decl || typeof decl !== 'object') return
|
|
82
|
-
const doc = precedingDoc(src, docStart)
|
|
83
|
-
if (decl.type === 'FunctionDeclaration' || decl.type === 'ClassDeclaration') {
|
|
84
|
-
const name = decl.id?.name
|
|
85
|
-
if (!name) return
|
|
86
|
-
units.push({
|
|
87
|
-
name,
|
|
88
|
-
kind: decl.type === 'ClassDeclaration' ? 'class' : 'function',
|
|
89
|
-
exported,
|
|
90
|
-
span: { start: decl.start, end: decl.end },
|
|
91
|
-
body: src.slice(decl.start, decl.end),
|
|
92
|
-
calls: collectCalls(decl),
|
|
93
|
-
doc
|
|
94
|
-
})
|
|
95
|
-
return
|
|
96
|
-
}
|
|
97
|
-
if (decl.type === 'VariableDeclaration') {
|
|
98
|
-
for (const d of decl.declarations ?? []) {
|
|
99
|
-
const init = d.init
|
|
100
|
-
const isFn = init && (init.type === 'ArrowFunctionExpression' || init.type === 'FunctionExpression')
|
|
101
|
-
if (!isFn || d.id?.type !== 'Identifier') continue
|
|
102
|
-
units.push({
|
|
103
|
-
name: d.id.name,
|
|
104
|
-
kind: 'const',
|
|
105
|
-
exported,
|
|
106
|
-
span: { start: init.start, end: init.end },
|
|
107
|
-
body: src.slice(init.start, init.end),
|
|
108
|
-
calls: collectCalls(init),
|
|
109
|
-
doc
|
|
110
|
-
})
|
|
111
|
-
}
|
|
112
|
-
}
|
|
113
|
-
}
|
|
114
|
-
|
|
115
|
-
/**
|
|
116
|
-
* Юніт-шар для js/mjs/ts: top-level функції/класи/const-функції з тілом, JSDoc,
|
|
117
|
-
* прапором експорту і ребрами call-graph (виклики ІНШИХ юнітів у тілі).
|
|
118
|
-
* @param {string} src вміст файлу
|
|
119
|
-
* @param {string} [relPath] шлях (для вибору мови oxc)
|
|
120
|
-
* @returns {Array<{name:string, kind:string, exported:boolean, span:{start:number,end:number}, body:string, calls:string[], doc:string}>|null} юніти або null, якщо файл не парситься
|
|
121
|
-
*/
|
|
122
|
-
export function extractUnitsJs(src, relPath = 'scan.ts') {
|
|
123
|
-
const program = parseProgramOrNull(src, relPath)
|
|
124
|
-
if (!program || !Array.isArray(program.body)) return null
|
|
125
|
-
|
|
126
|
-
const units = []
|
|
127
|
-
for (const node of program.body) {
|
|
128
|
-
const isExport =
|
|
129
|
-
(node.type === 'ExportNamedDeclaration' || node.type === 'ExportDefaultDeclaration') && node.declaration
|
|
130
|
-
if (isExport) {
|
|
131
|
-
pushUnits(node.declaration, true, node.start, src, units)
|
|
132
|
-
} else {
|
|
133
|
-
pushUnits(node, false, node.start, src, units)
|
|
134
|
-
}
|
|
135
|
-
}
|
|
136
|
-
|
|
137
|
-
// Ребра call-graph: лишаємо тільки виклики інших внутрішніх юнітів
|
|
138
|
-
const names = new Set(units.map(u => u.name))
|
|
139
|
-
for (const u of units) u.calls = [...u.calls].filter(n => names.has(n) && n !== u.name)
|
|
140
|
-
return units
|
|
141
|
-
}
|
package/skills/taze/js/diff.mjs
DELETED
|
@@ -1,140 +0,0 @@
|
|
|
1
|
-
/** @see ./docs/diff.md */
|
|
2
|
-
import { existsSync } from 'node:fs'
|
|
3
|
-
import { readFile } from 'node:fs/promises'
|
|
4
|
-
import { join } from 'node:path'
|
|
5
|
-
|
|
6
|
-
import { getMonorepoPackageRootDirs } from '../../../scripts/lib/workspaces.mjs'
|
|
7
|
-
|
|
8
|
-
/** Поля package.json із залежностями, які порівнюємо. */
|
|
9
|
-
const DEP_FIELDS = ['dependencies', 'devDependencies', 'peerDependencies', 'optionalDependencies']
|
|
10
|
-
|
|
11
|
-
/** Дефолтний суфікс бекапу, який створює крок 1 скіла (`cp package.json package.json.taze-bak`). */
|
|
12
|
-
const DEFAULT_BACKUP_SUFFIX = '.taze-bak'
|
|
13
|
-
|
|
14
|
-
// Заякорено на початок (після можливих range-операторів `^~>=<`, пробілів, `v`),
|
|
15
|
-
// щоб НЕ ловити версію всередині protocol-specifier-ів (`workspace:1.0.0`, `npm:x@1.2.3`).
|
|
16
|
-
const SEMVER_RE = /^[\s~^>=<v]*(\d+)\.(\d+)\.(\d+)/
|
|
17
|
-
|
|
18
|
-
/**
|
|
19
|
-
* Парсить semver-ядро зі specifier-а (ігнорує range-префікси `^`/`~`/`>=` тощо).
|
|
20
|
-
* @param {string} spec версійний specifier із package.json
|
|
21
|
-
* @returns {{major:number, minor:number, patch:number}|null} ядро або null для не-semver (`workspace:*`, git-url, `*`)
|
|
22
|
-
*/
|
|
23
|
-
export function parseVersion(spec) {
|
|
24
|
-
if (typeof spec !== 'string') return null
|
|
25
|
-
const m = SEMVER_RE.exec(spec)
|
|
26
|
-
if (!m) return null
|
|
27
|
-
return { major: Number(m[1]), minor: Number(m[2]), patch: Number(m[3]) }
|
|
28
|
-
}
|
|
29
|
-
|
|
30
|
-
/**
|
|
31
|
-
* Чи є перехід `from → to` breaking за caret-семантикою (змінилась найлівіша
|
|
32
|
-
* ненульова компонента).
|
|
33
|
-
* @param {{major:number,minor:number,patch:number}} from стара версія
|
|
34
|
-
* @param {{major:number,minor:number,patch:number}} to нова версія
|
|
35
|
-
* @returns {boolean} true — major/breaking
|
|
36
|
-
*/
|
|
37
|
-
export function isBreaking(from, to) {
|
|
38
|
-
if (from.major !== to.major) return true
|
|
39
|
-
if (from.major > 0) return false
|
|
40
|
-
if (from.minor !== to.minor) return true
|
|
41
|
-
if (from.minor > 0) return false
|
|
42
|
-
return from.patch !== to.patch
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
/**
|
|
46
|
-
* Порівнює два package.json-обʼєкти й повертає зміни залежностей.
|
|
47
|
-
* @param {object} oldPkg розпарсений старий package.json (бекап)
|
|
48
|
-
* @param {object} newPkg розпарсений новий package.json
|
|
49
|
-
* @param {string} workspace мітка воркспейсу (`.` для кореня)
|
|
50
|
-
* @returns {{major: Array<{workspace:string, pkg:string, from:string, to:string}>, minorPatch:number}} зміни
|
|
51
|
-
*/
|
|
52
|
-
export function diffPackageJson(oldPkg, newPkg, workspace) {
|
|
53
|
-
const major = []
|
|
54
|
-
let minorPatch = 0
|
|
55
|
-
for (const field of DEP_FIELDS) {
|
|
56
|
-
const oldDeps = oldPkg?.[field]
|
|
57
|
-
const newDeps = newPkg?.[field]
|
|
58
|
-
if (!oldDeps || !newDeps) continue
|
|
59
|
-
for (const [pkg, from] of Object.entries(oldDeps)) {
|
|
60
|
-
const to = newDeps[pkg]
|
|
61
|
-
if (to === undefined || to === from) continue
|
|
62
|
-
const fromV = parseVersion(from)
|
|
63
|
-
const toV = parseVersion(to)
|
|
64
|
-
if (fromV && toV && isBreaking(fromV, toV)) {
|
|
65
|
-
major.push({ workspace, pkg, from, to })
|
|
66
|
-
} else {
|
|
67
|
-
minorPatch += 1
|
|
68
|
-
}
|
|
69
|
-
}
|
|
70
|
-
}
|
|
71
|
-
return { major, minorPatch }
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
/**
|
|
75
|
-
* Читає JSON-файл або повертає null, якщо файл відсутній / невалідний.
|
|
76
|
-
* @param {string} path абсолютний шлях
|
|
77
|
-
* @returns {Promise<object|null>} розпарсений обʼєкт або null
|
|
78
|
-
*/
|
|
79
|
-
async function readJsonOrNull(path) {
|
|
80
|
-
if (!existsSync(path)) return null
|
|
81
|
-
try {
|
|
82
|
-
return JSON.parse(await readFile(path, 'utf8'))
|
|
83
|
-
} catch {
|
|
84
|
-
return null
|
|
85
|
-
}
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
/**
|
|
89
|
-
* Збирає diff по всьому монорепо: для кожного воркспейсу порівнює
|
|
90
|
-
* `<ws>/package.json` з `<ws>/package.json<backupSuffix>`.
|
|
91
|
-
* @param {string} cwd корінь репозиторію
|
|
92
|
-
* @param {string} [backupSuffix] суфікс бекап-файлу
|
|
93
|
-
* @returns {Promise<{major: Array<{workspace:string, pkg:string, from:string, to:string}>, minorPatch:number, totalChanged:number, comparedWorkspaces:number}>} агрегований diff
|
|
94
|
-
*/
|
|
95
|
-
export async function collectTazeDiff(cwd, backupSuffix = DEFAULT_BACKUP_SUFFIX) {
|
|
96
|
-
const roots = await getMonorepoPackageRootDirs(cwd)
|
|
97
|
-
const major = []
|
|
98
|
-
let minorPatch = 0
|
|
99
|
-
let comparedWorkspaces = 0
|
|
100
|
-
for (const ws of roots) {
|
|
101
|
-
const dir = join(cwd, ws)
|
|
102
|
-
const oldPkg = await readJsonOrNull(join(dir, `package.json${backupSuffix}`))
|
|
103
|
-
const newPkg = await readJsonOrNull(join(dir, 'package.json'))
|
|
104
|
-
if (!oldPkg || !newPkg) continue
|
|
105
|
-
comparedWorkspaces += 1
|
|
106
|
-
const res = diffPackageJson(oldPkg, newPkg, ws)
|
|
107
|
-
major.push(...res.major)
|
|
108
|
-
minorPatch += res.minorPatch
|
|
109
|
-
}
|
|
110
|
-
return { major, minorPatch, totalChanged: major.length + minorPatch, comparedWorkspaces }
|
|
111
|
-
}
|
|
112
|
-
|
|
113
|
-
const USAGE = 'Usage: n-rules taze diff [--backup-suffix <suffix>]'
|
|
114
|
-
|
|
115
|
-
/**
|
|
116
|
-
* CLI: `n-rules taze diff` друкує компактний JSON зі списком major-оновлень і
|
|
117
|
-
* лічбою minor/patch. Read-only.
|
|
118
|
-
* @param {string[]} args аргументи після `taze`
|
|
119
|
-
* @param {string} [cwd] корінь репозиторію (ін'єкція для тестів)
|
|
120
|
-
* @returns {Promise<number>} exit code
|
|
121
|
-
*/
|
|
122
|
-
export async function runTazeCli(args, cwd = process.cwd()) {
|
|
123
|
-
if (args[0] !== 'diff') {
|
|
124
|
-
console.error(USAGE)
|
|
125
|
-
return 1
|
|
126
|
-
}
|
|
127
|
-
const flagAt = args.indexOf('--backup-suffix')
|
|
128
|
-
const backupSuffix = flagAt === -1 ? DEFAULT_BACKUP_SUFFIX : args[flagAt + 1]
|
|
129
|
-
if (!backupSuffix) {
|
|
130
|
-
console.error(USAGE)
|
|
131
|
-
return 1
|
|
132
|
-
}
|
|
133
|
-
const diff = await collectTazeDiff(cwd, backupSuffix)
|
|
134
|
-
if (diff.comparedWorkspaces === 0) {
|
|
135
|
-
console.error(`✗ Не знайдено жодного package.json${backupSuffix} — спершу зроби бекап (крок 1 скіла).`)
|
|
136
|
-
return 1
|
|
137
|
-
}
|
|
138
|
-
process.stdout.write(`${JSON.stringify(diff)}\n`)
|
|
139
|
-
return 0
|
|
140
|
-
}
|