@nitra/cursor 1.0.12 → 1.1.0

package/bin/nitra-cursor.js

@@ -1,21 +1,22 @@
 #!/usr/bin/env node
 
 /**
- * @nitra/cursor CLI
+ * nitra-cursor — CLI завантаження правил
  *
- * Завантажує cursor-правила з npm-пакету @nitra/cursor у локальний репозиторій.
+ * Завантажує cursor-правила з npm-пакету nitra-cursor у локальний репозиторій.
  *
  * Використання:
  *   npx @nitra/cursor
  *
- * Перед запуском у цільовому репо потрібно створити файл nitra-cursor.json
- * зі списком правил для завантаження.
+ * Якщо у корені репозиторію немає nitra-cursor.json, він створюється автоматично
+ * з усіма правилами з каталогу mdc пакету (їх можна відредагувати після створення).
  */
 
-import { readFile, writeFile, mkdir } from 'node:fs/promises'
 import { existsSync } from 'node:fs'
-import { join, basename } from 'node:path'
+import { mkdir, readdir, readFile, writeFile } from 'node:fs/promises'
+import { basename, dirname, join } from 'node:path'
 import { cwd } from 'node:process'
+import { fileURLToPath } from 'node:url'
 
 const PACKAGE_NAME = '@nitra/cursor'
 const UNPKG_BASE = 'https://unpkg.com'
@@ -23,10 +24,36 @@ const CONFIG_FILE = 'nitra-cursor.json'
 const RULES_DIR = '.cursor/rules'
 const RULE_PREFIX = 'nitra-'
 
+const binDir = dirname(fileURLToPath(import.meta.url))
+const BUNDLED_MDC_DIR = join(binDir, '..', 'mdc')
+
+/**
+ * Імена правил (без .mdc) з каталогу mdc поточної інсталяції пакету
+ * @returns {Promise<string[]>} відсортовані імена файлів правил без суфікса .mdc
+ */
+async function discoverBundledRuleNames() {
+  if (!existsSync(BUNDLED_MDC_DIR)) {
+    throw new Error(
+      `Не знайдено каталог правил пакету.\n` +
+        `Очікуваний шлях: ${BUNDLED_MDC_DIR}\n` +
+        `Перевстановіть ${PACKAGE_NAME} або створіть ${CONFIG_FILE} вручну.`
+    )
+  }
+  const names = await readdir(BUNDLED_MDC_DIR)
+  const rules = names
+    .filter(n => n.endsWith('.mdc'))
+    .map(n => n.slice(0, -'.mdc'.length))
+    .sort((a, b) => a.localeCompare(b))
+  if (rules.length === 0) {
+    throw new Error(`У каталозі mdc пакету немає файлів .mdc. Створіть ${CONFIG_FILE} вручну.`)
+  }
+  return rules
+}
+
 /**
  * Завантажує текст з URL
- * @param {string} url
- * @returns {Promise<string>}
+ * @param {string} url адреса HTTP(S)
+ * @returns {Promise<string>} тіло відповіді як UTF-8 текст
  */
 async function fetchText(url) {
   const response = await fetch(url)
@@ -38,17 +65,18 @@ async function fetchText(url) {
 
 /**
  * Зчитує конфіг nitra-cursor.json з поточної директорії
- * @returns {Promise<{rules: string[], version?: string}>}
+ * @returns {Promise<{rules: string[], version?: string}>} об'єкт з масивом rules і опційно version; при відсутності файлу створює дефолтний конфіг
  */
 async function readConfig() {
   const configPath = join(cwd(), CONFIG_FILE)
   if (!existsSync(configPath)) {
-    throw new Error(
-      `Файл конфігурації не знайдено: ${CONFIG_FILE}\n` +
-      `Створіть файл ${CONFIG_FILE} у корені репозиторію.\n` +
-      `Приклад:\n` +
-      `{\n  "rules": ["js-format", "npm-module", "spell"]\n}`
+    const rules = await discoverBundledRuleNames()
+    const defaultConfig = { rules }
+    await writeFile(configPath, `${JSON.stringify(defaultConfig, null, 2)}\n`, 'utf8')
+    console.log(
+      `📝 Створено ${CONFIG_FILE} з усіма правилами з пакету (${rules.length}). ` + `За потреби відредагуйте список.\n`
     )
+    return defaultConfig
   }
   const raw = await readFile(configPath, 'utf8')
   let config
@@ -65,9 +93,9 @@ async function readConfig() {
 
 /**
  * Повертає URL для завантаження правила з unpkg
- * @param {string} ruleName — ім'я без розширення, наприклад "js-format"
- * @param {string} [version] — версія пакету (необов'язково, за замовчуванням "latest")
- * @returns {string}
+ * @param {string} ruleName - ім'я без розширення, наприклад "js-format"
+ * @param {string} [version] - версія пакету (необов'язково, за замовчуванням "latest")
+ * @returns {string} повний URL файлу правила на unpkg
  */
 function buildUrl(ruleName, version) {
   const name = ruleName.endsWith('.mdc') ? ruleName : `${ruleName}.mdc`
@@ -79,63 +107,59 @@ function buildUrl(ruleName, version) {
  * Витягує чисте ім'я файлу правила (без шляху, але зберігає .mdc)
  * "npm/mdc/js-format.mdc" → "js-format.mdc"
  * "js-format"              → "js-format.mdc"
- * @param {string} ruleName
- * @returns {string}
+ * @param {string} ruleName шлях або базове ім'я, з суфіксом .mdc або без
+ * @returns {string} лише ім'я файлу з суфіксом .mdc
  */
 function normalizeRuleName(ruleName) {
   const name = ruleName.endsWith('.mdc') ? ruleName : `${ruleName}.mdc`
   return basename(name)
 }
 
-async function main() {
-  console.log(`\n🔧 @nitra/cursor — завантаження cursor-правил\n`)
+console.log(`\n🔧 @nitra/cursor — завантаження cursor-правил\n`)
 
-  // 1. Зчитуємо конфіг
-  let config
-  try {
-    config = await readConfig()
-  } catch (err) {
-    console.error(`❌ ${err.message}`)
-    process.exit(1)
-  }
+// 1. Зчитуємо конфіг
+let config
+try {
+  config = await readConfig()
+} catch (error) {
+  console.error(`❌ ${error.message}`)
+  process.exit(1)
+}
 
-  const { rules, version } = config
-  if (version) {
-    console.log(`📦 Версія пакету: ${version}`)
-  }
-  console.log(`📋 Правил до завантаження: ${rules.length}`)
-
-  // 2. Створюємо директорію .cursor/rules якщо не існує
-  const rulesDir = join(cwd(), RULES_DIR)
-  await mkdir(rulesDir, { recursive: true })
-
-  // 3. Завантажуємо та зберігаємо кожне правило
-  let successCount = 0
-  let failCount = 0
-
-  for (const rule of rules) {
-    const url = buildUrl(rule, version)
-    const fileName = `${RULE_PREFIX}${normalizeRuleName(rule)}`
-    const destPath = join(rulesDir, fileName)
-
-    try {
-      process.stdout.write(`  ⬇  ${rule} → ${RULES_DIR}/${fileName} ... `)
-      const content = await fetchText(url)
-      await writeFile(destPath, content, 'utf8')
-      console.log(`✅`)
-      successCount++
-    } catch (err) {
-      console.log(`❌`)
-      console.error(`     Помилка: ${err.message}`)
-      failCount++
-    }
-  }
+const { rules, version } = config
+if (version) {
+  console.log(`📦 Версія пакету: ${version}`)
+}
+console.log(`📋 Правил до завантаження: ${rules.length}`)
 
-  // 4. Підсумок
-  console.log(`\n✨ Готово: ${successCount} завантажено, ${failCount} з помилками\n`)
-  if (failCount > 0) {
-    process.exit(1)
+// 2. Створюємо директорію .cursor/rules якщо не існує
+const rulesDir = join(cwd(), RULES_DIR)
+await mkdir(rulesDir, { recursive: true })
+
+// 3. Завантажуємо та зберігаємо кожне правило
+let successCount = 0
+let failCount = 0
+
+for (const rule of rules) {
+  const url = buildUrl(rule, version)
+  const fileName = `${RULE_PREFIX}${normalizeRuleName(rule)}`
+  const destPath = join(rulesDir, fileName)
+
+  try {
+    process.stdout.write(`  ⬇  ${rule} → ${RULES_DIR}/${fileName} ... `)
+    const content = await fetchText(url)
+    await writeFile(destPath, content, 'utf8')
+    console.log(`✅`)
+    successCount++
+  } catch (error) {
+    console.log(`❌`)
+    console.error(`     Помилка: ${error.message}`)
+    failCount++
   }
 }
 
-main()
+// 4. Підсумок
+console.log(`\n✨ Готово: ${successCount} завантажено, ${failCount} з помилками\n`)
+if (failCount > 0) {
+  process.exit(1)
+}

package/mdc/js-format.mdc

@@ -1,7 +1,7 @@
 ---
 description: Правила форматів JavaScript ecosystem
 alwaysApply: true
-version: '1.1'
+version: '1.2'
 ---
 
 В корені проекту є файл з правилами форматування для oxfmt:
@@ -94,4 +94,6 @@ version: '1.1'
 }
 ```
 
-Також потрібно прибрати якщо є в проекті модул @nitra/prettier-config та prettier та всі виклики prettier і налаштування для нього.
+Також потрібно прибрати якщо є в проекті модул @nitra/prettier-config та prettier та всі виклики prettier і налаштування для нього.
+
+Завжди пиши JSDoc до функцій та методів.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nitra/cursor",
-  "version": "1.0.12",
+  "version": "1.1.0",
   "description": "CLI для завантаження cursor-правил Nitra у локальний репозиторій",
   "keywords": [
     "cli",