@owenlamont/ryl-linux-x64-musl 0.10.2 → 0.12.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 +14 -2
- package/bin/ryl +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -24,12 +24,17 @@ 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 that turns rules on.
|
|
28
|
+
`-d 'extends: default'` opts into yamllint's standard rule set for a one-off run;
|
|
29
|
+
for a project, drop a `.ryl.toml` at the root (see
|
|
30
|
+
[Configuration](https://ryl-docs.pages.dev/getting-started/quickstart/)).
|
|
31
|
+
|
|
27
32
|
```bash
|
|
28
33
|
# Using uv (Python)
|
|
29
|
-
uvx ryl .
|
|
34
|
+
uvx ryl -d 'extends: default' .
|
|
30
35
|
|
|
31
36
|
# Using npx (Node.js)
|
|
32
|
-
npx @owenlamont/ryl .
|
|
37
|
+
npx @owenlamont/ryl -d 'extends: default' .
|
|
33
38
|
```
|
|
34
39
|
|
|
35
40
|
For `prek` / `pre-commit` integration, see
|
|
@@ -57,6 +62,13 @@ cargo install ryl # cargo
|
|
|
57
62
|
features that have no upstream equivalent: the `[fix]` table,
|
|
58
63
|
`[per-file-ignores]`, and rule options such as
|
|
59
64
|
`allow-double-quotes-for-escaping`.
|
|
65
|
+
- TOML assigns each file a source kind via the `[files]` table
|
|
66
|
+
(`yaml = [...]`, `markdown = [...]`). The legacy `yaml-files` key is YAML-only;
|
|
67
|
+
in TOML use `[files].yaml`.
|
|
68
|
+
- YAML embedded in Markdown (front matter and fenced `yaml`/`yml` blocks)
|
|
69
|
+
can be linted by listing globs under `[files].markdown`; diagnostics map back
|
|
70
|
+
to the Markdown file. It is off by default and check-only (`--fix` does not
|
|
71
|
+
modify Markdown). See <https://ryl-docs.pages.dev/markdown/>.
|
|
60
72
|
- yamllint-style YAML configuration is also accepted (`.yamllint`,
|
|
61
73
|
`.yamllint.yml`, `.yamllint.yaml`) for drop-in compatibility, including
|
|
62
74
|
the built-in `default`, `relaxed`, and `empty` presets via `extends`.
|
package/bin/ryl
CHANGED
|
Binary file
|