feat(all): pre-commit (#173)

Author: xingchensong

.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+    - id: trailing-whitespace
+  - repo: https://github.com/pre-commit/mirrors-yapf
+    rev: 'v0.32.0'
+    hooks:
+    - id: yapf
+  - repo: https://github.com/pycqa/flake8
+    rev: '3.8.2'
+    hooks:
+    - id: flake8
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: 'v17.0.6'
+    hooks:
+    - id: clang-format
+  - repo: https://github.com/cpplint/cpplint
+    rev: '1.6.1'
+    hooks:
+    - id: cpplint

README.md

@@ -53,6 +53,8 @@ For users who want modifications and adapt tn/itn rules to fix badcase, please t
 ``` bash
 git clone https://github.com/wenet-e2e/WeTextProcessing.git
 cd WeTextProcessing
+pip install -r requirements.txt
+pre-commit install # for clean and tidy code
 # `overwrite_cache` will rebuild all rules according to
 #   your modifications on tn/chinese/rules/xx.py (itn/chinese/rules/xx.py).
 #   After rebuild, you can find new far files at `$PWD/tn` and `$PWD/itn`.

requirements.txt

@@ -2,3 +2,4 @@ flake8
 importlib_resources
 pynini==2.1.5
 pytest
+pre-commit==3.5.0