@nitra/cursor 1.8.94 → 1.8.95

package/mdc/graphql.mdc

@@ -0,0 +1,33 @@
+---
+description: GraphQL у коді (tagged template `gql`) — GraphQL Config і розширення VS Code
+alwaysApply: true
+version: '1.0'
+---
+
+Якщо в **`.vue`** або в **JavaScript / TypeScript** джерелах (`.js`, `.mjs`, `.cjs`, `.ts`, `.tsx`, `.jsx` тощо) зустрічається **tagged template literal** з тегом **`gql`** (типово `gql\`query …\`` для GraphQL-запиту), у **корені репозиторію** має бути файл **`.graphqlrc.yml`** ([GraphQL Config](https://the-guild.dev/graphql/config/docs)), а в **`.vscode/extensions.json`** у масиві **`recommendations`** — запис **`graphql.vscode-graphql`**, щоб підсвітка, навігація до схеми й діагностика працювали в редакторі.
+
+Деталі виявлення `gql` у скриптах (у т.ч. лише `<script>` у SFC) — **`npm/scripts/check-graphql.mjs`** / **`npm/scripts/utils/graphql-gql-scan.mjs`**.
+
+## `.graphqlrc.yml`
+
+Підстав свої шляхи до схеми та до файлів з операціями; приклад орієнтиру:
+
+```yaml title=".graphqlrc.yml"
+schema: schema.graphql
+documents:
+  - '**/*.{vue,js,ts,tsx}'
+```
+
+## `.vscode/extensions.json`
+
+Додай **`graphql.vscode-graphql`** до наявного списку **`recommendations`** (не замінюй інші записи):
+
+```json title=".vscode/extensions.json"
+{
+  "recommendations": ["graphql.vscode-graphql"]
+}
+```
+
+## Перевірка
+
+`npx @nitra/cursor check graphql`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nitra/cursor",
-  "version": "1.8.94",
+  "version": "1.8.95",
   "description": "CLI для завантаження cursor-правил (префікс n-) у локальний репозиторій",
   "keywords": [
     "cli",

package/scripts/check-graphql.mjs

@@ -0,0 +1,97 @@
+/**
+ * Перевіряє правило graphql.mdc: наявність **`.graphqlrc.yml`** і рекомендації **`graphql.vscode-graphql`**, якщо у дереві є **`gql\`…\``**.
+ *
+ * Обхід репозиторію — **`walkDir`** від **`process.cwd()`** (пропуски як у інших check). Кандидати — **`.vue`** та **`.js`/`.ts`/`.jsx`/`.tsx`** тощо; ігнор **`.d.ts`**, **auto-imports.d.ts** тощо — **`shouldSkipFileForGqlScan`**.
+ *
+ * Виявлення **`gql`** — **oxc-parser** після витягування `<script>` з SFC (**`graphql-gql-scan.mjs`**). Якщо збігів немає — перевірка завершується успішно без вимог до конфігів.
+ */
+import { existsSync } from 'node:fs'
+import { readFile } from 'node:fs/promises'
+import { relative } from 'node:path'
+
+import { createCheckReporter } from './utils/check-reporter.mjs'
+import {
+  isGqlScanSourceFile,
+  shouldSkipFileForGqlScan,
+  sourceFileHasGqlTaggedTemplate
+} from './utils/graphql-gql-scan.mjs'
+import { walkDir } from './utils/walkDir.mjs'
+
+/** Очікуваний файл GraphQL Config у корені (graphql.mdc). */
+export const GRAPHQL_RC_FILENAME = '.graphqlrc.yml'
+
+/** Розширення VS Code з graphql.mdc. */
+export const REQUIRED_GRAPHQL_VSCODE_EXTENSION = 'graphql.vscode-graphql'
+
+/**
+ * Перевіряє graphql.mdc: умовна вимога `.graphqlrc.yml` і `graphql.vscode-graphql` за наявності `gql`…``.
+ * @returns {Promise<number>} 0 — OK, 1 — порушення
+ */
+export async function check() {
+  const reporter = createCheckReporter()
+  const { pass, fail } = reporter
+
+  const root = process.cwd()
+  /** @type {string[]} */
+  const candidates = []
+  await walkDir(root, absPath => {
+    const rel = relative(root, absPath).split('\\').join('/')
+    if (shouldSkipFileForGqlScan(rel) || !isGqlScanSourceFile(rel)) {
+      return
+    }
+    candidates.push(absPath)
+  })
+
+  /** @type {string[]} */
+  const hits = []
+  for (const absPath of candidates) {
+    const rel = relative(root, absPath).split('\\').join('/')
+    const content = await readFile(absPath, 'utf8')
+    if (sourceFileHasGqlTaggedTemplate(content, rel)) {
+      hits.push(rel)
+    }
+  }
+
+  if (hits.length === 0) {
+    pass(`Немає tagged template з тегом gql у .vue / JS / TS джерелах (переглянуто ${candidates.length} файлів) — .graphqlrc.yml не вимагається`)
+    return reporter.getExitCode()
+  }
+
+  pass(`Знайдено gql\`…\` у ${hits.length} файлі(ах): ${hits.slice(0, 5).join(', ')}${hits.length > 5 ? '…' : ''}`)
+
+  if (!existsSync(GRAPHQL_RC_FILENAME)) {
+    fail(
+      `Відсутній ${GRAPHQL_RC_FILENAME} у корені — додай GraphQL Config (graphql.mdc), бо в проєкті є gql template literals`
+    )
+  } else {
+    pass(`${GRAPHQL_RC_FILENAME} існує`)
+  }
+
+  if (!existsSync('.vscode/extensions.json')) {
+    fail(
+      '.vscode/extensions.json не існує — створи файл і додай у recommendations graphql.vscode-graphql (graphql.mdc)'
+    )
+  } else {
+    let ext
+    try {
+      ext = JSON.parse(await readFile('.vscode/extensions.json', 'utf8'))
+    } catch {
+      fail('.vscode/extensions.json не є валідним JSON')
+      ext = null
+    }
+    if (ext) {
+      const rec = ext.recommendations
+      if (!Array.isArray(rec)) {
+        fail('.vscode/extensions.json: поле recommendations має бути масивом')
+      } else if (!rec.includes(REQUIRED_GRAPHQL_VSCODE_EXTENSION)) {
+        fail(
+          `.vscode/extensions.json: додай у recommendations "${REQUIRED_GRAPHQL_VSCODE_EXTENSION}" (graphql.mdc)`
+        )
+      } else {
+        pass(`.vscode/extensions.json: є ${REQUIRED_GRAPHQL_VSCODE_EXTENSION}`)
+      }
+    }
+  }
+
+  return reporter.getExitCode()
+}

package/scripts/utils/graphql-gql-scan.mjs

@@ -0,0 +1,115 @@
+/**
+ * Пошук tagged template **`gql\`…\``** у джерелах для правила graphql.mdc.
+ *
+ * Для **`.vue`** береться лише вміст `<script>` / `<script setup>` (спільна логіка з **vue-forbidden-imports**).
+ * Семантику визначає **oxc-parser** (`program`): рекурсивний обхід AST, збіг лише для **Identifier** з іменем **`gql`** як тега шаблону.
+ */
+import { parseSync } from 'oxc-parser'
+
+import {
+  contentForVueImportScan,
+  isVueImportScanSourceFile,
+  shouldSkipFileForVueImportScan
+} from './vue-forbidden-imports.mjs'
+
+/**
+ * Мова для Oxc за шляхом файлу (розширення).
+ * @param {string} filePath віртуальний або реальний шлях
+ * @returns {'js' | 'jsx' | 'ts' | 'tsx'}
+ */
+function langFromPath(filePath) {
+  const lower = filePath.toLowerCase()
+  if (lower.endsWith('.tsx')) {
+    return 'tsx'
+  }
+  if (lower.endsWith('.ts') || lower.endsWith('.mts') || lower.endsWith('.cts')) {
+    return 'ts'
+  }
+  if (lower.endsWith('.jsx')) {
+    return 'jsx'
+  }
+  return 'js'
+}
+
+/**
+ * Віртуальний шлях для парсера: SFC розбираємо як TypeScript.
+ * @param {string} relativePath відносний шлях до файлу
+ * @returns {string}
+ */
+function virtualPathForParse(relativePath) {
+  if (relativePath.endsWith('.vue')) {
+    return relativePath.replace(/\.vue$/u, '.ts')
+  }
+  return relativePath
+}
+
+/**
+ * Чи містить AST хоча б один `gql` tagged template.
+ * @param {unknown} node корінь або вузол AST
+ * @returns {boolean}
+ */
+function astContainsGqlTag(node) {
+  if (node === null || node === undefined) {
+    return false
+  }
+  if (typeof node !== 'object') {
+    return false
+  }
+  if (Array.isArray(node)) {
+    return node.some(astContainsGqlTag)
+  }
+  if (node.type === 'TaggedTemplateExpression') {
+    const tag = node.tag
+    if (tag?.type === 'Identifier' && tag.name === 'gql') {
+      return true
+    }
+  }
+  for (const key of Object.keys(node)) {
+    if (key === 'loc' || key === 'range') {
+      continue
+    }
+    if (astContainsGqlTag(node[key])) {
+      return true
+    }
+  }
+  return false
+}
+
+/**
+ * Перевіряє один файл: є у скрипті (або у всьому не-vue) tagged template з тегом **`gql`**.
+ * @param {string} content сирий вміст файлу
+ * @param {string} relativePath відносний шлях (posix)
+ * @returns {boolean} true, якщо знайдено `gql`…``
+ */
+export function sourceFileHasGqlTaggedTemplate(content, relativePath) {
+  const scan = contentForVueImportScan(content, relativePath)
+  const pathForLang = virtualPathForParse(relativePath)
+  const lang = langFromPath(pathForLang)
+  try {
+    const result = parseSync(pathForLang, scan, { lang, sourceType: 'module' })
+    if (result.errors?.length) {
+      return false
+    }
+    return astContainsGqlTag(result.program)
+  } catch {
+    return false
+  }
+}
+
+/**
+ * Чи підлягає файл скануванню за розширенням (узгоджено з vue-import scan).
+ * @param {string} relativePath відносний шлях
+ * @returns {boolean}
+ */
+export function isGqlScanSourceFile(relativePath) {
+  return isVueImportScanSourceFile(relativePath)
+}
+
+/**
+ * Чи пропустити файл (декларації, auto-imports) — ті самі критерії, що для vue-import scan.
+ * @param {string} relativePosix шлях з posix-слешами
+ * @returns {boolean}
+ */
+export function shouldSkipFileForGqlScan(relativePosix) {
+  return shouldSkipFileForVueImportScan(relativePosix)
+}