dnrops
/
yutto
mirror of https://github.com/yutto-dev/yutto
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

📝 docs: update description about formatter and cleanup black config

This commit is contained in:
SigureMo 2023-12-25 02:39:28 +08:00
parent 82dbd3eef2
commit 59e731434d
No known key found for this signature in database
GPG Key ID: F99A3CD7BD76B247
2 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -26,7 +26,7 @@ pip install poetry
### 编辑器 Visual Studio Code
[VS Code](https://github.com/microsoft/vscode) 是一款功能强大的编辑器，由于 yutto 全面使用了 [Type Hints](https://docs.python.org/3/library/typing.html)，所以这里建议使用 VS Code + 扩展 pylance 来保证类型提示的准确性，同时配置格式化工具 black 以保证代码格式的一致性。
[VS Code](https://github.com/microsoft/vscode) 是一款功能强大的编辑器，由于 yutto 全面使用了 [Type Hints](https://docs.python.org/3/library/typing.html)，所以这里建议使用 VS Code + 扩展 pylance 来保证类型提示的准确性，同时配置 Format/Lint 工具 [Ruff](https://github.com/astral-sh/ruff) 以保证代码格式的一致性。
当然，如果你有更熟悉的编辑器或 IDE 的话，也是完全可以的。
@ -165,7 +165,7 @@ just test
## 代码格式化
yutto 使用 black 对代码进行格式化，如果你的编辑器或 IDE 没有自动使用 black 进行格式化，请使用下面的命令对代码进行格式化
yutto 使用 Ruff 对代码进行格式化，如果你的编辑器或 IDE 没有自动使用 Ruff 进行格式化，请使用下面的命令对代码进行格式化
```bash
just fmt

5
pyproject.toml
View File

@ -46,9 +46,6 @@ yutto = "yutto.__main__:main"
[tool.pytest.ini_options]
markers = ["api", "e2e", "processor", "ignore", "ci_skip", "ci_only"]
[tool.black]
line-length = 120
[tool.pyright]
include = ["yutto", "tests"]
pythonVersion = "3.9"
@ -77,7 +74,7 @@ select = [
"RUF100",
]
ignore = [
"E501", # line too long, duplicate with black
"E501", # line too long, duplicate with ruff fmt
"F401", # imported but unused, duplicate with pyright
"F841", # local variable is assigned to but never used, duplicate with pyright
]