@owenlamont/ryl 0.4.1
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/.github/CODEOWNERS +1 -0
- package/.github/dependabot.yml +13 -0
- package/.github/workflows/ci.yml +107 -0
- package/.github/workflows/release.yml +613 -0
- package/.github/workflows/update_dependencies.yml +61 -0
- package/.github/workflows/update_linters.yml +56 -0
- package/.pre-commit-config.yaml +87 -0
- package/.yamllint +4 -0
- package/AGENTS.md +200 -0
- package/Cargo.lock +908 -0
- package/Cargo.toml +32 -0
- package/LICENSE +21 -0
- package/README.md +230 -0
- package/bin/ryl.js +1 -0
- package/clippy.toml +1 -0
- package/docs/config-presets.md +100 -0
- package/img/benchmark-5x5-5runs.svg +2176 -0
- package/package.json +28 -0
- package/pyproject.toml +42 -0
- package/ruff.toml +107 -0
- package/rumdl.toml +20 -0
- package/rust-toolchain.toml +3 -0
- package/rustfmt.toml +3 -0
- package/scripts/benchmark_perf_vs_yamllint.py +400 -0
- package/scripts/coverage-missing.ps1 +80 -0
- package/scripts/coverage-missing.sh +60 -0
- package/src/bin/discover_config_bin.rs +24 -0
- package/src/cli_support.rs +33 -0
- package/src/conf/mod.rs +85 -0
- package/src/config.rs +2099 -0
- package/src/decoder.rs +326 -0
- package/src/discover.rs +31 -0
- package/src/lib.rs +19 -0
- package/src/lint.rs +558 -0
- package/src/main.rs +535 -0
- package/src/migrate.rs +233 -0
- package/src/rules/anchors.rs +517 -0
- package/src/rules/braces.rs +77 -0
- package/src/rules/brackets.rs +77 -0
- package/src/rules/colons.rs +475 -0
- package/src/rules/commas.rs +372 -0
- package/src/rules/comments.rs +299 -0
- package/src/rules/comments_indentation.rs +243 -0
- package/src/rules/document_end.rs +175 -0
- package/src/rules/document_start.rs +84 -0
- package/src/rules/empty_lines.rs +152 -0
- package/src/rules/empty_values.rs +255 -0
- package/src/rules/float_values.rs +259 -0
- package/src/rules/flow_collection.rs +562 -0
- package/src/rules/hyphens.rs +104 -0
- package/src/rules/indentation.rs +803 -0
- package/src/rules/key_duplicates.rs +218 -0
- package/src/rules/key_ordering.rs +303 -0
- package/src/rules/line_length.rs +326 -0
- package/src/rules/mod.rs +25 -0
- package/src/rules/new_line_at_end_of_file.rs +23 -0
- package/src/rules/new_lines.rs +95 -0
- package/src/rules/octal_values.rs +121 -0
- package/src/rules/quoted_strings.rs +577 -0
- package/src/rules/span_utils.rs +37 -0
- package/src/rules/trailing_spaces.rs +65 -0
- package/src/rules/truthy.rs +420 -0
- package/tests/brackets_carriage_return.rs +114 -0
- package/tests/build_global_cfg_error.rs +23 -0
- package/tests/cli_anchors_rule.rs +143 -0
- package/tests/cli_braces_rule.rs +104 -0
- package/tests/cli_brackets_rule.rs +104 -0
- package/tests/cli_colons_rule.rs +65 -0
- package/tests/cli_commas_rule.rs +104 -0
- package/tests/cli_comments_indentation_rule.rs +61 -0
- package/tests/cli_comments_rule.rs +67 -0
- package/tests/cli_config_data_error.rs +30 -0
- package/tests/cli_config_flags.rs +66 -0
- package/tests/cli_config_migrate.rs +229 -0
- package/tests/cli_document_end_rule.rs +92 -0
- package/tests/cli_document_start_rule.rs +92 -0
- package/tests/cli_empty_lines_rule.rs +87 -0
- package/tests/cli_empty_values_rule.rs +68 -0
- package/tests/cli_env_config.rs +34 -0
- package/tests/cli_exit_and_errors.rs +41 -0
- package/tests/cli_file_encoding.rs +203 -0
- package/tests/cli_float_values_rule.rs +64 -0
- package/tests/cli_format_options.rs +316 -0
- package/tests/cli_global_cfg_relaxed.rs +20 -0
- package/tests/cli_hyphens_rule.rs +104 -0
- package/tests/cli_indentation_rule.rs +65 -0
- package/tests/cli_invalid_project_config.rs +39 -0
- package/tests/cli_key_duplicates_rule.rs +104 -0
- package/tests/cli_key_ordering_rule.rs +59 -0
- package/tests/cli_line_length_rule.rs +85 -0
- package/tests/cli_list_files.rs +29 -0
- package/tests/cli_new_line_rule.rs +141 -0
- package/tests/cli_new_lines_rule.rs +119 -0
- package/tests/cli_octal_values_rule.rs +60 -0
- package/tests/cli_quoted_strings_rule.rs +47 -0
- package/tests/cli_toml_config.rs +119 -0
- package/tests/cli_trailing_spaces_rule.rs +77 -0
- package/tests/cli_truthy_rule.rs +83 -0
- package/tests/cli_yaml_files_negation.rs +45 -0
- package/tests/colons_rule.rs +303 -0
- package/tests/common/compat.rs +114 -0
- package/tests/common/fake_env.rs +93 -0
- package/tests/common/mod.rs +1 -0
- package/tests/conf_builtin.rs +9 -0
- package/tests/config_anchors.rs +84 -0
- package/tests/config_braces.rs +121 -0
- package/tests/config_brackets.rs +127 -0
- package/tests/config_commas.rs +79 -0
- package/tests/config_comments.rs +65 -0
- package/tests/config_comments_indentation.rs +20 -0
- package/tests/config_deep_merge_nonstring_key.rs +24 -0
- package/tests/config_document_end.rs +54 -0
- package/tests/config_document_start.rs +55 -0
- package/tests/config_empty_lines.rs +48 -0
- package/tests/config_empty_values.rs +35 -0
- package/tests/config_env_errors.rs +23 -0
- package/tests/config_env_invalid_inline.rs +15 -0
- package/tests/config_env_missing.rs +63 -0
- package/tests/config_env_shim.rs +301 -0
- package/tests/config_explicit_file_parse_error.rs +55 -0
- package/tests/config_extended_features.rs +225 -0
- package/tests/config_extends_inline.rs +185 -0
- package/tests/config_extends_sequence.rs +18 -0
- package/tests/config_find_project_home_boundary.rs +54 -0
- package/tests/config_find_project_two_files_in_cwd.rs +47 -0
- package/tests/config_float_values.rs +34 -0
- package/tests/config_from_yaml_paths.rs +32 -0
- package/tests/config_hyphens.rs +51 -0
- package/tests/config_ignore_errors.rs +243 -0
- package/tests/config_ignore_overrides.rs +83 -0
- package/tests/config_indentation.rs +65 -0
- package/tests/config_invalid_globs.rs +16 -0
- package/tests/config_invalid_types.rs +19 -0
- package/tests/config_key_duplicates.rs +34 -0
- package/tests/config_key_ordering.rs +70 -0
- package/tests/config_line_length.rs +65 -0
- package/tests/config_locale.rs +111 -0
- package/tests/config_merge.rs +26 -0
- package/tests/config_new_lines.rs +89 -0
- package/tests/config_octal_values.rs +33 -0
- package/tests/config_quoted_strings.rs +195 -0
- package/tests/config_rule_level.rs +147 -0
- package/tests/config_rules_non_string_keys.rs +23 -0
- package/tests/config_scalar_overrides.rs +27 -0
- package/tests/config_to_toml.rs +110 -0
- package/tests/config_toml_coverage.rs +80 -0
- package/tests/config_toml_discovery.rs +304 -0
- package/tests/config_trailing_spaces.rs +152 -0
- package/tests/config_truthy.rs +77 -0
- package/tests/config_yaml_files.rs +62 -0
- package/tests/config_yaml_files_all_non_string.rs +15 -0
- package/tests/config_yaml_files_empty.rs +30 -0
- package/tests/coverage_commas.rs +46 -0
- package/tests/decoder_decode.rs +338 -0
- package/tests/discover_config_bin_all.rs +66 -0
- package/tests/discover_config_bin_env_invalid_yaml.rs +26 -0
- package/tests/discover_config_bin_project_config_parse_error.rs +24 -0
- package/tests/discover_config_bin_user_global_error.rs +26 -0
- package/tests/discover_module.rs +30 -0
- package/tests/discover_per_file_dir.rs +10 -0
- package/tests/discover_per_file_project_config_error.rs +21 -0
- package/tests/float_values.rs +43 -0
- package/tests/lint_multi_errors.rs +32 -0
- package/tests/main_yaml_ok_filtering.rs +30 -0
- package/tests/migrate_module.rs +259 -0
- package/tests/resolve_ctx_empty_parent.rs +16 -0
- package/tests/rule_anchors.rs +442 -0
- package/tests/rule_braces.rs +258 -0
- package/tests/rule_brackets.rs +217 -0
- package/tests/rule_commas.rs +205 -0
- package/tests/rule_comments.rs +197 -0
- package/tests/rule_comments_indentation.rs +127 -0
- package/tests/rule_document_end.rs +118 -0
- package/tests/rule_document_start.rs +60 -0
- package/tests/rule_empty_lines.rs +96 -0
- package/tests/rule_empty_values.rs +102 -0
- package/tests/rule_float_values.rs +109 -0
- package/tests/rule_hyphens.rs +65 -0
- package/tests/rule_indentation.rs +455 -0
- package/tests/rule_key_duplicates.rs +76 -0
- package/tests/rule_key_ordering.rs +207 -0
- package/tests/rule_line_length.rs +200 -0
- package/tests/rule_new_lines.rs +51 -0
- package/tests/rule_octal_values.rs +53 -0
- package/tests/rule_quoted_strings.rs +290 -0
- package/tests/rule_trailing_spaces.rs +41 -0
- package/tests/rule_truthy.rs +236 -0
- package/tests/user_global_invalid_yaml.rs +32 -0
- package/tests/yamllint_compat_anchors.rs +280 -0
- package/tests/yamllint_compat_braces.rs +411 -0
- package/tests/yamllint_compat_brackets.rs +364 -0
- package/tests/yamllint_compat_colons.rs +298 -0
- package/tests/yamllint_compat_colors.rs +80 -0
- package/tests/yamllint_compat_commas.rs +375 -0
- package/tests/yamllint_compat_comments.rs +167 -0
- package/tests/yamllint_compat_comments_indentation.rs +281 -0
- package/tests/yamllint_compat_config.rs +170 -0
- package/tests/yamllint_compat_document_end.rs +243 -0
- package/tests/yamllint_compat_document_start.rs +136 -0
- package/tests/yamllint_compat_empty_lines.rs +117 -0
- package/tests/yamllint_compat_empty_values.rs +179 -0
- package/tests/yamllint_compat_float_values.rs +216 -0
- package/tests/yamllint_compat_hyphens.rs +223 -0
- package/tests/yamllint_compat_indentation.rs +398 -0
- package/tests/yamllint_compat_key_duplicates.rs +139 -0
- package/tests/yamllint_compat_key_ordering.rs +170 -0
- package/tests/yamllint_compat_line_length.rs +375 -0
- package/tests/yamllint_compat_list.rs +127 -0
- package/tests/yamllint_compat_new_line.rs +133 -0
- package/tests/yamllint_compat_newline_types.rs +185 -0
- package/tests/yamllint_compat_octal_values.rs +172 -0
- package/tests/yamllint_compat_quoted_strings.rs +154 -0
- package/tests/yamllint_compat_syntax.rs +200 -0
- package/tests/yamllint_compat_trailing_spaces.rs +162 -0
- package/tests/yamllint_compat_truthy.rs +130 -0
- package/tests/yamllint_compat_yaml_files.rs +81 -0
- package/typos.toml +2 -0
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
set -euo pipefail
|
|
3
|
+
|
|
4
|
+
project_root="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
|
5
|
+
cd "$project_root"
|
|
6
|
+
|
|
7
|
+
if ! command -v cargo >/dev/null 2>&1; then
|
|
8
|
+
echo "cargo is required to run this script" >&2
|
|
9
|
+
exit 1
|
|
10
|
+
fi
|
|
11
|
+
|
|
12
|
+
if ! command -v jq >/dev/null 2>&1; then
|
|
13
|
+
echo "jq is required to run this script" >&2
|
|
14
|
+
exit 1
|
|
15
|
+
fi
|
|
16
|
+
|
|
17
|
+
if ! cargo llvm-cov nextest --summary-only >/dev/null 2>&1; then
|
|
18
|
+
echo "cargo llvm-cov nextest --summary-only failed; inspect the output above for details." >&2
|
|
19
|
+
exit 1
|
|
20
|
+
fi
|
|
21
|
+
|
|
22
|
+
prefix="${project_root}/"
|
|
23
|
+
tmp_json="$(mktemp)"
|
|
24
|
+
trap 'rm -f "$tmp_json"' EXIT
|
|
25
|
+
|
|
26
|
+
cargo llvm-cov report --json --output-path "$tmp_json" >/dev/null 2>&1 || {
|
|
27
|
+
echo "Failed to generate coverage report." >&2
|
|
28
|
+
exit 1
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
report=$(jq -r --arg prefix "$prefix" '
|
|
32
|
+
def ranges:
|
|
33
|
+
sort
|
|
34
|
+
| unique
|
|
35
|
+
| reduce .[] as $line ([];
|
|
36
|
+
if length > 0 and $line == (.[-1][1] + 1) then
|
|
37
|
+
(.[-1] = [.[-1][0], $line])
|
|
38
|
+
else
|
|
39
|
+
. + [[ $line, $line ]]
|
|
40
|
+
end)
|
|
41
|
+
| map(if .[0] == .[1] then (.[0] | tostring) else "\(.[0])-\(.[1])" end);
|
|
42
|
+
|
|
43
|
+
.data[].files[]
|
|
44
|
+
| select(.summary.regions.percent < 100)
|
|
45
|
+
| {file: (.filename | sub("^" + $prefix; "")),
|
|
46
|
+
uncovered: [ .segments[]
|
|
47
|
+
| select(.[2] == 0 and .[3] == true and .[5] == false)
|
|
48
|
+
| .[0]
|
|
49
|
+
] }
|
|
50
|
+
| select(.uncovered | length > 0)
|
|
51
|
+
| "\(.file):\(.uncovered | ranges | join(","))"
|
|
52
|
+
' "$tmp_json")
|
|
53
|
+
|
|
54
|
+
if [[ -z "$report" ]]; then
|
|
55
|
+
echo "Coverage OK: no uncovered regions."
|
|
56
|
+
else
|
|
57
|
+
echo "Uncovered regions (file:path line ranges):"
|
|
58
|
+
printf '%s
|
|
59
|
+
' "$report"
|
|
60
|
+
fi
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
#![forbid(unsafe_code)]
|
|
2
|
+
#![deny(clippy::all, clippy::pedantic, clippy::nursery, clippy::cargo)]
|
|
3
|
+
|
|
4
|
+
use std::env;
|
|
5
|
+
use std::path::PathBuf;
|
|
6
|
+
|
|
7
|
+
use ryl::config::{Overrides, discover_config};
|
|
8
|
+
|
|
9
|
+
fn main() {
|
|
10
|
+
let dir = env::args()
|
|
11
|
+
.nth(1)
|
|
12
|
+
.map_or_else(|| PathBuf::from("."), PathBuf::from);
|
|
13
|
+
let inputs = vec![dir];
|
|
14
|
+
match discover_config(&inputs, &Overrides::default()) {
|
|
15
|
+
Ok(ctx) => match ctx.source {
|
|
16
|
+
Some(p) => println!("{}", p.display()),
|
|
17
|
+
None => println!(),
|
|
18
|
+
},
|
|
19
|
+
Err(e) => {
|
|
20
|
+
eprintln!("{e}");
|
|
21
|
+
std::process::exit(2);
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
use std::collections::HashMap;
|
|
2
|
+
use std::hash::BuildHasher;
|
|
3
|
+
use std::path::{Path, PathBuf};
|
|
4
|
+
|
|
5
|
+
use crate::config::{ConfigContext, YamlLintConfig, discover_per_file};
|
|
6
|
+
|
|
7
|
+
/// Resolve the configuration context for a given file path, optionally using a cached
|
|
8
|
+
/// global configuration.
|
|
9
|
+
///
|
|
10
|
+
/// This mirrors the logic used by the CLI when filtering candidate files.
|
|
11
|
+
///
|
|
12
|
+
/// # Errors
|
|
13
|
+
/// Returns an error when configuration discovery fails for the provided path.
|
|
14
|
+
pub fn resolve_ctx<S: BuildHasher>(
|
|
15
|
+
path: &Path,
|
|
16
|
+
global_cfg: Option<&ConfigContext>,
|
|
17
|
+
cache: &mut HashMap<PathBuf, (PathBuf, YamlLintConfig), S>,
|
|
18
|
+
) -> Result<(PathBuf, YamlLintConfig, Vec<String>), String> {
|
|
19
|
+
if let Some(gc) = global_cfg {
|
|
20
|
+
return Ok((gc.base_dir.clone(), gc.config.clone(), Vec::new()));
|
|
21
|
+
}
|
|
22
|
+
let start = path
|
|
23
|
+
.parent()
|
|
24
|
+
.map_or_else(|| PathBuf::from("."), PathBuf::from);
|
|
25
|
+
if let Some(pair) = cache.get(&start).cloned() {
|
|
26
|
+
return Ok((pair.0, pair.1, Vec::new()));
|
|
27
|
+
}
|
|
28
|
+
let ctx = discover_per_file(path)?;
|
|
29
|
+
let pair = (ctx.base_dir.clone(), ctx.config);
|
|
30
|
+
let notices = ctx.notices;
|
|
31
|
+
cache.insert(start, pair.clone());
|
|
32
|
+
Ok((pair.0, pair.1, notices))
|
|
33
|
+
}
|
package/src/conf/mod.rs
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
#![allow(clippy::module_name_repetitions)]
|
|
2
|
+
|
|
3
|
+
// Built-in presets to support `extends`, mirroring yamllint.
|
|
4
|
+
|
|
5
|
+
#[must_use]
|
|
6
|
+
pub fn builtin(name: &str) -> Option<&'static str> {
|
|
7
|
+
match name {
|
|
8
|
+
"default" => Some(DEFAULT),
|
|
9
|
+
"relaxed" => Some(RELAXED),
|
|
10
|
+
"empty" => Some(EMPTY),
|
|
11
|
+
_ => None,
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
const DEFAULT: &str = r"---
|
|
16
|
+
|
|
17
|
+
yaml-files:
|
|
18
|
+
- '*.yaml'
|
|
19
|
+
- '*.yml'
|
|
20
|
+
- '.yamllint'
|
|
21
|
+
|
|
22
|
+
rules:
|
|
23
|
+
anchors: enable
|
|
24
|
+
braces: enable
|
|
25
|
+
brackets: enable
|
|
26
|
+
colons: enable
|
|
27
|
+
commas: enable
|
|
28
|
+
comments:
|
|
29
|
+
level: warning
|
|
30
|
+
comments-indentation:
|
|
31
|
+
level: warning
|
|
32
|
+
document-end: disable
|
|
33
|
+
document-start:
|
|
34
|
+
level: warning
|
|
35
|
+
empty-lines: enable
|
|
36
|
+
empty-values: disable
|
|
37
|
+
float-values: disable
|
|
38
|
+
hyphens: enable
|
|
39
|
+
indentation: enable
|
|
40
|
+
key-duplicates: enable
|
|
41
|
+
key-ordering: disable
|
|
42
|
+
line-length: enable
|
|
43
|
+
new-line-at-end-of-file: enable
|
|
44
|
+
new-lines: enable
|
|
45
|
+
octal-values: disable
|
|
46
|
+
quoted-strings: disable
|
|
47
|
+
trailing-spaces: enable
|
|
48
|
+
truthy:
|
|
49
|
+
level: warning
|
|
50
|
+
";
|
|
51
|
+
|
|
52
|
+
const RELAXED: &str = r"---
|
|
53
|
+
|
|
54
|
+
extends: default
|
|
55
|
+
|
|
56
|
+
rules:
|
|
57
|
+
braces:
|
|
58
|
+
level: warning
|
|
59
|
+
max-spaces-inside: 1
|
|
60
|
+
brackets:
|
|
61
|
+
level: warning
|
|
62
|
+
max-spaces-inside: 1
|
|
63
|
+
colons:
|
|
64
|
+
level: warning
|
|
65
|
+
commas:
|
|
66
|
+
level: warning
|
|
67
|
+
comments: disable
|
|
68
|
+
comments-indentation: disable
|
|
69
|
+
document-start: disable
|
|
70
|
+
empty-lines:
|
|
71
|
+
level: warning
|
|
72
|
+
hyphens:
|
|
73
|
+
level: warning
|
|
74
|
+
indentation:
|
|
75
|
+
level: warning
|
|
76
|
+
indent-sequences: consistent
|
|
77
|
+
line-length:
|
|
78
|
+
level: warning
|
|
79
|
+
allow-non-breakable-inline-mappings: true
|
|
80
|
+
truthy: disable
|
|
81
|
+
";
|
|
82
|
+
|
|
83
|
+
const EMPTY: &str = r"
|
|
84
|
+
rules: {}
|
|
85
|
+
";
|