@vv0rkz/js-template 1.9.0 → 1.10.0

package/README.md

@@ -58,6 +58,12 @@ export default {
       formats: ['gif', 'png'],       // допустимые форматы
       style: 'click',                // 'click' | 'side-by-side'
     },
+    // Pre-run хук: перед каждой jst-командой сравнивает теги ↔ Releases ↔
+    // демо ↔ README и выводит предупреждения (не блокирует команду).
+    audit: {
+      enable: true,
+      warnOnly: true,
+    },
   },
 
   // Автообновление зависимостей
@@ -115,6 +121,10 @@ npx jst <команда>       # напрямую
 | `setup-deps` | Настроить dependabot/renovate (+ auto-merge workflow) |
 | `setup-ci` | Сгенерировать `.github/workflows/ci.yml` |
 | `setup-branch-protection` | Настроить защиту главной ветки через `gh api` |
+| `audit` | Проверить теги/Releases/демо/README на пробелы |
+| `fix-releases` | Создать GitHub Release для тегов без Release |
+
+> Audit запускается автоматически перед каждой `jst`-командой (кроме `init`, `upgrade`, `audit`, `fix-releases`). Отключить разово — флагом `--no-audit`: `jst --no-audit create-task "..."`. Полностью — в `jst.config.js`: `release.audit.enable = false`.
 
 ### Разработка
 

package/bin/cli.js

@@ -7,6 +7,13 @@ import { fileURLToPath } from 'url'
 const __dirname = dirname(fileURLToPath(import.meta.url))
 const toolsDir = join(__dirname, '../tools-gh')
 
+// Strip the global `--no-audit` flag from argv before anyone else looks at it,
+// so downstream command handlers (some of which read process.argv directly)
+// don't see it as a positional argument.
+const noAuditIndex = process.argv.indexOf('--no-audit')
+const noAudit = noAuditIndex !== -1
+if (noAudit) process.argv.splice(noAuditIndex, 1)
+
 const args = process.argv.slice(2)
 const command = args[0]
 const commandArgs = args.slice(1)
@@ -15,6 +22,16 @@ const isWin = platform() === 'win32'
 const npxCmd = isWin ? 'npx.cmd' : 'npx'
 const ghCmd = isWin ? 'gh.exe' : 'gh'
 
+// Commands that should NOT trigger the release audit pre-run hook.
+// `init` runs before tags exist; `audit` / `fix-releases` ARE the audit
+// itself; `upgrade` runs right after `npm update` and may pre-date tags.
+const SKIP_AUDIT = new Set(['audit', 'fix-releases', 'init', 'upgrade', undefined])
+
+function maybeRunAudit() {
+  if (noAudit || SKIP_AUDIT.has(command)) return
+  spawnSync('node', [join(toolsDir, 'release-audit.js'), '--quiet-if-clean'], { stdio: 'inherit' })
+}
+
 const commands = {
   init: () => {
     const initScript = join(__dirname, 'init.js')
@@ -109,6 +126,14 @@ const commands = {
     spawnSync('node', [join(toolsDir, 'setup-branch-protection.js')], { stdio: 'inherit' })
   },
 
+  audit: () => {
+    spawnSync('node', [join(toolsDir, 'release-audit.js')], { stdio: 'inherit' })
+  },
+
+  'fix-releases': () => {
+    spawnSync('node', [join(toolsDir, 'fix-releases.js')], { stdio: 'inherit' })
+  },
+
   upgrade: () => {
     spawnSync('node', [join(toolsDir, 'upgrade.js')], { stdio: 'inherit' })
   },
@@ -172,6 +197,7 @@ const commands = {
 }
 
 if (commands[command]) {
+  maybeRunAudit()
   commands[command]()
 } else {
   console.log(`
@@ -188,6 +214,8 @@ if (commands[command]) {
   setup-deps                Настроить dependabot/renovate
   setup-ci                  Сгенерировать .github/workflows/ci.yml
   setup-branch-protection   Настроить защиту главной ветки (gh api)
+  audit                     Проверить теги/Releases/демо/README на пробелы
+  fix-releases              Создать GitHub Release для тегов без Release
 
 🔧 РАЗРАБОТКА:
   update-readme             Обновить README с версией
@@ -218,6 +246,9 @@ if (commands[command]) {
 ⚙️  КОНФИГУРАЦИЯ:
   jst.config.js             Настройки веток, labels, коммитов, релизов
 
+🚩 ГЛОБАЛЬНЫЕ ФЛАГИ:
+  --no-audit                Отключить release audit для этого запуска
+
 📝 ФОРМАТ КОММИТОВ:
   feat: #9 описание               Фича (ссылка на issue)
   feat(scope): #9 описание        Фича со scope

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vv0rkz/js-template",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "Reusable setup for JS projects with husky, changelog, gh tools",
   "type": "module",
   "bin": {

package/templates/jst.config.js

@@ -103,6 +103,23 @@ export default {
        */
       style: 'click',
     },
+
+    /**
+     * Release audit — пассивная проверка перед каждой jst-командой.
+     * Сравнивает git tags ↔ GitHub Releases ↔ демо-файлы ↔ README-секции
+     * и печатает предупреждения, не блокируя команду.
+     *
+     *   enable    — включить хук (true | false)
+     *   warnOnly  — только предупреждать (true) или падать с кодом 1 (false)
+     *
+     * Отключить разово: `jst --no-audit <command>`
+     * Запустить явно:  `jst audit`
+     * Починить пропуски: `jst fix-releases`
+     */
+    audit: {
+      enable: true,
+      warnOnly: true,
+    },
   },
 
   /**

package/tools-gh/config.js

@@ -25,6 +25,10 @@ const DEFAULTS = {
       formats: ['gif', 'png'],
       style: 'click',
     },
+    audit: {
+      enable: true,
+      warnOnly: true,
+    },
   },
   changelog: {
     types: {

package/tools-gh/fix-releases.js

@@ -0,0 +1,77 @@
+#!/usr/bin/env node
+import { execSync, spawnSync } from 'child_process'
+import { platform } from 'os'
+
+const isWin = platform() === 'win32'
+const ghCmd = isWin ? 'gh.exe' : 'gh'
+
+function safeExec(cmd) {
+  try {
+    return execSync(cmd, { encoding: 'utf8', stdio: ['pipe', 'pipe', 'ignore'] }).trim()
+  } catch {
+    return ''
+  }
+}
+
+try {
+  execSync(`${ghCmd} auth status`, { stdio: 'ignore' })
+} catch {
+  console.error('❌ GitHub CLI не установлен или не авторизован')
+  console.log('💡 Установи: https://cli.github.com/  и выполни: gh auth login')
+  process.exit(1)
+}
+
+const tagsRaw = safeExec('git tag --sort=creatordate')
+const tags = tagsRaw
+  .split('\n')
+  .map((t) => t.trim())
+  .filter((t) => /^v\d+\.\d+\.\d+$/.test(t))
+
+if (tags.length === 0) {
+  console.log('ℹ️  Тегов не найдено — нечего восстанавливать')
+  process.exit(0)
+}
+
+const releasesJson = safeExec(`${ghCmd} release list --json tagName --limit 200`)
+let releaseTags = new Set()
+try {
+  releaseTags = new Set(JSON.parse(releasesJson || '[]').map((r) => r.tagName))
+} catch {
+  console.error('❌ Не удалось распарсить список GitHub Releases')
+  process.exit(1)
+}
+
+const missing = tags.filter((t) => !releaseTags.has(t))
+
+if (missing.length === 0) {
+  console.log('✅ Все теги уже имеют GitHub Release')
+  process.exit(0)
+}
+
+console.log(`🔧 Создаю GitHub Release для ${missing.length} тег(ов):`)
+missing.forEach((t) => console.log(`   • ${t}`))
+console.log()
+
+let created = 0
+let failed = 0
+
+for (const tag of missing) {
+  process.stdout.write(`   ${tag} ... `)
+  const result = spawnSync(ghCmd, ['release', 'create', tag, '--generate-notes', '--title', tag], {
+    stdio: ['ignore', 'pipe', 'pipe'],
+    encoding: 'utf8',
+  })
+
+  if (result.status === 0) {
+    console.log('✅')
+    created++
+  } else {
+    console.log('⚠️')
+    const errMsg = (result.stderr || '').trim().split('\n').slice(0, 2).join(' | ')
+    if (errMsg) console.log(`      ${errMsg}`)
+    failed++
+  }
+}
+
+console.log(`\n📊 Создано: ${created}, ошибок: ${failed}`)
+if (failed > 0) process.exit(1)

package/tools-gh/release-audit.js

@@ -0,0 +1,103 @@
+#!/usr/bin/env node
+import { execSync } from 'child_process'
+import { existsSync, readFileSync } from 'fs'
+import { platform } from 'os'
+import { loadConfig } from './config.js'
+
+const isWin = platform() === 'win32'
+const ghCmd = isWin ? 'gh.exe' : 'gh'
+
+const config = await loadConfig()
+const audit = (config.release && config.release.audit) || {}
+
+if (audit.enable === false) process.exit(0)
+
+// When invoked as a pre-run hook we stay silent on a clean repo. Stand-alone
+// invocations (`jst audit`) print a positive confirmation.
+const quietIfClean = process.argv.includes('--quiet-if-clean')
+const warnOnly = audit.warnOnly !== false
+
+function safeExec(cmd) {
+  try {
+    return execSync(cmd, { encoding: 'utf8', stdio: ['pipe', 'pipe', 'ignore'] }).trim()
+  } catch {
+    return ''
+  }
+}
+
+const tagsRaw = safeExec('git tag --sort=-creatordate')
+const tags = tagsRaw
+  .split('\n')
+  .map((t) => t.trim())
+  .filter((t) => /^v\d+\.\d+\.\d+$/.test(t))
+
+if (tags.length === 0) process.exit(0)
+
+let releaseTags = new Set()
+const releasesJson = safeExec(`${ghCmd} release list --json tagName --limit 100`)
+if (releasesJson) {
+  try {
+    releaseTags = new Set(JSON.parse(releasesJson).map((r) => r.tagName))
+  } catch {
+    // gh returned non-JSON — treat as "no info", skip the release check
+    releaseTags = null
+  }
+}
+
+const demoCfg = (config.release && config.release.demo) || {}
+const demoEnabled = demoCfg.enable !== false
+const demoDir = demoCfg.dir || 'docs'
+const demoFormats = Array.isArray(demoCfg.formats) && demoCfg.formats.length ? demoCfg.formats : ['gif', 'png']
+
+let readmeContent = ''
+let hasAutoSection = false
+if (existsSync('README.md')) {
+  readmeContent = readFileSync('README.md', 'utf8')
+  hasAutoSection = readmeContent.includes('<!-- AUTOGENERATED_SECTION START -->')
+}
+
+const noRelease = []
+const noDemo = []
+const noReadme = []
+
+for (const tag of tags) {
+  if (releaseTags && !releaseTags.has(tag)) noRelease.push(tag)
+
+  if (demoEnabled) {
+    const hasDemo = demoFormats.some((fmt) => existsSync(`${demoDir}/${tag}.${fmt}`))
+    if (!hasDemo) noDemo.push(tag)
+  }
+
+  if (hasAutoSection && !readmeContent.includes(`### 🟢 ${tag}`)) {
+    noReadme.push(tag)
+  }
+}
+
+const total = noRelease.length + noDemo.length + noReadme.length
+
+if (total === 0) {
+  if (!quietIfClean) console.log('✅ Release audit: всё в порядке')
+  process.exit(0)
+}
+
+// Compact list helper — first N tags then "+M more"
+function fmtTags(list, limit = 5) {
+  if (list.length <= limit) return list.join(', ')
+  return list.slice(0, limit).join(', ') + ` +${list.length - limit} more`
+}
+
+if (noRelease.length) {
+  console.warn(`⚠️  Release audit: ${noRelease.length} тег(ов) без GitHub Release: ${fmtTags(noRelease)}`)
+  console.warn(`   → Исправить: jst fix-releases`)
+}
+if (noDemo.length) {
+  console.warn(`⚠️  Release audit: ${noDemo.length} тег(ов) без демо: ${fmtTags(noDemo)}`)
+  console.warn(`   → Создай файлы в ${demoDir}/<tag>.${demoFormats[0]}`)
+}
+if (noReadme.length) {
+  console.warn(`⚠️  Release audit: README не содержит секции: ${fmtTags(noReadme)}`)
+  console.warn(`   → Исправить: jst update-readme`)
+}
+
+if (!warnOnly) process.exit(1)
+process.exit(0)