diff --git a/.github/workflows/publish-skills.yml b/.github/workflows/publish-skills.yml index 3fe62af..83d4bba 100644 --- a/.github/workflows/publish-skills.yml +++ b/.github/workflows/publish-skills.yml @@ -47,3 +47,11 @@ jobs: --latest=false fi gh release upload skills-latest dist/skill-archives/*.zip --clobber + + # Remove unprefixed archives only after the renamed archives are published. + gh release view skills-latest --json assets --jq '.assets[].name' > "$RUNNER_TEMP/interview-skill-assets.txt" + while IFS= read -r slug; do + if grep -Fxq "$slug.zip" "$RUNNER_TEMP/interview-skill-assets.txt"; then + gh release delete-asset skills-latest "$slug.zip" --yes + fi + done < <(node --input-type=module -e "import {readFileSync} from 'node:fs'; for (const {slug} of JSON.parse(readFileSync('skills/catalog.json'))) console.log(slug)") diff --git a/README.md b/README.md index f936b4f..df3c8c5 100644 --- a/README.md +++ b/README.md @@ -18,15 +18,28 @@ npx skills@latest add https://github.com/Angular-RU/angular-ru-interview-questio Или только Angular: ```bash -npx skills@latest add https://github.com/Angular-RU/angular-ru-interview-questions/releases/download/skills-latest/angular.zip +npx skills@latest add https://github.com/Angular-RU/angular-ru-interview-questions/releases/download/skills-latest/angular-ru-interview-angular.zip ``` -Генератор использует `src/pages/**/index.md` как единственный источник вопросов и ответов. При сборке он создает -`skills/<тема>/SKILL.md` и `references/part-XX.md` локально; эти файлы **не хранятся в Git**. После каждого push в -`main` GitHub Actions публикует обновленные ZIP-архивы в +Все имена скиллов начинаются с `angular-ru-interview-`, чтобы не конфликтовать с другими источниками. + +Ранее установленные скиллы с короткими именами (`angular`, `react` и т. д.) нужно удалить и установить заново. + +Переименование установленных скиллов не происходит автоматически. URL страниц справочника остаются прежними. + +Генератор использует `src/pages/**/index.md` как единственный источник вопросов и ответов. + +При сборке он создает `SKILL.md` и `references/part-XX.md` в папке `skills/angular-ru-interview-<тема>/`. + +Сгенерированные файлы **не хранятся в Git**. + +После каждого push в `main` GitHub Actions публикует ZIP-архивы в [GitHub Release `skills-latest`](https://github.com/Angular-RU/angular-ru-interview-questions/releases/tag/skills-latest). -Каждую тему можно установить отдельно, а `all.zip` содержит все 26 тем. После установки все вопросы и ответы доступны -без доступа к сайту. Генерация и проверка выполняются автоматически через `npm run skills:check`. + +Каждую тему можно установить отдельно, а `all.zip` содержит все 26 тем. + +После установки вопросы и ответы доступны без доступа к сайту. Генерация и проверка выполняются автоматически через +`npm run skills:check`. ## Основы и инструменты diff --git a/scripts/check-skills.mjs b/scripts/check-skills.mjs index 0eb5d12..d6a3a7c 100644 --- a/scripts/check-skills.mjs +++ b/scripts/check-skills.mjs @@ -4,12 +4,19 @@ import {join} from 'node:path'; const root = new URL('../', import.meta.url).pathname; const catalog = JSON.parse(readFileSync(join(root, 'skills/catalog.json'), 'utf8')); +const {prefix} = JSON.parse(readFileSync(join(root, 'skills/naming.json'), 'utf8')); +assert.match(prefix, /^[a-z0-9]+(?:-[a-z0-9]+)*-$/); const slugs = new Set(); +const names = new Set(); for (const skill of catalog) { assert.match(skill.slug, /^[a-z0-9]+(?:-[a-z0-9]+)*$/); assert(!slugs.has(skill.slug), `Duplicate skill: ${skill.slug}`); slugs.add(skill.slug); + const name = `${prefix}${skill.slug}`; + assert(name.length <= 64, `Skill name exceeds 64 characters: ${name}`); + assert(!names.has(name), `Duplicate skill name: ${name}`); + names.add(name); assert(skill.title && skill.description && skill.category); assert(skill.topics.length >= 3, `Missing topic coverage: ${skill.slug}`); @@ -17,10 +24,10 @@ for (const skill of catalog) { assert(existsSync(pagePath), `Missing topic page: ${skill.slug}`); assert.match(readFileSync(pagePath, 'utf8'), /kind:\s*questions/); - const path = join(root, 'skills', skill.slug, 'SKILL.md'); + const path = join(root, 'skills', name, 'SKILL.md'); assert(existsSync(path), `Missing SKILL.md: ${skill.slug}`); const content = readFileSync(path, 'utf8'); - assert(content.startsWith(`---\nname: ${skill.slug}\ndescription:`), `Invalid frontmatter: ${skill.slug}`); + assert(content.startsWith(`---\nname: ${name}\ndescription:`), `Invalid frontmatter: ${skill.slug}`); assert(content.includes(`/interview/${skill.slug}/`), `Missing handbook link: ${skill.slug}`); } @@ -33,6 +40,6 @@ assert.deepEqual([...slugs].sort(), pageSlugs, 'Catalog must match all question const skillDirs = readdirSync(join(root, 'skills')) .filter((entry) => statSync(join(root, 'skills', entry)).isDirectory()) .sort(); -assert.deepEqual(skillDirs, [...slugs].sort(), 'Skill directories must match catalog'); +assert.deepEqual(skillDirs, [...names].sort(), 'Skill directories must match catalog'); console.log(`Validated ${catalog.length} installable skills and question pages.`); diff --git a/scripts/generate-skills.mjs b/scripts/generate-skills.mjs index 91abcc6..51b35aa 100644 --- a/scripts/generate-skills.mjs +++ b/scripts/generate-skills.mjs @@ -1,10 +1,13 @@ import assert from 'node:assert/strict'; -import {existsSync, mkdirSync, readFileSync, readdirSync, unlinkSync, writeFileSync} from 'node:fs'; +import {existsSync, mkdirSync, readFileSync, readdirSync, rmSync, unlinkSync, writeFileSync} from 'node:fs'; import {join} from 'node:path'; import {fileURLToPath} from 'node:url'; const root = fileURLToPath(new URL('../', import.meta.url)); const catalog = JSON.parse(readFileSync(join(root, 'skills/catalog.json'), 'utf8')); +const {prefix} = JSON.parse(readFileSync(join(root, 'skills/naming.json'), 'utf8')); +assert.match(prefix, /^[a-z0-9]+(?:-[a-z0-9]+)*-$/); +const skillName = (slug) => `${prefix}${slug}`; const check = process.argv.includes('--check'); const maxChunkSize = 48_000; const generated = new Set(); @@ -74,6 +77,8 @@ function splitIntoChunks(markdown) { } function generateSkill(skill) { + const name = skillName(skill.slug); + assert(name.length <= 64, `Skill name exceeds 64 characters: ${name}`); const page = readFileSync(join(root, 'src/pages', skill.slug, 'index.md'), 'utf8'); const {markdown, count} = convertQuestions(page, skill.slug); const chunks = splitIntoChunks(markdown); @@ -81,7 +86,7 @@ function generateSkill(skill) { const index = []; for (const [i, chunk] of chunks.entries()) { const filename = 'part-' + String(i + 1).padStart(2, '0') + '.md'; - const file = 'skills/' + skill.slug + '/references/' + filename; + const file = 'skills/' + name + '/references/' + filename; const questions = (chunk.text.match(/^#### Вопрос: /gm) ?? []).length; const topics = chunk.topics.join(', '); items.set( @@ -103,10 +108,10 @@ function generateSkill(skill) { ); items.set( - 'skills/' + skill.slug + '/SKILL.md', + 'skills/' + name + '/SKILL.md', [ '---', - 'name: ' + skill.slug, + 'name: ' + name, 'description: ' + JSON.stringify( 'Вопросы и ответы для технического собеседования по теме ' + @@ -141,6 +146,23 @@ function generateSkill(skill) { return items; } +// Skill names used to match page slugs. Remove only directories produced by the old generator. +for (const {slug} of catalog) { + const legacyDirectory = join(root, 'skills', slug); + if (!existsSync(legacyDirectory)) continue; + + const legacySkillFile = join(legacyDirectory, 'SKILL.md'); + assert(existsSync(legacySkillFile), `Unexpected legacy directory: skills/${slug}`); + const content = readFileSync(legacySkillFile, 'utf8'); + assert( + content.startsWith(`---\nname: ${slug}\ndescription:`) && + content.includes('Angular-RU/angular-ru-interview-questions'), + `Refusing to remove an unknown skill directory: skills/${slug}`, + ); + if (check) throw new Error(`Stale unprefixed skill directory: skills/${slug}`); + rmSync(legacyDirectory, {recursive: true, force: true}); +} + for (const skill of catalog) { const items = generateSkill(skill); for (const [relative, content] of items) { @@ -155,10 +177,10 @@ for (const skill of catalog) { } } - const references = join(root, 'skills', skill.slug, 'references'); + const references = join(root, 'skills', skillName(skill.slug), 'references'); if (existsSync(references)) { for (const filename of readdirSync(references)) { - const relative = 'skills/' + skill.slug + '/references/' + filename; + const relative = 'skills/' + skillName(skill.slug) + '/references/' + filename; if (!generated.has(relative) && filename.startsWith('part-') && filename.endsWith('.md')) { if (check) throw new Error('Stale generated file: ' + relative); unlinkSync(join(references, filename)); diff --git a/skills/naming.json b/skills/naming.json new file mode 100644 index 0000000..4aa16f5 --- /dev/null +++ b/skills/naming.json @@ -0,0 +1,3 @@ +{ + "prefix": "angular-ru-interview-" +} diff --git a/src/components/SkillHero.astro b/src/components/SkillHero.astro index 795b642..66cb5a4 100644 --- a/src/components/SkillHero.astro +++ b/src/components/SkillHero.astro @@ -1,6 +1,6 @@ --- import type {Skill} from '../data/skills'; -import {installCommand} from '../data/skills'; +import {installCommand, skillName} from '../data/skills'; import SkillInstall from './SkillInstall.astro'; interface Props { @@ -16,7 +16,7 @@ const base = import.meta.env.BASE_URL.replace(/\/$/, ''); aria-labelledby="skill-hero-title" >
/{skill.slug} · AI Skill
+/{skillName(skill.slug)} · AI Skill
{skill.description}
@@ -26,7 +26,7 @@ const base = import.meta.env.BASE_URL.replace(/\/$/, ''); Все AI Skills @@ -48,7 +48,7 @@ const base = import.meta.env.BASE_URL.replace(/\/$/, '');