webpp/codestyle
webpp
自动构建
Codestyle validator and fixer for for PHP, Python, JS, HTML and CSS.
下载次数: 0状态：自动构建维护者：webpp仓库类型：镜像最近更新：5 年前
让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
!image
Инструмент проверки кода
Поддерживает несколько языков (проверяет или исправляет):
- PHP (phpcs, phpcbf)
- Python (flake8, autopep8, autoflake)
- Javascript (eslint)
- CSS (stylelint)
- HTML (htmlcs)
Консольные аргументы приложения
| Аргумент | Описание |
|---|---|
-h, --help | Отобразить вспомогательное сообщение и завершить работу программы |
-f, --fix | Исправить ошибки по возможности |
-c, --compact | Включить компактный вывод процесса работы приложения |
-q, --quiet | Включить тихий режим работы приложения (показывать только ошибки) |
-d, --debug | Включить режим отладки |
-s SETTINGS, --settings SETTINGS | Путь до директории с настройками инструментов (по умолчанию: ./tool_settings) |
--file_suffix <file_suffix> | Проверяемое расширение файлов (.py, .js и так далее; по-умолчанию: все расширения) |
-m, --mypy | Опциональная проверка типизации при помощи mypy |
-b, --black | Опциоанльное форматирование при помощи black, только после флага -f |
-hl, --hadolint | Опциональная проверка Dockerfile`ов, в файле .hadolint.yaml указать: ignored: - <номер ошибки> |
-x <globbing шаблон>, --exclude <globbing шаблон> | Исключить по указанному globbing шаблону, для файла необходимо указывать список exclude = [file1, file2, ...] |
--phpcs-encoding PHPCS_ENCODING | Кодировка для PHP_CodeSniffer (по-умолчанию: utf-8) |
--stylelint-configuration_name STYLELINT_CONFIGURATION | Имя файла конфигурации для stylelint утилиты (по-умолчанию: .stylelintsrc.json) |
--phpcbf-configuration_name PHPCBF_CONFIGURATION | Имя файла конфигурации для phpcbf утилиты (по-умолчанию: phpcs.xml) |
--phpcs-configuration_name PHPCS_CONFIGURATION | Имя файла конфигурации для phpcs утилиты (по-умолчанию: phpcs.xml |
--flake8-configuration_name FLAKE8_CONFIGURATION | Имя файла конфигурации для flake8 утилиты (по-умолчанию: flake8.conf |
--htmlcs-configuration_name HTMLCS_CONFIGURATION | Имя файла конфигурации для htmlcs утилиты (по-умолчанию: htmlcs.json |
--eslint-configuration_name ESLINT_CONFIGURATION | Имя файла конфигурации для cssbomb утилиты (по-умолчанию: eslint.json) |
-v, --version | Отобразить версию приложения и завершить работу программы |
Порядок использования консольных аргументов приложения
codestyle [-h] [-f] [-c] [-q] [-d] [-s SETTINGS] [--file_suffix <file suffix>] [-x <globbing шаблон> [<globbing шаблон> ...]] [--phpcs-encoding PHPCS_ENCODING] [--stylelint-configuration_name STYLELINT_CONFIGURATION] [--phpcbf-configuration_name PHPCBF_CONFIGURATION] [--phpcs-configuration_name PHPCS_CONFIGURATION] [--flake8-configuration_name FLAKE8_CONFIGURATION] [--htmlcs-configuration_name HTMLCS_CONFIGURATION] [--eslint-configuration_name ESLINT_CONFIGURATION] [-v] target [target ...]
Использование в качестве устанавливаемого приложения
Требования
-
NPM : - https://github.com/eslint/eslint - https://github.com/vuejs/eslint-plugin-vue - https://github.com/stylelint/stylelint - htmlcs
-
https://github.com/squizlabs/PHP_CodeSniffer
-
Python (3.6 / 3.7 / 3.8 / 3.9) и pip
Установка
./setup.py install
Пример использования
python -m codestyle /checking_directory --compact --quiet --exclude /checking_directory/dirty.py
Использование в Docker контейнере
Сборка образа
docker build --tag codestyle:latest .
Пример использования
docker run --volume <checking_directory>:/code --workdir /code --tty codestyle:latest /code --exclude /code/dirty.py
Процесс разработки с docker-compose
Сборка образа
docker-compose build
Запуск
docker-compose run cli-tool <консольные аргументы приложения, перечисленные выше>
Обновление документации для Sphinx (вне контейнера)
python -m install sphinx sphinx-apidoc --force --separate --no-toc --module-first --output-dir docs/pages codestyle codestyle/tool_settings
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
DockerHub 原生拉取命令
docker pull webpp/codestyle:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"