@nitra/cursor 1.13.2 → 1.13.11
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 +102 -0
- package/bin/n-cursor.js +4 -2
- package/package.json +4 -2
- package/rules/ga/fix/workflows/check.mjs +6 -109
- package/rules/ga/ga.mdc +10 -15
- package/rules/ga/policy/package_json/package_json.rego +20 -0
- package/rules/ga/policy/package_json/target.json +8 -0
- package/rules/ga/policy/package_json/template/package.json.contains.json +1 -0
- package/rules/ga/policy/vscode_extensions/target.json +8 -0
- package/rules/ga/policy/vscode_extensions/template/extensions.json.snippet.json +1 -0
- package/rules/ga/policy/vscode_extensions/vscode_extensions.rego +18 -0
- package/rules/ga/policy/vscode_settings/target.json +8 -0
- package/rules/ga/policy/vscode_settings/template/settings.json.snippet.json +1 -0
- package/rules/ga/policy/vscode_settings/vscode_settings.rego +22 -0
- package/rules/ga/policy/zizmor_yml/target.json +8 -0
- package/rules/ga/policy/zizmor_yml/template/zizmor.yml.snippet.yml +5 -0
- package/rules/ga/policy/zizmor_yml/zizmor_yml.rego +27 -0
- package/rules/js-lint/fix/tooling/check.mjs +6 -83
- package/rules/js-lint/policy/jscpd/jscpd.rego +38 -0
- package/rules/js-lint/policy/jscpd/target.json +8 -0
- package/rules/js-lint/policy/vscode_extensions/target.json +8 -0
- package/rules/js-lint/policy/vscode_extensions/vscode_extensions.rego +25 -0
- package/rules/rego/lint/lint.mjs +5 -4
- package/rules/rego/policy/package_json/package_json.rego +8 -29
- package/rules/rego/policy/package_json/template/package.json.snippet.json +1 -0
- package/rules/rego/policy/vscode_extensions/template/extensions.json.snippet.json +1 -0
- package/rules/rego/policy/vscode_extensions/vscode_extensions.rego +7 -11
- package/rules/rego/policy/vscode_settings/template/settings.json.snippet.json +6 -0
- package/rules/rego/policy/vscode_settings/vscode_settings.rego +19 -27
- package/rules/rego/rego.mdc +10 -8
- package/rules/security/fix/gitleaks/check.mjs +8 -45
- package/rules/security/fix/gitleaks/template/.gitleaks.toml.snippet.toml +12 -0
- package/rules/security/policy/gitleaks/gitleaks.rego +17 -0
- package/rules/security/policy/gitleaks/target.json +8 -0
- package/rules/security/policy/package_json/package_json.rego +22 -59
- package/rules/security/policy/package_json/template/package.json.contains.json +1 -0
- package/rules/security/policy/package_json/template/package.json.deny.json +4 -0
- package/rules/security/policy/package_json/template/package.json.snippet.json +1 -0
- package/rules/security/security.mdc +7 -26
- package/rules/security/todo.MD +27 -0
- package/rules/vue/fix/packages/check.mjs +7 -64
- package/rules/vue/policy/package_json/package_json.rego +45 -2
- package/rules/vue/vue.mdc +15 -2
- package/scripts/ensure-nitra-cursor-dev-dependencies.mjs +41 -21
- package/scripts/utils/check-mdc-template-refs.mjs +47 -0
- package/scripts/utils/inline-template-links.mjs +60 -0
- package/scripts/utils/run-conftest-batch.mjs +60 -33
- package/scripts/utils/run-rule.mjs +16 -1
- package/scripts/utils/template.mjs +215 -0
|
@@ -1,8 +1,12 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Знаходить пакети з `vue` у dependencies і перевіряє їх за правилом vue.mdc.
|
|
3
3
|
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
4
|
+
* Вміст `vite.config`, editor-файли для Vite client types, у репозиторії —
|
|
5
|
+
* рекомендацію розширення Vue.volar.
|
|
6
|
+
*
|
|
7
|
+
* Залежності Vue/Vite (`vite >= 8`, `@vitejs/plugin-vue`, `vue-macros`,
|
|
8
|
+
* `unplugin-auto-import`, `vite-plugin-vue-layouts-next`, заборона `esbuild`) —
|
|
9
|
+
* у policy `vue.package_json`.
|
|
6
10
|
*
|
|
7
11
|
* У кожному Vue+Vite-пакеті очікується `src/vite-env.d.ts` з `/// <reference types="vite/client" />`
|
|
8
12
|
* та `jsconfig.json` у корені пакета (типи для імпортів асетів у `.vue`).
|
|
@@ -183,30 +187,6 @@ function ukFilesCountPhrase(n) {
|
|
|
183
187
|
return `${n} файлів`
|
|
184
188
|
}
|
|
185
189
|
|
|
186
|
-
/**
|
|
187
|
-
* Перевіряє наявність залежності в об'єкті deps.
|
|
188
|
-
* @param {Record<string,string>} deps об'єкт залежностей
|
|
189
|
-
* @param {string} name ім'я пакета
|
|
190
|
-
* @param {string} prefix префікс повідомлення
|
|
191
|
-
* @param {(msg: string) => void} passFn callback при успішній перевірці
|
|
192
|
-
* @param {(msg: string) => void} fail callback при помилці
|
|
193
|
-
* @param {string} hint підказка при відсутності
|
|
194
|
-
*/
|
|
195
|
-
function checkRequiredDep(deps, name, prefix, passFn, fail, hint = `${name} відсутній`) {
|
|
196
|
-
if (deps[name]) {
|
|
197
|
-
passFn(`${prefix}${name}: ${deps[name]}`)
|
|
198
|
-
} else {
|
|
199
|
-
fail(`${prefix}${hint}`)
|
|
200
|
-
}
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
/**
|
|
204
|
-
* Перевіряє версію vite у devDependencies.
|
|
205
|
-
* @param {Record<string,string>} devDeps devDependencies з package.json
|
|
206
|
-
* @param {string} prefix параметр prefix
|
|
207
|
-
* @param {(msg: string) => void} passFn callback при успішній перевірці
|
|
208
|
-
* @param {(msg: string) => void} fail callback при помилці
|
|
209
|
-
*/
|
|
210
190
|
/**
|
|
211
191
|
* Перевіряє `src/vite-env.d.ts` і наявність `jsconfig.json` для підтягування типів асетів Vite у IDE.
|
|
212
192
|
* @param {string} rootDir відносний шлях до кореня пакета
|
|
@@ -433,44 +413,7 @@ async function checkVueImportViolations(rootDir, absPackageRoot, ignorePaths, ha
|
|
|
433
413
|
*/
|
|
434
414
|
async function checkVuePackage(rootDir, ignorePaths, fail, passFn) {
|
|
435
415
|
const prefix = `[${packageLabel(rootDir)}] `
|
|
436
|
-
|
|
437
|
-
const deps = pkg.dependencies || {}
|
|
438
|
-
const devDeps = pkg.devDependencies || {}
|
|
439
|
-
const allDeps = { ...deps, ...devDeps }
|
|
440
|
-
|
|
441
|
-
if (allDeps.esbuild) {
|
|
442
|
-
fail(`${prefix}esbuild заборонено (знайдено: ${allDeps.esbuild}). Замінити на rolldown та прибрати esbuild.`)
|
|
443
|
-
}
|
|
444
|
-
|
|
445
|
-
checkRequiredDep(deps, 'vue', prefix, passFn, fail, 'vue відсутній в dependencies')
|
|
446
|
-
// `vite >= 8` перенесено в Rego (`npm/policy/vue/package_json/`); запуск
|
|
447
|
-
// через `npx @nitra/cursor check`. Залишені вимоги — present-/missing-deps
|
|
448
|
-
// (vue-macros, unplugin-auto-import, тощо) — у самому JS-чекері.
|
|
449
|
-
checkRequiredDep(
|
|
450
|
-
devDeps,
|
|
451
|
-
'@vitejs/plugin-vue',
|
|
452
|
-
prefix,
|
|
453
|
-
passFn,
|
|
454
|
-
fail,
|
|
455
|
-
'@vitejs/plugin-vue відсутній в devDependencies'
|
|
456
|
-
)
|
|
457
|
-
checkRequiredDep(allDeps, 'vue-macros', prefix, passFn, fail, 'vue-macros відсутній — bun add -d vue-macros')
|
|
458
|
-
checkRequiredDep(
|
|
459
|
-
allDeps,
|
|
460
|
-
'unplugin-auto-import',
|
|
461
|
-
prefix,
|
|
462
|
-
passFn,
|
|
463
|
-
fail,
|
|
464
|
-
'unplugin-auto-import відсутній — bun add -d unplugin-auto-import'
|
|
465
|
-
)
|
|
466
|
-
checkRequiredDep(
|
|
467
|
-
allDeps,
|
|
468
|
-
'vite-plugin-vue-layouts-next',
|
|
469
|
-
prefix,
|
|
470
|
-
passFn,
|
|
471
|
-
fail,
|
|
472
|
-
'vite-plugin-vue-layouts-next відсутній — bun add -d vite-plugin-vue-layouts-next'
|
|
473
|
-
)
|
|
416
|
+
passFn(`${prefix}package.json залежності перевіряє npx @nitra/cursor check → vue.package_json`)
|
|
474
417
|
|
|
475
418
|
await checkViteClientEnvAndEditorConfig(rootDir, prefix, passFn, fail)
|
|
476
419
|
|
|
@@ -5,8 +5,9 @@
|
|
|
5
5
|
# conftest test path/to/package.json -p npm/policy/vue \
|
|
6
6
|
# --namespace vue.package_json
|
|
7
7
|
#
|
|
8
|
-
# Перевіряє: якщо в `dependencies` є `vue`, то
|
|
9
|
-
#
|
|
8
|
+
# Перевіряє: якщо в `dependencies` є `vue`, то потрібні канонічні Vue/Vite
|
|
9
|
+
# залежності, `devDependencies.vite` має бути мажорної версії ≥ 8, а `esbuild`
|
|
10
|
+
# у dependencies/devDependencies заборонений (міграція на rolldown).
|
|
10
11
|
#
|
|
11
12
|
# AST-сканування коду (заборона явних value-імпортів `from 'vue'`, заборона
|
|
12
13
|
# Node-нативних модулів у `.vue` SFC, перевірка `vite.config` на
|
|
@@ -34,12 +35,54 @@ deny contains msg if {
|
|
|
34
35
|
msg := sprintf("Vue-пакет: vite має бути >= 8 (зараз %q) (vue.mdc)", [vite_range])
|
|
35
36
|
}
|
|
36
37
|
|
|
38
|
+
deny contains msg if {
|
|
39
|
+
uses_vue
|
|
40
|
+
not "@vitejs/plugin-vue" in dev_dependency_names
|
|
41
|
+
msg := "Vue-пакет: @vitejs/plugin-vue відсутній у devDependencies (vue.mdc)"
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
deny contains msg if {
|
|
45
|
+
uses_vue
|
|
46
|
+
not "vue-macros" in all_dependency_names
|
|
47
|
+
msg := "Vue-пакет: vue-macros відсутній (vue.mdc)"
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
deny contains msg if {
|
|
51
|
+
uses_vue
|
|
52
|
+
not "unplugin-auto-import" in all_dependency_names
|
|
53
|
+
msg := "Vue-пакет: unplugin-auto-import відсутній (vue.mdc)"
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
deny contains msg if {
|
|
57
|
+
uses_vue
|
|
58
|
+
not "vite-plugin-vue-layouts-next" in all_dependency_names
|
|
59
|
+
msg := "Vue-пакет: vite-plugin-vue-layouts-next відсутній (vue.mdc)"
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
deny contains msg if {
|
|
63
|
+
uses_vue
|
|
64
|
+
"esbuild" in all_dependency_names
|
|
65
|
+
msg := "Vue-пакет: esbuild заборонено — заміни на rolldown і прибери залежність (vue.mdc)"
|
|
66
|
+
}
|
|
67
|
+
|
|
37
68
|
# ── helpers ────────────────────────────────────────────────────────────────
|
|
38
69
|
|
|
39
70
|
uses_vue if {
|
|
40
71
|
"vue" in object.keys(object.get(input, "dependencies", {}))
|
|
41
72
|
}
|
|
42
73
|
|
|
74
|
+
dependency_names := {n | some n in object.keys(object.get(input, "dependencies", {}))}
|
|
75
|
+
|
|
76
|
+
dev_dependency_names := {n | some n in object.keys(object.get(input, "devDependencies", {}))}
|
|
77
|
+
|
|
78
|
+
all_dependency_names contains n if {
|
|
79
|
+
some n in dependency_names
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
all_dependency_names contains n if {
|
|
83
|
+
some n in dev_dependency_names
|
|
84
|
+
}
|
|
85
|
+
|
|
43
86
|
vite_in_dev_dependencies if {
|
|
44
87
|
"vite" in object.keys(object.get(input, "devDependencies", {}))
|
|
45
88
|
}
|
package/rules/vue/vue.mdc
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
description: Vue
|
|
3
|
-
version: '1.
|
|
3
|
+
version: '1.9'
|
|
4
4
|
globs: "**/*.vue"
|
|
5
5
|
alwaysApply: false
|
|
6
6
|
---
|
|
@@ -104,7 +104,20 @@ const additionalInstructions = `
|
|
|
104
104
|
|
|
105
105
|
### Тестування
|
|
106
106
|
|
|
107
|
-
- **Unit
|
|
107
|
+
- **Unit:** **Bun Test Runner** (`bun test`) — використовуй його замість **Vitest**. API сумісне (`describe` / `it` / `expect` з `bun:test`), моки через `mock` і `mock.module`. У `package.json` тримай `"test": "bun test <шляхи>"`; не додавай `vitest`, `vitest.config.*` і пов’язані залежності.
|
|
108
|
+
- **Component / DOM:** **Vue Test Utils** + **Bun Test Runner** з **happy-dom** як DOM-середовищем. Підключення — через `@happy-dom/global-registrator` у preload-файлі та `bunfig.toml`:
|
|
109
|
+
|
|
110
|
+
```toml title="bunfig.toml"
|
|
111
|
+
[test]
|
|
112
|
+
preload = ["./test/happy-dom.preload.js"]
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
```js title="test/happy-dom.preload.js"
|
|
116
|
+
import { GlobalRegistrator } from '@happy-dom/global-registrator'
|
|
117
|
+
GlobalRegistrator.register()
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
`jsdom` не використовуй — happy-dom швидший і достатній для типових Vue-компонентних тестів.
|
|
108
121
|
- **E2E:** **Playwright** змістовні сценарії користувацьких потоків.
|
|
109
122
|
|
|
110
123
|
### Інструменти (узгоджено з Vite і цим правилом)
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Дописує `\@nitra/cursor` у `devDependencies`
|
|
3
|
-
* оголошено ні в `devDependencies`, ні в `dependencies`.
|
|
2
|
+
* Дописує `\@nitra/cursor` у `devDependencies` workspace-root `package.json` проєкту, якщо пакет ще
|
|
3
|
+
* не оголошено ні в `devDependencies`, ні в `dependencies`.
|
|
4
4
|
*
|
|
5
5
|
* Використовується CLI `n-cursor` при кожному запуску (`npx \@nitra/cursor`, зокрема `check`), щоб
|
|
6
6
|
* команда `check` і скрипти з `node_modules/\@nitra/cursor/scripts/` були відтворювані після
|
|
7
|
-
* `bun install` / `npm install`, а не лише з кешу npx.
|
|
7
|
+
* `bun install` / `npm install`, а не лише з кешу npx. Корінь визначається тільки за наявністю поля
|
|
8
|
+
* `workspaces` у `package.json` поруч із поточною директорією запуску.
|
|
8
9
|
*
|
|
9
10
|
* Версія діапазону: `^<version>` з поля `version` установленого пакету `\@nitra/cursor`.
|
|
10
11
|
*/
|
|
@@ -37,36 +38,55 @@ export async function readBundledPackageVersion() {
|
|
|
37
38
|
}
|
|
38
39
|
|
|
39
40
|
/**
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
* @
|
|
43
|
-
* @param {{ bundledVersion?: string | null, silent?: boolean }} [options] `bundledVersion` — для тестів;
|
|
44
|
-
* `silent` — не писати в консоль при успішному оновленні
|
|
45
|
-
* @returns {Promise<boolean>} `true`, якщо `package.json` змінено на диску
|
|
41
|
+
* Читає JSON-обʼєкт із диска.
|
|
42
|
+
* @param {string} path шлях до JSON-файлу
|
|
43
|
+
* @returns {Promise<Record<string, unknown> | null>} обʼєкт або `null`, якщо файл нечитабельний
|
|
46
44
|
*/
|
|
47
|
-
|
|
48
|
-
const pkgPath = join(root, 'package.json')
|
|
49
|
-
if (!existsSync(pkgPath)) {
|
|
50
|
-
return false
|
|
51
|
-
}
|
|
52
|
-
|
|
45
|
+
async function readJsonObject(path) {
|
|
53
46
|
let raw
|
|
54
47
|
try {
|
|
55
|
-
raw = await readFile(
|
|
48
|
+
raw = await readFile(path, 'utf8')
|
|
56
49
|
} catch {
|
|
57
|
-
return
|
|
50
|
+
return null
|
|
58
51
|
}
|
|
59
52
|
|
|
60
|
-
let pkg
|
|
61
53
|
try {
|
|
62
|
-
|
|
54
|
+
const value = JSON.parse(raw)
|
|
55
|
+
return value !== null && typeof value === 'object' && !Array.isArray(value) ? value : null
|
|
63
56
|
} catch {
|
|
64
|
-
return
|
|
57
|
+
return null
|
|
65
58
|
}
|
|
59
|
+
}
|
|
66
60
|
|
|
67
|
-
|
|
61
|
+
/**
|
|
62
|
+
* Читає `package.json` поруч зі стартовою директорією, якщо це workspace-root.
|
|
63
|
+
* @param {string} startDir директорія, з якої запущено CLI
|
|
64
|
+
* @returns {Promise<{ path: string, pkg: Record<string, unknown> } | null>} workspace-root package або `null`
|
|
65
|
+
*/
|
|
66
|
+
async function readAdjacentWorkspaceRootPackageJson(startDir) {
|
|
67
|
+
const pkgPath = join(startDir, 'package.json')
|
|
68
|
+
if (!existsSync(pkgPath)) {
|
|
69
|
+
return null
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
const pkg = await readJsonObject(pkgPath)
|
|
73
|
+
return pkg && Object.hasOwn(pkg, 'workspaces') ? { path: pkgPath, pkg } : null
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Якщо у workspace-root `package.json` немає `\@nitra/cursor` у `devDependencies` і `dependencies`,
|
|
78
|
+
* дописує `devDependencies["\@nitra/cursor"]` зі значенням `^<bundledVersion>`.
|
|
79
|
+
* @param {string} root стартова директорія проєкту (зазвичай `process.cwd()`)
|
|
80
|
+
* @param {{ bundledVersion?: string | null, silent?: boolean }} [options] `bundledVersion` — для тестів;
|
|
81
|
+
* `silent` — не писати в консоль при успішному оновленні
|
|
82
|
+
* @returns {Promise<boolean>} `true`, якщо `package.json` змінено на диску
|
|
83
|
+
*/
|
|
84
|
+
export async function ensureNitraCursorInRootDevDependencies(root, options = {}) {
|
|
85
|
+
const workspaceRoot = await readAdjacentWorkspaceRootPackageJson(root)
|
|
86
|
+
if (!workspaceRoot) {
|
|
68
87
|
return false
|
|
69
88
|
}
|
|
89
|
+
const { path: pkgPath, pkg } = workspaceRoot
|
|
70
90
|
|
|
71
91
|
const devDeps = pkg.devDependencies
|
|
72
92
|
const deps = pkg.dependencies
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Returns list of template/ files that are NOT referenced in <id>.mdc as
|
|
3
|
+
* markdown link targets. Paths returned are relative to ruleDir.
|
|
4
|
+
*
|
|
5
|
+
* @param {string} ruleDir absolute path to npm/rules/<id>/
|
|
6
|
+
* @param {string} ruleId basename (e.g. "security")
|
|
7
|
+
* @returns {Promise<string[]>}
|
|
8
|
+
*/
|
|
9
|
+
import { existsSync } from 'node:fs'
|
|
10
|
+
import { readdir, readFile, stat } from 'node:fs/promises'
|
|
11
|
+
import { join, relative } from 'node:path'
|
|
12
|
+
|
|
13
|
+
async function walkTemplateDirs(ruleDir) {
|
|
14
|
+
const out = []
|
|
15
|
+
for (const kind of ['fix', 'policy']) {
|
|
16
|
+
const kindDir = join(ruleDir, kind)
|
|
17
|
+
if (!existsSync(kindDir)) continue
|
|
18
|
+
for (const concern of await readdir(kindDir)) {
|
|
19
|
+
const tpl = join(kindDir, concern, 'template')
|
|
20
|
+
if (!existsSync(tpl)) continue
|
|
21
|
+
if (!(await stat(tpl)).isDirectory()) continue
|
|
22
|
+
out.push(...(await collectFiles(tpl)))
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
return out.map(p => relative(ruleDir, p))
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
async function collectFiles(dir) {
|
|
29
|
+
const out = []
|
|
30
|
+
for (const entry of await readdir(dir, { withFileTypes: true })) {
|
|
31
|
+
const full = join(dir, entry.name)
|
|
32
|
+
if (entry.isDirectory()) out.push(...(await collectFiles(full)))
|
|
33
|
+
else out.push(full)
|
|
34
|
+
}
|
|
35
|
+
return out
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
export async function findMissingMdcRefs(ruleDir, ruleId) {
|
|
39
|
+
const mdcPath = join(ruleDir, `${ruleId}.mdc`)
|
|
40
|
+
if (!existsSync(mdcPath)) return []
|
|
41
|
+
const mdc = await readFile(mdcPath, 'utf8')
|
|
42
|
+
const allFiles = await walkTemplateDirs(ruleDir)
|
|
43
|
+
return allFiles.filter(rel => {
|
|
44
|
+
// Match markdown link to ./<rel> or (<rel>) anywhere in the .mdc
|
|
45
|
+
return !mdc.includes(`./${rel}`) && !mdc.includes(`(${rel})`)
|
|
46
|
+
})
|
|
47
|
+
}
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import { existsSync } from 'node:fs'
|
|
2
|
+
import { readFile } from 'node:fs/promises'
|
|
3
|
+
import { basename, extname, join } from 'node:path'
|
|
4
|
+
|
|
5
|
+
const TEMPLATE_LINK_RE = /\[([^\]]+)\]\((\.\/[^)]*\/template\/[^)]+)\)/g
|
|
6
|
+
const SLOTS = ['snippet', 'deny', 'contains']
|
|
7
|
+
|
|
8
|
+
/** @param {string} filePath */
|
|
9
|
+
function langFromExt(filePath) {
|
|
10
|
+
const ext = extname(filePath)
|
|
11
|
+
if (ext === '.json') return 'json'
|
|
12
|
+
if (ext === '.toml') return 'toml'
|
|
13
|
+
if (ext === '.yml' || ext === '.yaml') return 'yaml'
|
|
14
|
+
return ''
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
// Strip `.<slot>.<ext>` suffix (slot ∈ snippet/deny/contains) to recover the
|
|
18
|
+
// real target file name (e.g. `package.json.snippet.json` → `package.json`).
|
|
19
|
+
/** @param {string} fileBasename */
|
|
20
|
+
function normalizeTargetName(fileBasename) {
|
|
21
|
+
for (const slot of SLOTS) {
|
|
22
|
+
const m = fileBasename.match(new RegExp(`^(.+)\\.${slot}\\.[^.]+$`))
|
|
23
|
+
if (m) return m[1]
|
|
24
|
+
}
|
|
25
|
+
return fileBasename
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Finds markdown links whose path contains /template/ and replaces them with
|
|
30
|
+
* inline fenced blocks. Reads file from join(ruleDir, rel-path).
|
|
31
|
+
* Throws Error if a matched link target doesn't exist (fail loud — user must know).
|
|
32
|
+
*
|
|
33
|
+
* @param {string} text .mdc file contents
|
|
34
|
+
* @param {string} ruleDir absolute path to the rule directory (e.g. .../npm/rules/security/)
|
|
35
|
+
* @returns {Promise<string>} transformed text
|
|
36
|
+
*/
|
|
37
|
+
export async function inlineTemplateLinks(text, ruleDir) {
|
|
38
|
+
const matches = [...text.matchAll(TEMPLATE_LINK_RE)]
|
|
39
|
+
if (matches.length === 0) return text
|
|
40
|
+
|
|
41
|
+
let result = text
|
|
42
|
+
for (const match of matches) {
|
|
43
|
+
const [fullMatch, , href] = match
|
|
44
|
+
// href starts with ./ and contains /template/ — already guaranteed by regex
|
|
45
|
+
const relPath = href.slice(2) // strip leading ./
|
|
46
|
+
const absPath = join(ruleDir, relPath)
|
|
47
|
+
|
|
48
|
+
if (!existsSync(absPath)) {
|
|
49
|
+
throw new Error(`inlineTemplateLinks: file not found: ${absPath} (referenced from .mdc)`)
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
const contents = (await readFile(absPath, 'utf8')).trim()
|
|
53
|
+
const lang = langFromExt(absPath)
|
|
54
|
+
const targetName = normalizeTargetName(basename(absPath))
|
|
55
|
+
const replacement = `\`${targetName}\`:\n\n\`\`\`${lang}\n${contents}\n\`\`\``
|
|
56
|
+
result = result.replace(fullMatch, () => replacement)
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
return result
|
|
60
|
+
}
|
|
@@ -15,7 +15,8 @@
|
|
|
15
15
|
* робить для opa/regal).
|
|
16
16
|
*/
|
|
17
17
|
import { spawnSync } from 'node:child_process'
|
|
18
|
-
import { existsSync } from 'node:fs'
|
|
18
|
+
import { existsSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs'
|
|
19
|
+
import { tmpdir } from 'node:os'
|
|
19
20
|
import { dirname, join } from 'node:path'
|
|
20
21
|
import { fileURLToPath } from 'node:url'
|
|
21
22
|
|
|
@@ -57,8 +58,30 @@ function failConftestMissing() {
|
|
|
57
58
|
* @property {string} namespace повне імʼя rego-пакета (наприклад `abie.base_deployment_preem`)
|
|
58
59
|
* @property {string[]} files список абсолютних шляхів файлів для перевірки (порожній — повертаємо порожньо)
|
|
59
60
|
* @property {string[]} [extraArgs] додаткові аргументи для conftest (наприклад `--combine` для крос-документних правил)
|
|
61
|
+
* @property {object} [templateData] опціональне merged-дерево; серіалізується у JSON `{ "template": <data> }` і передається як `--data <tmpfile>` (cleanup після завершення)
|
|
60
62
|
*/
|
|
61
63
|
|
|
64
|
+
/**
|
|
65
|
+
* Pure args builder for conftest test. Extracted for unit-testability.
|
|
66
|
+
* Preserves the existing args layout (files before -p; --output json --no-color
|
|
67
|
+
* for parseable output); inserts --data right after --namespace when provided.
|
|
68
|
+
* @param {{ policyAbs: string, namespace: string, files: string[], extraArgs: string[], tmpDataFile: string|null }} p
|
|
69
|
+
* @returns {string[]}
|
|
70
|
+
*/
|
|
71
|
+
export function buildConftestArgs(p) {
|
|
72
|
+
const args = [
|
|
73
|
+
'test',
|
|
74
|
+
...p.files,
|
|
75
|
+
'-p',
|
|
76
|
+
p.policyAbs,
|
|
77
|
+
'--namespace',
|
|
78
|
+
p.namespace
|
|
79
|
+
]
|
|
80
|
+
if (p.tmpDataFile) args.push('--data', p.tmpDataFile)
|
|
81
|
+
args.push('--output', 'json', '--no-color', ...p.extraArgs)
|
|
82
|
+
return args
|
|
83
|
+
}
|
|
84
|
+
|
|
62
85
|
/**
|
|
63
86
|
* Виконує `conftest test` для всіх файлів одним спавном і повертає масив
|
|
64
87
|
* порушень. Якщо `files` порожній — повертає `[]` без спавна. Якщо `conftest`
|
|
@@ -81,40 +104,44 @@ export function runConftestBatch(opts) {
|
|
|
81
104
|
if (!existsSync(policyAbs)) {
|
|
82
105
|
throw new Error(`runConftestBatch: rego-каталог не знайдено: ${policyAbs}`)
|
|
83
106
|
}
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
'-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
opts.namespace,
|
|
91
|
-
'--output',
|
|
92
|
-
'json',
|
|
93
|
-
'--no-color',
|
|
94
|
-
...(opts.extraArgs ?? [])
|
|
95
|
-
]
|
|
96
|
-
const result = spawnSync(conftestBin, args, { encoding: 'utf8' })
|
|
97
|
-
if (result.error) {
|
|
98
|
-
throw result.error
|
|
107
|
+
let tmpDataDir = null
|
|
108
|
+
let tmpDataFile = null
|
|
109
|
+
if (opts.templateData) {
|
|
110
|
+
tmpDataDir = mkdtempSync(join(tmpdir(), 'n-cursor-tpl-'))
|
|
111
|
+
tmpDataFile = join(tmpDataDir, 'template-data.json')
|
|
112
|
+
writeFileSync(tmpDataFile, JSON.stringify({ template: opts.templateData }))
|
|
99
113
|
}
|
|
100
|
-
// conftest exit 1 = є failures (це валідно для нас); >1 = справжня помилка.
|
|
101
|
-
if (result.status !== 0 && result.status !== 1) {
|
|
102
|
-
throw new Error(`conftest exit ${result.status}: ${(result.stderr || result.stdout || '').slice(0, 500)}`)
|
|
103
|
-
}
|
|
104
|
-
/** @type {Array<{ filename: string, namespace: string, failures?: Array<{ msg: string }> }>} */
|
|
105
|
-
let parsed
|
|
106
114
|
try {
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
const
|
|
115
|
-
|
|
116
|
-
|
|
115
|
+
const args = buildConftestArgs({
|
|
116
|
+
policyAbs,
|
|
117
|
+
namespace: opts.namespace,
|
|
118
|
+
files: opts.files,
|
|
119
|
+
extraArgs: opts.extraArgs ?? [],
|
|
120
|
+
tmpDataFile
|
|
121
|
+
})
|
|
122
|
+
const result = spawnSync(conftestBin, args, { encoding: 'utf8' })
|
|
123
|
+
if (result.error) throw result.error
|
|
124
|
+
// conftest exit 1 = є failures (це валідно для нас); >1 = справжня помилка.
|
|
125
|
+
if (result.status !== 0 && result.status !== 1) {
|
|
126
|
+
throw new Error(`conftest exit ${result.status}: ${(result.stderr || result.stdout || '').slice(0, 500)}`)
|
|
127
|
+
}
|
|
128
|
+
/** @type {Array<{ filename: string, namespace: string, failures?: Array<{ msg: string }> }>} */
|
|
129
|
+
let parsed
|
|
130
|
+
try {
|
|
131
|
+
parsed = JSON.parse(result.stdout)
|
|
132
|
+
} catch {
|
|
133
|
+
throw new Error(`conftest stdout не парситься як JSON: ${(result.stdout || '').slice(0, 200)}`)
|
|
134
|
+
}
|
|
135
|
+
/** @type {ConftestViolation[]} */
|
|
136
|
+
const out = []
|
|
137
|
+
for (const entry of parsed) {
|
|
138
|
+
const failures = entry.failures ?? []
|
|
139
|
+
for (const f of failures) {
|
|
140
|
+
out.push({ filename: entry.filename, namespace: entry.namespace, message: f.msg })
|
|
141
|
+
}
|
|
117
142
|
}
|
|
143
|
+
return out
|
|
144
|
+
} finally {
|
|
145
|
+
if (tmpDataDir) rmSync(tmpDataDir, { recursive: true, force: true })
|
|
118
146
|
}
|
|
119
|
-
return out
|
|
120
147
|
}
|
|
@@ -15,9 +15,11 @@
|
|
|
15
15
|
import { readFile } from 'node:fs/promises'
|
|
16
16
|
import { join } from 'node:path'
|
|
17
17
|
|
|
18
|
+
import { findMissingMdcRefs } from './check-mdc-template-refs.mjs'
|
|
18
19
|
import { createCheckReporter } from './check-reporter.mjs'
|
|
19
20
|
import { resolveTargetFiles } from './resolve-target-files.mjs'
|
|
20
21
|
import { runConftestBatch } from './run-conftest-batch.mjs'
|
|
22
|
+
import { resolveConcernTemplateData } from './template.mjs'
|
|
21
23
|
|
|
22
24
|
const APPLIES_CONCERN_NAME = 'applies'
|
|
23
25
|
|
|
@@ -80,10 +82,13 @@ async function runPolicyConcern(bundledRulesDir, ruleId, concernName, walkCache)
|
|
|
80
82
|
// Rego не дозволяє '-' в імені пакета, тому kebab-id у `.n-cursor.json:rules`
|
|
81
83
|
// мапиться на snake у namespace. Файлова структура `rules/<id>/policy/` лишається kebab.
|
|
82
84
|
const regoNamespace = `${ruleId.replaceAll('-', '_')}.${concernName}`
|
|
85
|
+
const concernAbsDir = join(bundledRulesDir, ruleId, 'policy', concernName)
|
|
86
|
+
const templateData = await resolveConcernTemplateData(concernAbsDir, target)
|
|
83
87
|
const violations = runConftestBatch({
|
|
84
88
|
policyDirRel: `${ruleId}/${concernName}`,
|
|
85
89
|
namespace: regoNamespace,
|
|
86
|
-
files
|
|
90
|
+
files,
|
|
91
|
+
templateData
|
|
87
92
|
})
|
|
88
93
|
if (violations.length === 0) {
|
|
89
94
|
reporter.pass(`${concernName}: ${files.length} файл(ів) OK (rego)`)
|
|
@@ -127,5 +132,15 @@ export async function runRule(rule, bundledRulesDir, walkCache) {
|
|
|
127
132
|
if (code !== 0) totalCode = 1
|
|
128
133
|
}
|
|
129
134
|
|
|
135
|
+
const ruleDir = join(bundledRulesDir, rule.id)
|
|
136
|
+
const missing = await findMissingMdcRefs(ruleDir, rule.id)
|
|
137
|
+
if (missing.length > 0) {
|
|
138
|
+
const reporter = createCheckReporter()
|
|
139
|
+
for (const rel of missing) {
|
|
140
|
+
reporter.fail(`${rule.id}.mdc: відсутнє markdown-посилання на template-файл ${rel}`)
|
|
141
|
+
}
|
|
142
|
+
if (reporter.getExitCode() !== 0) totalCode = 1
|
|
143
|
+
}
|
|
144
|
+
|
|
130
145
|
return totalCode
|
|
131
146
|
}
|