@owenlamont/ryl-win32-arm64-msvc 0.25.0 → 0.26.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +45 -7
- package/bin/ryl.exe +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -28,6 +28,9 @@ remove it, so prefer `ryl check`.
|
|
|
28
28
|
# Using uv (Python)
|
|
29
29
|
uvx ryl check --enable ALL .
|
|
30
30
|
|
|
31
|
+
# Omit selected rules and files without writing a config
|
|
32
|
+
uvx ryl check --enable ALL --disable line-length,truthy,document-start --exclude pnpm-lock.yaml .
|
|
33
|
+
|
|
31
34
|
# Using npx (Node.js)
|
|
32
35
|
npx @owenlamont/ryl check --enable ALL .
|
|
33
36
|
|
|
@@ -91,9 +94,17 @@ newer. The prebuilt wheels, npm, conda-forge and winget packages do not.
|
|
|
91
94
|
- `--list-files` prints the files ryl would lint (after ignores and
|
|
92
95
|
config discovery) and exits, without running rules. `--no-warnings`
|
|
93
96
|
suppresses warning-level diagnostics in the output. `--strict` turns a
|
|
94
|
-
warning-only run into exit code `2
|
|
97
|
+
warning-only run into exit code `2`; TOML `[lint] strict = true` enables the
|
|
98
|
+
same behavior for a project, and `--no-strict` overrides the config.
|
|
99
|
+
`--enable <RULES>` runs exactly the
|
|
95
100
|
listed rules (comma-separated IDs, or `ALL`) in place of the config's
|
|
96
|
-
selection, and needs no config file.
|
|
101
|
+
selection, and needs no config file. `--disable <RULES>` subtracts from the
|
|
102
|
+
selected lint rules. `--exclude <GLOBS>` replaces config file exclusions;
|
|
103
|
+
globs use the current directory and also exclude explicitly named files.
|
|
104
|
+
Both new flags accept comma-separated values and may appear once per command.
|
|
105
|
+
- `ryl check` and `ryl format` cache results by content and configuration.
|
|
106
|
+
Use `--no-cache` to bypass the cache or `--cache-dir PATH` to place it elsewhere.
|
|
107
|
+
See [caching](docs/getting-started/quickstart.md#caching).
|
|
97
108
|
- Pass `-` as the input to read YAML from stdin (ruff convention). Add
|
|
98
109
|
`--stdin-filename <PATH>` so diagnostics, project-config discovery,
|
|
99
110
|
and path-based filtering (`yaml-files`, per-file-ignores, per-rule
|
|
@@ -116,13 +127,40 @@ documentation, see the docs site.
|
|
|
116
127
|
|
|
117
128
|
## Performance
|
|
118
129
|
|
|
119
|
-
The
|
|
120
|
-
|
|
130
|
+
The chart compares lint and format times on real-world YAML sampled from pinned
|
|
131
|
+
repositories: 20–100 files × 1–9 KiB, with five runs per point.
|
|
132
|
+
|
|
133
|
+

|
|
134
|
+
|
|
135
|
+
The [benchmark script](scripts/benchmark_yaml_tools.py) also offers a generated stress dataset with `--datasets stress`.
|
|
136
|
+
|
|
137
|
+
| Tool | Mode | Real-world mean, 100 × 9 KiB (s) |
|
|
138
|
+
| --- | --- | ---: |
|
|
139
|
+
| ryl | Lint | 0.050 |
|
|
140
|
+
| yamllint | Lint | 2.304 |
|
|
141
|
+
| ryl | Format | 0.056 |
|
|
142
|
+
| yamlfmt | Format | 0.113 |
|
|
143
|
+
| Prettier | Format | 1.140 |
|
|
144
|
+
| dprint | Format | 0.105 |
|
|
145
|
+
|
|
146
|
+
| Tool | Mode | Version |
|
|
147
|
+
| --- | --- | --- |
|
|
148
|
+
| ryl | Lint, format | 0.26.0 |
|
|
149
|
+
| yamllint | Lint | 1.38.0 |
|
|
150
|
+
| yamlfmt | Format | 0.21.0 |
|
|
151
|
+
| Prettier | Format | 3.9.10 |
|
|
152
|
+
| dprint + pretty_yaml plugin | Format | 0.63.0 + 0.6.0 |
|
|
153
|
+
|
|
154
|
+
Result caches are cold; install artifacts are warm. The
|
|
155
|
+
[benchmark script](scripts/benchmark_yaml_tools.py) records the commands and
|
|
156
|
+
cache checks. On the real-world dataset, ryl format is faster than dprint and yamlfmt
|
|
157
|
+
while still verifying value preservation and convergence
|
|
158
|
+
([formatter guarantees](docs/formatter.md#guarantees)).
|
|
121
159
|
|
|
122
|
-
|
|
160
|
+
Run the benchmark with `--warm` to also record second-run timings with each
|
|
161
|
+
tool's result cache enabled. Its warm view is separate from the cold chart above.
|
|
123
162
|
|
|
124
|
-
|
|
125
|
-
it with `--help` for the full option set.
|
|
163
|
+

|
|
126
164
|
|
|
127
165
|
## Acknowledgements
|
|
128
166
|
|
package/bin/ryl.exe
CHANGED
|
Binary file
|