@nitra/cursor 1.8.104 → 1.8.106

package/scripts/check-graphql.mjs

@@ -1,5 +1,7 @@
 /**
- * Перевіряє правило graphql.mdc: наявність **`.graphqlrc.yml`** і рекомендації **`graphql.vscode-graphql`**, якщо у дереві є **`gql\`…\``**.
+ * Перевіряє правило graphql.mdc: наявність **`.graphqlrc.yml`**, рекомендації
+ * **`graphql.vscode-graphql`** і скрипта **`dump-schema`** у кореневому
+ * **`package.json`**, якщо у дереві є **`gql\`…\``**.
  *
  * Обхід репозиторію — **`walkDir`** від **`process.cwd()`** (пропуски як у інших check). Кандидати — **`.vue`** та **`.js`/`.ts`/`.jsx`/`.tsx`** тощо; пропуск **`.d.ts`**, **auto-imports.d.ts** тощо — **`shouldSkipFileForGqlScan`**.
  *
@@ -22,16 +24,16 @@ export const GRAPHQL_RC_FILENAME = '.graphqlrc.yml'
 
 /** Розширення VS Code з graphql.mdc. */
 export const REQUIRED_GRAPHQL_VSCODE_EXTENSION = 'graphql.vscode-graphql'
+/** Команда dump-schema з graphql.mdc. */
+export const REQUIRED_DUMP_SCHEMA_SCRIPT =
+  "bunx graphqurl http://localhost:4040/v1/graphql -H 'X-Hasura-Admin-Secret: secret' --introspect > schema.graphql"
 
 /**
- * Перевіряє graphql.mdc: умовна вимога .graphqlrc.yml і graphql.vscode-graphql за наявності gql tagged templates.
- * @returns {Promise<number>} 0 — OK, 1 — порушення
+ * Збирає абсолютні шляхи source-файлів, які підлягають скануванню на gql templates.
+ * @param {string} root абсолютний шлях кореня
+ * @returns {Promise<string[]>} список кандидатів
  */
-export async function check() {
-  const reporter = createCheckReporter()
-  const { pass, fail } = reporter
-
-  const root = process.cwd()
+async function collectScanCandidates(root) {
   /** @type {string[]} */
   const candidates = []
   await walkDir(root, absPath => {
@@ -41,7 +43,16 @@ export async function check() {
     }
     candidates.push(absPath)
   })
+  return candidates
+}
 
+/**
+ * Повертає відносні шляхи файлів, де знайдено gql tagged template.
+ * @param {string} root абсолютний шлях кореня
+ * @param {string[]} candidates абсолютні шляхи файлів-кандидатів
+ * @returns {Promise<string[]>} відносні шляхи файлів зі збігами
+ */
+async function collectGqlHits(root, candidates) {
   /** @type {string[]} */
   const hits = []
   for (const absPath of candidates) {
@@ -51,9 +62,99 @@ export async function check() {
       hits.push(rel)
     }
   }
+  return hits
+}
+
+/**
+ * Перевіряє `.vscode/extensions.json` на рекомендацію GraphQL extension.
+ * @param {(msg: string) => void} pass success-репортер
+ * @param {(msg: string) => void} fail fail-репортер
+ * @returns {Promise<void>}
+ */
+async function checkExtensionsRecommendation(pass, fail) {
+  if (!existsSync('.vscode/extensions.json')) {
+    fail(
+      '.vscode/extensions.json не існує — створи файл і додай у recommendations graphql.vscode-graphql (graphql.mdc)'
+    )
+    return
+  }
+
+  let ext
+  try {
+    ext = JSON.parse(await readFile('.vscode/extensions.json', 'utf8'))
+  } catch {
+    fail('.vscode/extensions.json не є валідним JSON')
+    return
+  }
+
+  const rec = ext.recommendations
+  if (!Array.isArray(rec)) {
+    fail('.vscode/extensions.json: поле recommendations має бути масивом')
+    return
+  }
+
+  if (rec.includes(REQUIRED_GRAPHQL_VSCODE_EXTENSION)) {
+    pass(`.vscode/extensions.json: є ${REQUIRED_GRAPHQL_VSCODE_EXTENSION}`)
+  } else {
+    fail(`.vscode/extensions.json: додай у recommendations "${REQUIRED_GRAPHQL_VSCODE_EXTENSION}" (graphql.mdc)`)
+  }
+}
+
+/**
+ * Перевіряє `package.json` і значення scripts.dump-schema.
+ * @param {(msg: string) => void} pass success-репортер
+ * @param {(msg: string) => void} fail fail-репортер
+ * @returns {Promise<void>}
+ */
+async function checkPackageDumpSchemaScript(pass, fail) {
+  if (!existsSync('package.json')) {
+    fail('Відсутній package.json у корені репозиторію')
+    return
+  }
+
+  let pkg
+  try {
+    pkg = JSON.parse(await readFile('package.json', 'utf8'))
+  } catch {
+    fail('package.json не є валідним JSON')
+    return
+  }
+
+  const scripts = pkg.scripts
+  if (!scripts || typeof scripts !== 'object' || Array.isArray(scripts)) {
+    fail('package.json: поле scripts має бути обʼєктом')
+    return
+  }
+
+  if (!Object.hasOwn(scripts, 'dump-schema')) {
+    fail('package.json: відсутній scripts.dump-schema (graphql.mdc)')
+    return
+  }
+
+  if (scripts['dump-schema'] === REQUIRED_DUMP_SCHEMA_SCRIPT) {
+    pass('package.json: scripts.dump-schema відповідає graphql.mdc')
+  } else {
+    fail(`package.json: scripts.dump-schema має бути "${REQUIRED_DUMP_SCHEMA_SCRIPT}" (graphql.mdc)`)
+  }
+}
+
+/**
+ * Перевіряє graphql.mdc: умовна вимога .graphqlrc.yml, graphql.vscode-graphql
+ * і scripts.dump-schema за наявності gql tagged templates.
+ * @returns {Promise<number>} 0 — OK, 1 — порушення
+ */
+export async function check() {
+  const reporter = createCheckReporter()
+  const { pass, fail } = reporter
+
+  const root = process.cwd()
+  const candidates = await collectScanCandidates(root)
+  const hits = await collectGqlHits(root, candidates)
 
   if (hits.length === 0) {
-    pass(`Немає tagged template з тегом gql у .vue / JS / TS джерелах (переглянуто ${candidates.length} файлів) — .graphqlrc.yml не вимагається`)
+    pass(
+      `Немає tagged template з тегом gql у .vue / JS / TS джерелах (переглянуто ${candidates.length} файлів) — .graphqlrc.yml не вимагається`
+    )
     return reporter.getExitCode()
   }
 
@@ -67,31 +168,8 @@ export async function check() {
     )
   }
 
-  if (existsSync('.vscode/extensions.json')) {
-    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)) {
-        pass(`.vscode/extensions.json: є ${REQUIRED_GRAPHQL_VSCODE_EXTENSION}`)
-      } else {
-        fail(
-          `.vscode/extensions.json: додай у recommendations "${REQUIRED_GRAPHQL_VSCODE_EXTENSION}" (graphql.mdc)`
-        )
-      }
-    }
-  } else {
-    fail(
-      '.vscode/extensions.json не існує — створи файл і додай у recommendations graphql.vscode-graphql (graphql.mdc)'
-    )
-  }
+  await checkExtensionsRecommendation(pass, fail)
+  await checkPackageDumpSchemaScript(pass, fail)
 
   return reporter.getExitCode()
 }