mirror of
https://github.com/StepanovPlaton/SSAUGenerator.git
synced 2026-11-01 10:49:08 +04:00
Rename project and binary to DocxGenerator
This commit is contained in:
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,5 +1,5 @@
|
||||
node_modules/
|
||||
report.docx
|
||||
lab-gen.exe
|
||||
DocxGenerator.exe
|
||||
*.log
|
||||
*.pdf
|
||||
|
||||
20
AGENTS.md
20
AGENTS.md
@@ -1,6 +1,6 @@
|
||||
# AGENTS.md — генератор lab-gen
|
||||
# AGENTS.md — генератор DocxGenerator
|
||||
|
||||
`lab-gen` — автономный инструмент, который собирает отчёт в формате **DOCX** из обычных
|
||||
`DocxGenerator` — автономный инструмент, который собирает отчёт в формате **DOCX** из обычных
|
||||
**Markdown**-файлов по фиксированному дизайну СТО 02068410-004-2018. Поведение полностью
|
||||
задаётся файлом `config.yaml`.
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
## 2. Состав дистрибутива
|
||||
|
||||
```
|
||||
lab-gen.exe # исполняемый файл
|
||||
DocxGenerator.exe # исполняемый файл
|
||||
config.yaml # настройки (создаётся автоматически при первом запуске)
|
||||
content/ # Markdown-файлы документа и ресурсы
|
||||
*.md
|
||||
@@ -29,12 +29,12 @@ report.docx # результат сборки (путь задаё
|
||||
```
|
||||
|
||||
Все относительные пути в `config.yaml` считаются **от каталога самого `config.yaml`**.
|
||||
Сам `config.yaml` и папки ищутся **рядом с `lab-gen.exe`**.
|
||||
Сам `config.yaml` и папки ищутся **рядом с `DocxGenerator.exe`**.
|
||||
|
||||
## 3. Командная строка
|
||||
|
||||
```
|
||||
lab-gen [опции]
|
||||
DocxGenerator [опции]
|
||||
|
||||
--config <путь> путь к config.yaml (по умолчанию рядом с exe)
|
||||
--content <dir> каталог с config.yaml, content/ и assets/ (по умолчанию рядом с exe)
|
||||
@@ -56,10 +56,10 @@ lab-gen [опции]
|
||||
Типичный цикл работы:
|
||||
|
||||
```powershell
|
||||
.\lab-gen.exe --init # первый запуск: получить шаблон
|
||||
.\DocxGenerator.exe --init # первый запуск: получить шаблон
|
||||
# ... правим config.yaml и content/*.md ...
|
||||
.\lab-gen.exe --check # проверить
|
||||
.\lab-gen.exe # собрать report.docx
|
||||
.\DocxGenerator.exe --check # проверить
|
||||
.\DocxGenerator.exe # собрать report.docx
|
||||
```
|
||||
|
||||
## 4. Схема `config.yaml`
|
||||
@@ -288,7 +288,7 @@ a — коэффициент.
|
||||
|
||||
## 6. Проверка и ошибки
|
||||
|
||||
`lab-gen --check` проверяет:
|
||||
`DocxGenerator --check` проверяет:
|
||||
|
||||
- корректность `config.yaml` (типы, существование файлов, допустимые буквы приложений);
|
||||
- наличие всех `sections[].file`;
|
||||
@@ -302,7 +302,7 @@ a — коэффициент.
|
||||
|
||||
```powershell
|
||||
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 check # проверка конфига и ссылок
|
||||
```
|
||||
|
||||
10
README.md
10
README.md
@@ -1,4 +1,4 @@
|
||||
# lab-gen
|
||||
# DocxGenerator
|
||||
|
||||
Автономный генератор отчётов **DOCX** из **Markdown** по дизайну
|
||||
[СТО 02068410-004-2018](documentation/STO_SGAU_02068410-004-2018.md).
|
||||
@@ -11,10 +11,10 @@
|
||||
## Быстрый старт
|
||||
|
||||
```powershell
|
||||
.\lab-gen.exe --init # создать config.yaml, примеры content/ и content/assets/
|
||||
.\DocxGenerator.exe --init # создать config.yaml, примеры content/ и content/assets/
|
||||
# ... правим config.yaml и content/*.md ...
|
||||
.\lab-gen.exe --check # проверить ссылки и конфиг
|
||||
.\lab-gen.exe # собрать report.docx
|
||||
.\DocxGenerator.exe --check # проверить ссылки и конфиг
|
||||
.\DocxGenerator.exe # собрать report.docx
|
||||
```
|
||||
|
||||
## Разработка
|
||||
@@ -23,7 +23,7 @@
|
||||
npm install
|
||||
npm run generate # локальная сборка report.docx
|
||||
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
6
package-lock.json
generated
@@ -1,11 +1,11 @@
|
||||
{
|
||||
"name": "lab-gen",
|
||||
"name": "docxgenerator",
|
||||
"version": "2.0.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "lab-gen",
|
||||
"name": "docxgenerator",
|
||||
"version": "2.0.0",
|
||||
"dependencies": {
|
||||
"docx": "^9.5.0",
|
||||
@@ -15,7 +15,7 @@
|
||||
"markdown-it": "^14.1.0"
|
||||
},
|
||||
"bin": {
|
||||
"lab-gen": "src/cli.js"
|
||||
"docxgenerator": "src/cli.js"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@yao-pkg/pkg": "^6.23.0"
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
{
|
||||
"name": "lab-gen",
|
||||
"name": "docxgenerator",
|
||||
"version": "2.0.0",
|
||||
"private": true,
|
||||
"description": "Автономный генератор отчётов DOCX из Markdown по СТО 02068410-004-2018",
|
||||
"description": "DocxGenerator — автономный генератор отчётов DOCX из Markdown по СТО 02068410-004-2018",
|
||||
"bin": {
|
||||
"lab-gen": "src/cli.js"
|
||||
"docxgenerator": "src/cli.js"
|
||||
},
|
||||
"main": "src/index.js",
|
||||
"scripts": {
|
||||
"generate": "node src/cli.js",
|
||||
"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": {
|
||||
"docx": "^9.5.0",
|
||||
|
||||
@@ -14,10 +14,10 @@ const { ConfigError } = require('./util/errors');
|
||||
|
||||
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)
|
||||
@@ -101,7 +101,7 @@ async function main() {
|
||||
logger.info('Файлы уже существуют, ничего не создано.');
|
||||
}
|
||||
logger.info('');
|
||||
logger.info('Отредактируйте config.yaml и файлы в content/, затем запустите lab-gen снова.');
|
||||
logger.info('Отредактируйте config.yaml и файлы в content/, затем запустите DocxGenerator.exe снова.');
|
||||
return 0;
|
||||
}
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ const { DEFAULT_CONFIG } = require('./defaults');
|
||||
const { diagramPng, chartPng } = require('../util/png');
|
||||
const { buildSampleTitlePage } = require('../render/sample-titlepage');
|
||||
|
||||
const CONFIG_HEADER = `# Конфигурация генератора lab-gen.
|
||||
const CONFIG_HEADER = `# Конфигурация генератора DocxGenerator.
|
||||
# Все относительные пути считаются от каталога этого файла.
|
||||
# Любой ключ можно опустить — будет использовано значение по умолчанию.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user