taozuqin/rime-ice
1
0
Fork 0
mirror of https://github.com/iDvel/rime-ice.git synced 2026-05-14 00:30:37 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
79e54cdc897e2632d7d4cd84665bd518ef3d9c4e
rime-ice/others/script/lint/README.md
mirtlecn 17a04afe39 test: add lint scripts. (#1512) 
* ci: add lint scripts
* fix(lint): handle luacheck summary with ansi colors
* fix(ci): use luarocks to install luacheck
* fix(ci): add sudo
* test: 调整用例顺序
2026-03-26 17:20:57 +08:00

1.2 KiB
Raw Blame History

YAML and Lua lint entrypoint

This directory contains the lightweight lint entrypoint used by local commands.

Dependencies

Current stage:

  • yamllint
  • luacheck

Example install on macOS:

brew install yamllint luacheck

Usage

From the repository root:

bash others/script/lint/run.sh yaml-lint
bash others/script/lint/run.sh lua-lint
bash others/script/lint/run.sh all
make -C others/script lint-yaml
make -C others/script lint-lua
make -C others/script lint
make -C others/script smoke

Notes

  • The current implementation enables YAML linting and Lua linting.
  • The first stage checks repository-root business YAML files and root *.schema.yaml files.
  • *.schema.yaml files are preprocessed before linting so the pin_cand_filter tab-separated list does not break generic YAML parsing.
  • lua-lint runs luacheck with a repository-local configuration derived from the librime-lua globals currently used by this repository.
  • lua-format-check is reserved for a later stage.
  • smoke mirrors the current CI smoke invocation and runs bash ./others/script/smoke/run.sh rime_ice through Make.
  • GitHub Actions are intentionally not changed in this stage.