PhysLean/scripts
2024-07-09 15:25:06 -04:00
..
check_file_imports.lean remove matrix.rank file 2024-06-27 08:43:57 -04:00
double_line_lint.lean chore: Double line linter 2024-07-03 07:41:06 -04:00
find_TODOs.lean feat: change docs 2024-07-09 15:25:06 -04:00
lint-all.sh refactor: Lorentz Group etc. 2024-07-02 10:13:52 -04:00
lint-style.py Changing file permissions 2024-04-16 15:34:27 -04:00
lint-style.sh Changing file permissions 2024-04-16 15:34:27 -04:00
README.md docs: Add documentation for scripts 2024-07-09 11:39:02 -04:00
style-exceptions.txt feat: Add relation to mathlib4 defns 2024-04-17 10:25:05 -04:00
type_former_lint.lean refactor: Change case of type and props 2024-06-26 11:54:02 -04:00

Scripts associated with HepLean

lint-style.py and lint-style.sh

Taken from Mathlib's linters. These perform text-based linting of the code.

These are to be slowly replaced with code written in Lean.

double_line_lint

Checks for double empty lines in HepLean. Passing this linter is currently not required to pass CI on github.

Run using

lake exe double_line_lint

check_file_imports.lean

Checks all files are correctly imported into HepLean.lean.

Run using

lake exe check_file_imports

type_former_lint.lean

Checks whether the name of definitions which form a type or prop starts with a capital letter.

Run using

lake exe type_former_lint

lint-all.sh

Performs all linting checks on HepLean.

Run using

./scripts/lint-all.sh

Other useful commands

  • To build HepLean use
lake exe cache get 
lake build
  • To update HepLean's dependencies use
lake update