@owenlamont/ryl-win32-arm64-msvc 0.22.0 → 0.24.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 +17 -10
- package/bin/ryl.exe +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -24,15 +24,16 @@ Full documentation lives at <https://ryl-docs.pages.dev/>.
|
|
|
24
24
|
|
|
25
25
|
## Quick start
|
|
26
26
|
|
|
27
|
-
ryl enables no rules by default, so it needs a configuration
|
|
28
|
-
`-d 'extends: default'` opts into yamllint's standard rule set for
|
|
29
|
-
|
|
27
|
+
ryl enables no rules by default, so it needs a configuration or `--enable` that
|
|
28
|
+
turns rules on. `-d 'extends: default'` opts into yamllint's standard rule set for
|
|
29
|
+
a one-off run, and `--enable <RULES>` runs just the named rules; for a project,
|
|
30
|
+
drop a `.ryl.toml` at the root (see
|
|
30
31
|
[Configuration](https://ryl-docs.pages.dev/getting-started/quickstart/)).
|
|
31
32
|
|
|
32
33
|
`ryl check` is the lint subcommand (a `ryl format` formatter is coming) and the
|
|
33
|
-
recommended form. Bare `ryl <paths>` still lints identically
|
|
34
|
-
|
|
35
|
-
prefer `ryl check`.
|
|
34
|
+
recommended form. Bare `ryl <paths>` still lints identically but is deprecated: it
|
|
35
|
+
prints a warning to stderr (silenced by `--no-warnings`) and a later release will
|
|
36
|
+
remove it, so prefer `ryl check`.
|
|
36
37
|
|
|
37
38
|
```bash
|
|
38
39
|
# Using uv (Python)
|
|
@@ -56,6 +57,9 @@ pixi global install ryl # conda-forge
|
|
|
56
57
|
winget install owenlamont.ryl # winget (Windows)
|
|
57
58
|
```
|
|
58
59
|
|
|
60
|
+
Building from source (`cargo install`, or a `pip` sdist) needs Rust 1.99.0 or
|
|
61
|
+
newer. The prebuilt wheels, npm, conda-forge and winget packages do not.
|
|
62
|
+
|
|
59
63
|
## Status and scope
|
|
60
64
|
|
|
61
65
|
- All 23 yamllint rules are implemented, plus four ryl-only rules with no
|
|
@@ -64,9 +68,10 @@ winget install owenlamont.ryl # winget (Windows)
|
|
|
64
68
|
and per-rule pages are at <https://ryl-docs.pages.dev/rules/>.
|
|
65
69
|
- Auto-fixing (`--fix`) is supported for `braces`, `brackets`, `commas`,
|
|
66
70
|
`comments`, `comments-indentation`, `document-end`, `document-start`,
|
|
67
|
-
`empty-lines`, `new-line-at-end-of-file`, `new-lines`,
|
|
68
|
-
|
|
69
|
-
configurable via the
|
|
71
|
+
`empty-lines`, `key-ordering`, `new-line-at-end-of-file`, `new-lines`,
|
|
72
|
+
`quoted-strings`, `trailing-spaces`, and `truthy` (case only, e.g. `True`
|
|
73
|
+
to `true`). The set of rules that may apply fixes is configurable via the
|
|
74
|
+
TOML `[fix]` table.
|
|
70
75
|
- `--diff` previews those safe fixes as a unified diff on stdout instead
|
|
71
76
|
of writing them (modelled on `ruff check --diff`); it is mutually
|
|
72
77
|
exclusive with `--fix`, works with stdin, and exits `1` iff some file
|
|
@@ -91,7 +96,9 @@ winget install owenlamont.ryl # winget (Windows)
|
|
|
91
96
|
- `--list-files` prints the files ryl would lint (after ignores and
|
|
92
97
|
config discovery) and exits, without running rules. `--no-warnings`
|
|
93
98
|
suppresses warning-level diagnostics in the output. `--strict` turns a
|
|
94
|
-
warning-only run into exit code `2`.
|
|
99
|
+
warning-only run into exit code `2`. `--enable <RULES>` runs exactly the
|
|
100
|
+
listed rules (comma-separated IDs, or `ALL`) in place of the config's
|
|
101
|
+
selection, and needs no config file.
|
|
95
102
|
- Pass `-` as the input to read YAML from stdin (ruff convention). Add
|
|
96
103
|
`--stdin-filename <PATH>` so diagnostics, project-config discovery,
|
|
97
104
|
and path-based filtering (`yaml-files`, per-file-ignores, per-rule
|
package/bin/ryl.exe
CHANGED
|
Binary file
|