Rename project and binary to DocxGenerator

This commit is contained in:
2026-10-03 23:47:55 +04:00
parent 3a8045a141
commit 41d434ef97
7 changed files with 27 additions and 27 deletions

2
.gitignore vendored
View File

@@ -1,5 +1,5 @@
node_modules/ node_modules/
report.docx report.docx
lab-gen.exe DocxGenerator.exe
*.log *.log
*.pdf *.pdf

View File

@@ -1,6 +1,6 @@
# AGENTS.md — генератор lab-gen # AGENTS.md — генератор DocxGenerator
`lab-gen` — автономный инструмент, который собирает отчёт в формате **DOCX** из обычных `DocxGenerator` — автономный инструмент, который собирает отчёт в формате **DOCX** из обычных
**Markdown**-файлов по фиксированному дизайну СТО 02068410-004-2018. Поведение полностью **Markdown**-файлов по фиксированному дизайну СТО 02068410-004-2018. Поведение полностью
задаётся файлом `config.yaml`. задаётся файлом `config.yaml`.
@@ -18,7 +18,7 @@
## 2. Состав дистрибутива ## 2. Состав дистрибутива
``` ```
lab-gen.exe # исполняемый файл DocxGenerator.exe # исполняемый файл
config.yaml # настройки (создаётся автоматически при первом запуске) config.yaml # настройки (создаётся автоматически при первом запуске)
content/ # Markdown-файлы документа и ресурсы content/ # Markdown-файлы документа и ресурсы
*.md *.md
@@ -29,12 +29,12 @@ report.docx # результат сборки (путь задаё
``` ```
Все относительные пути в `config.yaml` считаются **от каталога самого `config.yaml`**. Все относительные пути в `config.yaml` считаются **от каталога самого `config.yaml`**.
Сам `config.yaml` и папки ищутся **рядом с `lab-gen.exe`**. Сам `config.yaml` и папки ищутся **рядом с `DocxGenerator.exe`**.
## 3. Командная строка ## 3. Командная строка
``` ```
lab-gen [опции] DocxGenerator [опции]
--config <путь> путь к config.yaml (по умолчанию рядом с exe) --config <путь> путь к config.yaml (по умолчанию рядом с exe)
--content <dir> каталог с config.yaml, content/ и assets/ (по умолчанию рядом с exe) --content <dir> каталог с config.yaml, content/ и assets/ (по умолчанию рядом с exe)
@@ -56,10 +56,10 @@ lab-gen [опции]
Типичный цикл работы: Типичный цикл работы:
```powershell ```powershell
.\lab-gen.exe --init # первый запуск: получить шаблон .\DocxGenerator.exe --init # первый запуск: получить шаблон
# ... правим config.yaml и content/*.md ... # ... правим config.yaml и content/*.md ...
.\lab-gen.exe --check # проверить .\DocxGenerator.exe --check # проверить
.\lab-gen.exe # собрать report.docx .\DocxGenerator.exe # собрать report.docx
``` ```
## 4. Схема `config.yaml` ## 4. Схема `config.yaml`
@@ -288,7 +288,7 @@ a — коэффициент.
## 6. Проверка и ошибки ## 6. Проверка и ошибки
`lab-gen --check` проверяет: `DocxGenerator --check` проверяет:
- корректность `config.yaml` (типы, существование файлов, допустимые буквы приложений); - корректность `config.yaml` (типы, существование файлов, допустимые буквы приложений);
- наличие всех `sections[].file`; - наличие всех `sections[].file`;
@@ -302,7 +302,7 @@ a — коэффициент.
```powershell ```powershell
npm install npm install
npm run build:exe # -> lab-gen.exe в корне (target node24-win-x64) npm run build:exe # -> DocxGenerator.exe в корне (target node24-win-x64)
npm run generate # локальная сборка (node src/cli.js) npm run generate # локальная сборка (node src/cli.js)
npm run check # проверка конфига и ссылок npm run check # проверка конфига и ссылок
``` ```

View File

@@ -1,4 +1,4 @@
# lab-gen # DocxGenerator
Автономный генератор отчётов **DOCX** из **Markdown** по дизайну Автономный генератор отчётов **DOCX** из **Markdown** по дизайну
[СТО 02068410-004-2018](documentation/STO_SGAU_02068410-004-2018.md). [СТО 02068410-004-2018](documentation/STO_SGAU_02068410-004-2018.md).
@@ -11,10 +11,10 @@
## Быстрый старт ## Быстрый старт
```powershell ```powershell
.\lab-gen.exe --init # создать config.yaml, примеры content/ и content/assets/ .\DocxGenerator.exe --init # создать config.yaml, примеры content/ и content/assets/
# ... правим config.yaml и content/*.md ... # ... правим config.yaml и content/*.md ...
.\lab-gen.exe --check # проверить ссылки и конфиг .\DocxGenerator.exe --check # проверить ссылки и конфиг
.\lab-gen.exe # собрать report.docx .\DocxGenerator.exe # собрать report.docx
``` ```
## Разработка ## Разработка
@@ -23,7 +23,7 @@
npm install npm install
npm run generate # локальная сборка report.docx npm run generate # локальная сборка report.docx
npm run check # проверка конфига и ссылок npm run check # проверка конфига и ссылок
npm run build:exe # собрать lab-gen.exe в корне (@yao-pkg/pkg, node24-win-x64) npm run build:exe # собрать DocxGenerator.exe в корне (@yao-pkg/pkg, node24-win-x64)
``` ```
## Структура репозитория ## Структура репозитория

6
package-lock.json generated
View File

@@ -1,11 +1,11 @@
{ {
"name": "lab-gen", "name": "docxgenerator",
"version": "2.0.0", "version": "2.0.0",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "lab-gen", "name": "docxgenerator",
"version": "2.0.0", "version": "2.0.0",
"dependencies": { "dependencies": {
"docx": "^9.5.0", "docx": "^9.5.0",
@@ -15,7 +15,7 @@
"markdown-it": "^14.1.0" "markdown-it": "^14.1.0"
}, },
"bin": { "bin": {
"lab-gen": "src/cli.js" "docxgenerator": "src/cli.js"
}, },
"devDependencies": { "devDependencies": {
"@yao-pkg/pkg": "^6.23.0" "@yao-pkg/pkg": "^6.23.0"

View File

@@ -1,16 +1,16 @@
{ {
"name": "lab-gen", "name": "docxgenerator",
"version": "2.0.0", "version": "2.0.0",
"private": true, "private": true,
"description": "Автономный генератор отчётов DOCX из Markdown по СТО 02068410-004-2018", "description": "DocxGenerator — автономный генератор отчётов DOCX из Markdown по СТО 02068410-004-2018",
"bin": { "bin": {
"lab-gen": "src/cli.js" "docxgenerator": "src/cli.js"
}, },
"main": "src/index.js", "main": "src/index.js",
"scripts": { "scripts": {
"generate": "node src/cli.js", "generate": "node src/cli.js",
"check": "node src/cli.js --check", "check": "node src/cli.js --check",
"build:exe": "pkg . --targets node24-win-x64 --compress Brotli --output lab-gen.exe" "build:exe": "pkg . --targets node24-win-x64 --compress Brotli --output DocxGenerator.exe"
}, },
"dependencies": { "dependencies": {
"docx": "^9.5.0", "docx": "^9.5.0",

View File

@@ -14,10 +14,10 @@ const { ConfigError } = require('./util/errors');
const VERSION = '2.0.0'; const VERSION = '2.0.0';
const HELP = `lab-gen ${VERSION} — генератор DOCX из Markdown (СТО 02068410-004-2018) const HELP = `DocxGenerator ${VERSION} — генератор DOCX из Markdown (СТО 02068410-004-2018)
Использование: Использование:
lab-gen [опции] DocxGenerator.exe [опции]
Опции: Опции:
--config <путь> Путь к config.yaml (по умолчанию рядом с exe) --config <путь> Путь к config.yaml (по умолчанию рядом с exe)
@@ -101,7 +101,7 @@ async function main() {
logger.info('Файлы уже существуют, ничего не создано.'); logger.info('Файлы уже существуют, ничего не создано.');
} }
logger.info(''); logger.info('');
logger.info('Отредактируйте config.yaml и файлы в content/, затем запустите lab-gen снова.'); logger.info('Отредактируйте config.yaml и файлы в content/, затем запустите DocxGenerator.exe снова.');
return 0; return 0;
} }

View File

@@ -8,7 +8,7 @@ const { DEFAULT_CONFIG } = require('./defaults');
const { diagramPng, chartPng } = require('../util/png'); const { diagramPng, chartPng } = require('../util/png');
const { buildSampleTitlePage } = require('../render/sample-titlepage'); const { buildSampleTitlePage } = require('../render/sample-titlepage');
const CONFIG_HEADER = `# Конфигурация генератора lab-gen. const CONFIG_HEADER = `# Конфигурация генератора DocxGenerator.
# Все относительные пути считаются от каталога этого файла. # Все относительные пути считаются от каталога этого файла.
# Любой ключ можно опустить — будет использовано значение по умолчанию. # Любой ключ можно опустить — будет использовано значение по умолчанию.