You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: plain-code/plain/code/README.md
+29-1Lines changed: 29 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,13 @@
8
8
9
9
## Overview
10
10
11
-
The `plain code` command lints and formats Python files using [Ruff](https://astral.sh/ruff), and JavaScript, JSON, and CSS files using [Biome](https://biomejs.dev/). Ruff is installed as a Python dependency, and Biome is managed automatically as a standalone binary (npm is not required).
11
+
The `plain code` command provides comprehensive code quality tools:
12
+
13
+
-**[Ruff](https://astral.sh/ruff)** - Python linting and formatting
14
+
-**[ty](https://astral.sh/ty)** - Python type checking
15
+
-**[Biome](https://biomejs.dev/)** - JavaScript, JSON, and CSS formatting
16
+
17
+
Ruff and ty are installed as Python dependencies. Biome is managed automatically as a standalone binary (npm is not required).
12
18
13
19
The most used command is `plain code fix`, which can be run using the alias `plain fix`:
14
20
@@ -20,6 +26,25 @@ This will automatically fix linting issues and format your code according to the
To check your code without making changes (including type checking):
30
+
31
+
```bash
32
+
plain code check
33
+
```
34
+
35
+
You can skip specific tools if needed:
36
+
37
+
```bash
38
+
# Skip type checking during rapid development
39
+
plain code check --skip-ty
40
+
41
+
# Only run type checks
42
+
plain code check --skip-ruff --skip-biome
43
+
44
+
# Skip Biome checks
45
+
plain code check --skip-biome
46
+
```
47
+
23
48
If [`plain.dev`](/plain-dev/README.md) is installed then `plain code check` will be run automatically as a part of `plain precommit` to help catch issues before they are committed.
24
49
25
50
## Configuration
@@ -32,6 +57,9 @@ You can customize the behavior in your `pyproject.toml`:
0 commit comments