lint-gost-tex 0.1.1__tar.gz

lint_gost_tex-0.1.1/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.1.0] - 2026-02-02
+### Added
+- Initial standalone release of lint-gost-tex.

lint_gost_tex-0.1.1/CODE_OF_CONDUCT.md

@@ -0,0 +1,17 @@
+# Code of Conduct
+
+Проект lint-gost-tex придерживается принципов уважительного и инклюзивного общения.
+
+## Наши ожидания
+- Уважайте участников и их время.
+- Критикуйте идеи, а не людей.
+- Избегайте оскорблений, дискриминации и харассмента.
+
+## Неприемлемое поведение
+- Личные нападки и угрозы.
+- Дискриминация по любым признакам.
+- Сексуализированные высказывания или контент.
+
+## Сообщение о нарушениях
+Сообщайте о нарушениях через issues (если это безопасно) или через приватные каналы
+поддержки репозитория (например, GitHub Security Advisories).

lint_gost_tex-0.1.1/CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Contributing
+
+Спасибо за интерес к lint-gost-tex!
+
+## Разработка
+```bash
+poetry install
+poetry run lint-gost-tex --root main.tex
+```
+
+## Что стоит учитывать
+- Пожалуйста, сохраняйте текущий стиль кода и относительные импорты.
+- Новые правила добавляйте в `src/lint_gost_tex/rules` и регистрируйте в `build_rules`.
+- Для изменений в конфиге обновляйте `examples/lint-gost-tex.toml` и README.
+
+## PR-процесс
+1) Опишите проблему/идею и ожидаемое поведение.
+2) Добавьте минимальный воспроизводимый пример (кусок `.tex`).
+3) Убедитесь, что не сломали формат сообщений и сортировку ошибок.
+
+Если у вас нет уверенности по правилам ГОСТ — откройте issue с обсуждением.

lint_gost_tex-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lint GOST TeX contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

lint_gost_tex-0.1.1/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.1
+Name: lint-gost-tex
+Version: 0.1.1
+Summary: LaTeX linter for GOST-styled documents.
+License: MIT
+Keywords: latex,gost,linter,tex
+Author: Lint GOST TeX contributors
+Requires-Python: >=3.11,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Text Processing :: Markup :: LaTeX
+Description-Content-Type: text/markdown
+
+# lint-gost-tex
+
+[![status-badge](https://woodpecker.dev.nachert.art/api/badges/9/status.svg)](https://woodpecker.dev.nachert.art/repos/9)
+
+Линтер LaTeX‑документов под требования ГОСТ: проверяет оформление ссылок, списков,
+иллюстраций, запрещённые сокращения, нестандартные символы и орфографию.
+
+## Возможности
+- проверка `\includegraphics` на фиксированную ширину;
+- пробелы перед `\ref/\eqref/\autoref/...` (неразрывный `~`);
+- пунктуация вокруг ссылок;
+- запрет подчеркиваний/курсива;
+- правила для списков (вложенность, пунктуация, регистр);
+- подписи к рисункам/таблицам;
+- порядок иллюстраций относительно первого упоминания;
+- орфография (RU/EN) и запрет «пиксель»;
+- контроль не‑клавиатурных символов.
+
+## Установка
+```bash
+pip install lint-gost-tex
+```
+
+## Быстрый старт
+```bash
+lint-gost-tex --root main.tex
+```
+
+или через модуль:
+```bash
+python -m lint_gost_tex --root main.tex
+```
+
+По умолчанию линтер ищет конфиг `lint-gost-tex.toml` в текущей директории.
+Другой файл можно указать явно:
+```bash
+lint-gost-tex --config path/to/config.toml
+```
+
+## Конфигурация
+Пример конфига: `examples/lint-gost-tex.toml`.
+
+1) Скопируйте конфиг в корень проекта:
+```bash
+cp examples/lint-gost-tex.toml ./lint-gost-tex.toml
+```
+
+2) Скопируйте шаблоны словарей:
+```bash
+mkdir -p dictionaries
+cp examples/dictionaries/*.txt ./dictionaries/
+```
+
+### Важные параметры
+- `document.root` — корневой `.tex` файл.
+- `document.exclude` — исключения (по имени файла или glob).
+- `spellcheck.custom_dict` — пользовательский словарь.
+- `spellcheck.extra_ru_dicts` — русские словари (обязательно для RU‑проверки).
+- `spellcheck.extra_en_dicts` — дополнительные EN‑словари.
+
+Если русских/английских словарей нет, линтер выдаст предупреждение `SPELL000`.
+
+## Ограничения
+- `\include` и `\input` учитываются только из корневого файла (без рекурсии).
+- Проверка орфографии требует явных словарей для русского языка.
+
+## Список правил
+- `IMG001` — `\includegraphics` должен использовать заданную ширину.
+- `REF001` — перед ссылками нужен ровно один `~`.
+- `REF002` — ссылки должны стоять перед завершающей пунктуацией.
+- `TXT001` — запрет курсивов/подчеркиваний.
+- `LST001` — запрет кастомных окружений списков/лейблов.
+- `LST002` — запрет вложенных списков.
+- `LST003` — пунктуация элементов списка.
+- `LST004` — в элементе списка только одно предложение.
+- `LST005` — элементы списка не должны начинаться с заглавной буквы.
+- `CAP001` — подписи не должны оканчиваться пунктуацией.
+- `ILL001` — иллюстрация появляется раньше первого упоминания.
+- `ILL002` — иллюстрация не имеет ссылок.
+- `ABBR001` — запрещённые сокращения (ГОСТ).
+- `UNIC001` — запрет не‑клавиатурных символов.
+- `SPELL000` — нет словарей для проверки.
+- `SPELL001` — неизвестное слово.
+- `SPELL002` — запрещённое слово «пиксель».
+- `SPELL003` — требуется «ё» вместо «е».
+
+## Формат вывода
+```
+path:line:col [RULE_ID] message
+  | source line
+  |    ^
+```
+
+## Коды выхода
+- `0` — ошибок нет.
+- `1` — найдены проблемы.
+
+## Разработка
+```bash
+poetry install
+poetry run lint-gost-tex --root main.tex
+```
+
+## Лицензия
+MIT. См. `LICENSE`.
+

lint_gost_tex-0.1.1/README.md

@@ -0,0 +1,105 @@
+# lint-gost-tex
+
+[![status-badge](https://woodpecker.dev.nachert.art/api/badges/9/status.svg)](https://woodpecker.dev.nachert.art/repos/9)
+
+Линтер LaTeX‑документов под требования ГОСТ: проверяет оформление ссылок, списков,
+иллюстраций, запрещённые сокращения, нестандартные символы и орфографию.
+
+## Возможности
+- проверка `\includegraphics` на фиксированную ширину;
+- пробелы перед `\ref/\eqref/\autoref/...` (неразрывный `~`);
+- пунктуация вокруг ссылок;
+- запрет подчеркиваний/курсива;
+- правила для списков (вложенность, пунктуация, регистр);
+- подписи к рисункам/таблицам;
+- порядок иллюстраций относительно первого упоминания;
+- орфография (RU/EN) и запрет «пиксель»;
+- контроль не‑клавиатурных символов.
+
+## Установка
+```bash
+pip install lint-gost-tex
+```
+
+## Быстрый старт
+```bash
+lint-gost-tex --root main.tex
+```
+
+или через модуль:
+```bash
+python -m lint_gost_tex --root main.tex
+```
+
+По умолчанию линтер ищет конфиг `lint-gost-tex.toml` в текущей директории.
+Другой файл можно указать явно:
+```bash
+lint-gost-tex --config path/to/config.toml
+```
+
+## Конфигурация
+Пример конфига: `examples/lint-gost-tex.toml`.
+
+1) Скопируйте конфиг в корень проекта:
+```bash
+cp examples/lint-gost-tex.toml ./lint-gost-tex.toml
+```
+
+2) Скопируйте шаблоны словарей:
+```bash
+mkdir -p dictionaries
+cp examples/dictionaries/*.txt ./dictionaries/
+```
+
+### Важные параметры
+- `document.root` — корневой `.tex` файл.
+- `document.exclude` — исключения (по имени файла или glob).
+- `spellcheck.custom_dict` — пользовательский словарь.
+- `spellcheck.extra_ru_dicts` — русские словари (обязательно для RU‑проверки).
+- `spellcheck.extra_en_dicts` — дополнительные EN‑словари.
+
+Если русских/английских словарей нет, линтер выдаст предупреждение `SPELL000`.
+
+## Ограничения
+- `\include` и `\input` учитываются только из корневого файла (без рекурсии).
+- Проверка орфографии требует явных словарей для русского языка.
+
+## Список правил
+- `IMG001` — `\includegraphics` должен использовать заданную ширину.
+- `REF001` — перед ссылками нужен ровно один `~`.
+- `REF002` — ссылки должны стоять перед завершающей пунктуацией.
+- `TXT001` — запрет курсивов/подчеркиваний.
+- `LST001` — запрет кастомных окружений списков/лейблов.
+- `LST002` — запрет вложенных списков.
+- `LST003` — пунктуация элементов списка.
+- `LST004` — в элементе списка только одно предложение.
+- `LST005` — элементы списка не должны начинаться с заглавной буквы.
+- `CAP001` — подписи не должны оканчиваться пунктуацией.
+- `ILL001` — иллюстрация появляется раньше первого упоминания.
+- `ILL002` — иллюстрация не имеет ссылок.
+- `ABBR001` — запрещённые сокращения (ГОСТ).
+- `UNIC001` — запрет не‑клавиатурных символов.
+- `SPELL000` — нет словарей для проверки.
+- `SPELL001` — неизвестное слово.
+- `SPELL002` — запрещённое слово «пиксель».
+- `SPELL003` — требуется «ё» вместо «е».
+
+## Формат вывода
+```
+path:line:col [RULE_ID] message
+  | source line
+  |    ^
+```
+
+## Коды выхода
+- `0` — ошибок нет.
+- `1` — найдены проблемы.
+
+## Разработка
+```bash
+poetry install
+poetry run lint-gost-tex --root main.tex
+```
+
+## Лицензия
+MIT. См. `LICENSE`.

lint_gost_tex-0.1.1/SECURITY.md

@@ -0,0 +1,7 @@
+# Security Policy
+
+Если вы нашли уязвимость, пожалуйста:
+1) Не публикуйте детали в публичных issues.
+2) Используйте приватный канал (GitHub Security Advisories) или другой приватный способ связи.
+
+Мы постараемся ответить как можно быстрее.

lint_gost_tex-0.1.1/examples/dictionaries/custom.txt

@@ -0,0 +1 @@
+# Add project-specific allowed words here, one per line.

lint_gost_tex-0.1.1/examples/dictionaries/ru.txt

@@ -0,0 +1 @@
+# Add a Russian base wordlist here (one word per line).

lint_gost_tex-0.1.1/examples/lint-gost-tex.toml

@@ -0,0 +1,173 @@
+[document]
+root = "main.tex"
+exclude = []
+
+[rules.images]
+required_width = "0.9\\textwidth"
+
+[rules.refs]
+commands = ["ref", "eqref", "autoref", "pageref", "cref", "Cref"]
+
+[rules.links]
+commands = [
+  "ref",
+  "eqref",
+  "autoref",
+  "pageref",
+  "cref",
+  "Cref",
+  "cite",
+  "citep",
+  "citet",
+  "citealp",
+  "citeauthor",
+  "citeyear",
+  "citeyearpar",
+  "url",
+  "href",
+  "hyperref",
+]
+
+[rules.styles]
+commands = ["underline", "uline", "ul", "textit", "textsl", "emph", "em", "itshape", "it"]
+
+[rules.lists]
+allowed_envs = ["itemize", "enumerate"]
+list_envs = ["itemize", "enumerate", "description", "list"]
+disallow_begin_optional = true
+disallow_item_optional = true
+
+[rules.captions]
+commands = ["caption", "captionof"]
+forbid_trailing = [".", ",", ";", ":", "!", "?"]
+
+[rules.illustrations]
+envs = ["figure", "table", "figure*", "table*"]
+ref_commands = ["ref", "autoref", "cref", "Cref", "pageref", "eqref"]
+
+[rules.abbrev]
+banned_words = [
+  "\u0441\u043c",
+  "\u0440\u0438\u0441",
+  "\u0442\u0430\u0431\u043b",
+  "\u0441\u0442\u0440",
+  "\u0433\u043b",
+  "\u0440\u0430\u0437\u0434",
+  "\u043f\u0440\u0438\u043b",
+]
+banned_patterns = [
+  "\\b\\u0442\\.\\s*\\u0434\\.",
+  "\\b\\u0442\\.\\s*\\u043f\\.",
+  "\\b\\u0438\\s+\\u0442\\.\\s*\\u0434\\.",
+  "\\b\\u0438\\s+\\u0442\\.\\s*\\u043f\\.",
+  "\\b\\u0442\\.\\s*\\u0435\\.",
+  "\\b\\u0442\\.\\s*\\u043a\\.",
+  "\\b\\u0442\\.\\s*\\u043e\\.",
+  "\\b\\u0438\\s+\\u0434\\u0440\\.",
+]
+allow_words = []
+skip_commands = [
+  "include",
+  "input",
+  "cite",
+  "citep",
+  "citet",
+  "citealp",
+  "citeauthor",
+  "citeyear",
+  "citeyearpar",
+  "ref",
+  "eqref",
+  "autoref",
+  "pageref",
+  "cref",
+  "Cref",
+  "label",
+  "url",
+  "href",
+  "hyperref",
+  "includegraphics",
+  "includepdf",
+  "graphicspath",
+]
+two_arg_commands = ["href", "hyperref"]
+
+[rules.unicode]
+allowed_extra = ["\u2116", "\u00ab", "\u00bb"]
+
+[rules.list_items]
+skip_commands = [
+  "include",
+  "input",
+  "cite",
+  "citep",
+  "citet",
+  "citealp",
+  "citeauthor",
+  "citeyear",
+  "citeyearpar",
+  "ref",
+  "eqref",
+  "autoref",
+  "pageref",
+  "cref",
+  "Cref",
+  "label",
+  "url",
+  "href",
+  "hyperref",
+  "includegraphics",
+  "includepdf",
+  "graphicspath",
+]
+two_arg_commands = ["href", "hyperref"]
+sentence_endings = [".", "!", "?"]
+last_end = "."
+non_last_end = ";"
+
+[spellcheck]
+custom_dict = "dictionaries/custom.txt"
+extra_ru_dicts = ["dictionaries/ru.txt"]
+extra_en_dicts = []
+ignore_envs = [
+  "lstlisting",
+  "verbatim",
+  "verbatim*",
+  "minted",
+  "tikzpicture",
+  "equation",
+  "equation*",
+  "align",
+  "align*",
+  "gather",
+  "gather*",
+  "multline",
+  "multline*",
+]
+skip_commands = [
+  "include",
+  "input",
+  "cite",
+  "citep",
+  "citet",
+  "citealp",
+  "citeauthor",
+  "citeyear",
+  "citeyearpar",
+  "ref",
+  "eqref",
+  "autoref",
+  "pageref",
+  "cref",
+  "Cref",
+  "label",
+  "url",
+  "href",
+  "hyperref",
+  "includegraphics",
+  "includepdf",
+  "graphicspath",
+]
+keep_commands = ["textbf", "textrm", "textsf", "texttt", "textsc"]
+min_word_length = 2
+ignore_uppercase_acronyms = true

lint_gost_tex-0.1.1/pyproject.toml

@@ -0,0 +1,37 @@
+[tool.poetry]
+name = "lint-gost-tex"
+version = "0.1.1"
+description = "LaTeX linter for GOST-styled documents."
+authors = ["Lint GOST TeX contributors"]
+license = "MIT"
+readme = "README.md"
+packages = [{ include = "lint_gost_tex", from = "src" }]
+keywords = ["latex", "gost", "linter", "tex"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Text Processing :: Markup :: LaTeX",
+  "Topic :: Software Development :: Quality Assurance",
+]
+include = [
+  "LICENSE",
+  "CHANGELOG.md",
+  "CODE_OF_CONDUCT.md",
+  "CONTRIBUTING.md",
+  "SECURITY.md",
+  "examples/**",
+]
+
+[tool.poetry.dependencies]
+python = ">=3.11,<4.0"
+
+[tool.poetry.scripts]
+lint-gost-tex = "lint_gost_tex.cli:main"
+
+[build-system]
+requires = ["poetry-core>=1.7.0"]
+build-backend = "poetry.core.masonry.api"

lint_gost_tex-0.1.1/src/lint_gost_tex/__init__.py

@@ -0,0 +1,13 @@
+"""LaTeX linting package for GOST-styled documents."""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+
+
+try:
+    __version__ = version("lint-gost-tex")
+except PackageNotFoundError:  # pragma: no cover - fallback for editable installs
+    __version__ = "0.0.0"
+
+__all__ = ["__version__"]

lint_gost_tex-0.1.1/src/lint_gost_tex/__main__.py

@@ -0,0 +1,5 @@
+from .cli import main
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

lint_gost_tex-0.1.1/src/lint_gost_tex/cli.py

@@ -0,0 +1,85 @@
+from __future__ import annotations
+
+import argparse
+import os
+from pathlib import Path
+
+from .config import DEFAULT_CONFIG_FILENAME, Config, DocumentConfig
+from .context import LintContext
+from .document import load_document
+from .rules import build_rules
+
+
+def main(argv: list[str] | None = None) -> int:
+    parser = argparse.ArgumentParser(description="Lint LaTeX sources.")
+    parser.add_argument(
+        "--config",
+        default=DEFAULT_CONFIG_FILENAME,
+        help="Path to lint-gost-tex config file.",
+    )
+    parser.add_argument("--root", help="Override root .tex file path.")
+    args = parser.parse_args(argv)
+
+    base_dir = Path.cwd()
+    config_path = Path(args.config) if args.config else None
+    config = Config.load(config_path, base_dir)
+    if args.root:
+        root_path = Path(args.root)
+        if not root_path.is_absolute():
+            root_path = base_dir / root_path
+        config = _override_root(config, root_path)
+
+    document = load_document(config.document, base_dir)
+    ctx = LintContext(document=document, config=config, base_dir=base_dir, config_path=config_path)
+    issues = []
+    for rule in build_rules(config):
+        issues.extend(rule.check(ctx))
+
+    path_index = document.path_index()
+    issues.sort(key=lambda item: (path_index.get(item.path, 9999), item.line, item.col, item.rule_id))
+
+    for issue in issues:
+        print(_format_issue(issue, base_dir))
+
+    if issues:
+        print(f"{len(issues)} issue(s) found.")
+        return 1
+    print("No issues found.")
+    return 0
+
+
+def _override_root(config: Config, root: Path) -> Config:
+    document = DocumentConfig(root=root, exclude=config.document.exclude)
+    return Config(
+        document=document,
+        images=config.images,
+        refs=config.refs,
+        links=config.links,
+        styles=config.styles,
+        lists=config.lists,
+        captions=config.captions,
+        illustrations=config.illustrations,
+        abbrev=config.abbrev,
+        unicode=config.unicode,
+        list_items=config.list_items,
+        spellcheck=config.spellcheck,
+    )
+
+
+def _format_issue(issue, base_dir: Path) -> str:
+    path = _rel_path(issue.path, base_dir)
+    location = f"{path}:{issue.line}:{issue.col}"
+    lines = [f"{location} [{issue.rule_id}] {issue.message}"]
+    if issue.snippet:
+        lines.append(f"  | {issue.snippet}")
+        if issue.col > 0:
+            caret = " " * (issue.col - 1)
+            lines.append(f"  | {caret}^")
+    return "\n".join(lines)
+
+
+def _rel_path(path: Path, base_dir: Path) -> str:
+    try:
+        return os.path.relpath(path, base_dir)
+    except ValueError:
+        return str(path)