@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.
Files changed (217) hide show
  1. package/.github/CODEOWNERS +1 -0
  2. package/.github/dependabot.yml +13 -0
  3. package/.github/workflows/ci.yml +107 -0
  4. package/.github/workflows/release.yml +613 -0
  5. package/.github/workflows/update_dependencies.yml +61 -0
  6. package/.github/workflows/update_linters.yml +56 -0
  7. package/.pre-commit-config.yaml +87 -0
  8. package/.yamllint +4 -0
  9. package/AGENTS.md +200 -0
  10. package/Cargo.lock +908 -0
  11. package/Cargo.toml +32 -0
  12. package/LICENSE +21 -0
  13. package/README.md +230 -0
  14. package/bin/ryl.js +1 -0
  15. package/clippy.toml +1 -0
  16. package/docs/config-presets.md +100 -0
  17. package/img/benchmark-5x5-5runs.svg +2176 -0
  18. package/package.json +28 -0
  19. package/pyproject.toml +42 -0
  20. package/ruff.toml +107 -0
  21. package/rumdl.toml +20 -0
  22. package/rust-toolchain.toml +3 -0
  23. package/rustfmt.toml +3 -0
  24. package/scripts/benchmark_perf_vs_yamllint.py +400 -0
  25. package/scripts/coverage-missing.ps1 +80 -0
  26. package/scripts/coverage-missing.sh +60 -0
  27. package/src/bin/discover_config_bin.rs +24 -0
  28. package/src/cli_support.rs +33 -0
  29. package/src/conf/mod.rs +85 -0
  30. package/src/config.rs +2099 -0
  31. package/src/decoder.rs +326 -0
  32. package/src/discover.rs +31 -0
  33. package/src/lib.rs +19 -0
  34. package/src/lint.rs +558 -0
  35. package/src/main.rs +535 -0
  36. package/src/migrate.rs +233 -0
  37. package/src/rules/anchors.rs +517 -0
  38. package/src/rules/braces.rs +77 -0
  39. package/src/rules/brackets.rs +77 -0
  40. package/src/rules/colons.rs +475 -0
  41. package/src/rules/commas.rs +372 -0
  42. package/src/rules/comments.rs +299 -0
  43. package/src/rules/comments_indentation.rs +243 -0
  44. package/src/rules/document_end.rs +175 -0
  45. package/src/rules/document_start.rs +84 -0
  46. package/src/rules/empty_lines.rs +152 -0
  47. package/src/rules/empty_values.rs +255 -0
  48. package/src/rules/float_values.rs +259 -0
  49. package/src/rules/flow_collection.rs +562 -0
  50. package/src/rules/hyphens.rs +104 -0
  51. package/src/rules/indentation.rs +803 -0
  52. package/src/rules/key_duplicates.rs +218 -0
  53. package/src/rules/key_ordering.rs +303 -0
  54. package/src/rules/line_length.rs +326 -0
  55. package/src/rules/mod.rs +25 -0
  56. package/src/rules/new_line_at_end_of_file.rs +23 -0
  57. package/src/rules/new_lines.rs +95 -0
  58. package/src/rules/octal_values.rs +121 -0
  59. package/src/rules/quoted_strings.rs +577 -0
  60. package/src/rules/span_utils.rs +37 -0
  61. package/src/rules/trailing_spaces.rs +65 -0
  62. package/src/rules/truthy.rs +420 -0
  63. package/tests/brackets_carriage_return.rs +114 -0
  64. package/tests/build_global_cfg_error.rs +23 -0
  65. package/tests/cli_anchors_rule.rs +143 -0
  66. package/tests/cli_braces_rule.rs +104 -0
  67. package/tests/cli_brackets_rule.rs +104 -0
  68. package/tests/cli_colons_rule.rs +65 -0
  69. package/tests/cli_commas_rule.rs +104 -0
  70. package/tests/cli_comments_indentation_rule.rs +61 -0
  71. package/tests/cli_comments_rule.rs +67 -0
  72. package/tests/cli_config_data_error.rs +30 -0
  73. package/tests/cli_config_flags.rs +66 -0
  74. package/tests/cli_config_migrate.rs +229 -0
  75. package/tests/cli_document_end_rule.rs +92 -0
  76. package/tests/cli_document_start_rule.rs +92 -0
  77. package/tests/cli_empty_lines_rule.rs +87 -0
  78. package/tests/cli_empty_values_rule.rs +68 -0
  79. package/tests/cli_env_config.rs +34 -0
  80. package/tests/cli_exit_and_errors.rs +41 -0
  81. package/tests/cli_file_encoding.rs +203 -0
  82. package/tests/cli_float_values_rule.rs +64 -0
  83. package/tests/cli_format_options.rs +316 -0
  84. package/tests/cli_global_cfg_relaxed.rs +20 -0
  85. package/tests/cli_hyphens_rule.rs +104 -0
  86. package/tests/cli_indentation_rule.rs +65 -0
  87. package/tests/cli_invalid_project_config.rs +39 -0
  88. package/tests/cli_key_duplicates_rule.rs +104 -0
  89. package/tests/cli_key_ordering_rule.rs +59 -0
  90. package/tests/cli_line_length_rule.rs +85 -0
  91. package/tests/cli_list_files.rs +29 -0
  92. package/tests/cli_new_line_rule.rs +141 -0
  93. package/tests/cli_new_lines_rule.rs +119 -0
  94. package/tests/cli_octal_values_rule.rs +60 -0
  95. package/tests/cli_quoted_strings_rule.rs +47 -0
  96. package/tests/cli_toml_config.rs +119 -0
  97. package/tests/cli_trailing_spaces_rule.rs +77 -0
  98. package/tests/cli_truthy_rule.rs +83 -0
  99. package/tests/cli_yaml_files_negation.rs +45 -0
  100. package/tests/colons_rule.rs +303 -0
  101. package/tests/common/compat.rs +114 -0
  102. package/tests/common/fake_env.rs +93 -0
  103. package/tests/common/mod.rs +1 -0
  104. package/tests/conf_builtin.rs +9 -0
  105. package/tests/config_anchors.rs +84 -0
  106. package/tests/config_braces.rs +121 -0
  107. package/tests/config_brackets.rs +127 -0
  108. package/tests/config_commas.rs +79 -0
  109. package/tests/config_comments.rs +65 -0
  110. package/tests/config_comments_indentation.rs +20 -0
  111. package/tests/config_deep_merge_nonstring_key.rs +24 -0
  112. package/tests/config_document_end.rs +54 -0
  113. package/tests/config_document_start.rs +55 -0
  114. package/tests/config_empty_lines.rs +48 -0
  115. package/tests/config_empty_values.rs +35 -0
  116. package/tests/config_env_errors.rs +23 -0
  117. package/tests/config_env_invalid_inline.rs +15 -0
  118. package/tests/config_env_missing.rs +63 -0
  119. package/tests/config_env_shim.rs +301 -0
  120. package/tests/config_explicit_file_parse_error.rs +55 -0
  121. package/tests/config_extended_features.rs +225 -0
  122. package/tests/config_extends_inline.rs +185 -0
  123. package/tests/config_extends_sequence.rs +18 -0
  124. package/tests/config_find_project_home_boundary.rs +54 -0
  125. package/tests/config_find_project_two_files_in_cwd.rs +47 -0
  126. package/tests/config_float_values.rs +34 -0
  127. package/tests/config_from_yaml_paths.rs +32 -0
  128. package/tests/config_hyphens.rs +51 -0
  129. package/tests/config_ignore_errors.rs +243 -0
  130. package/tests/config_ignore_overrides.rs +83 -0
  131. package/tests/config_indentation.rs +65 -0
  132. package/tests/config_invalid_globs.rs +16 -0
  133. package/tests/config_invalid_types.rs +19 -0
  134. package/tests/config_key_duplicates.rs +34 -0
  135. package/tests/config_key_ordering.rs +70 -0
  136. package/tests/config_line_length.rs +65 -0
  137. package/tests/config_locale.rs +111 -0
  138. package/tests/config_merge.rs +26 -0
  139. package/tests/config_new_lines.rs +89 -0
  140. package/tests/config_octal_values.rs +33 -0
  141. package/tests/config_quoted_strings.rs +195 -0
  142. package/tests/config_rule_level.rs +147 -0
  143. package/tests/config_rules_non_string_keys.rs +23 -0
  144. package/tests/config_scalar_overrides.rs +27 -0
  145. package/tests/config_to_toml.rs +110 -0
  146. package/tests/config_toml_coverage.rs +80 -0
  147. package/tests/config_toml_discovery.rs +304 -0
  148. package/tests/config_trailing_spaces.rs +152 -0
  149. package/tests/config_truthy.rs +77 -0
  150. package/tests/config_yaml_files.rs +62 -0
  151. package/tests/config_yaml_files_all_non_string.rs +15 -0
  152. package/tests/config_yaml_files_empty.rs +30 -0
  153. package/tests/coverage_commas.rs +46 -0
  154. package/tests/decoder_decode.rs +338 -0
  155. package/tests/discover_config_bin_all.rs +66 -0
  156. package/tests/discover_config_bin_env_invalid_yaml.rs +26 -0
  157. package/tests/discover_config_bin_project_config_parse_error.rs +24 -0
  158. package/tests/discover_config_bin_user_global_error.rs +26 -0
  159. package/tests/discover_module.rs +30 -0
  160. package/tests/discover_per_file_dir.rs +10 -0
  161. package/tests/discover_per_file_project_config_error.rs +21 -0
  162. package/tests/float_values.rs +43 -0
  163. package/tests/lint_multi_errors.rs +32 -0
  164. package/tests/main_yaml_ok_filtering.rs +30 -0
  165. package/tests/migrate_module.rs +259 -0
  166. package/tests/resolve_ctx_empty_parent.rs +16 -0
  167. package/tests/rule_anchors.rs +442 -0
  168. package/tests/rule_braces.rs +258 -0
  169. package/tests/rule_brackets.rs +217 -0
  170. package/tests/rule_commas.rs +205 -0
  171. package/tests/rule_comments.rs +197 -0
  172. package/tests/rule_comments_indentation.rs +127 -0
  173. package/tests/rule_document_end.rs +118 -0
  174. package/tests/rule_document_start.rs +60 -0
  175. package/tests/rule_empty_lines.rs +96 -0
  176. package/tests/rule_empty_values.rs +102 -0
  177. package/tests/rule_float_values.rs +109 -0
  178. package/tests/rule_hyphens.rs +65 -0
  179. package/tests/rule_indentation.rs +455 -0
  180. package/tests/rule_key_duplicates.rs +76 -0
  181. package/tests/rule_key_ordering.rs +207 -0
  182. package/tests/rule_line_length.rs +200 -0
  183. package/tests/rule_new_lines.rs +51 -0
  184. package/tests/rule_octal_values.rs +53 -0
  185. package/tests/rule_quoted_strings.rs +290 -0
  186. package/tests/rule_trailing_spaces.rs +41 -0
  187. package/tests/rule_truthy.rs +236 -0
  188. package/tests/user_global_invalid_yaml.rs +32 -0
  189. package/tests/yamllint_compat_anchors.rs +280 -0
  190. package/tests/yamllint_compat_braces.rs +411 -0
  191. package/tests/yamllint_compat_brackets.rs +364 -0
  192. package/tests/yamllint_compat_colons.rs +298 -0
  193. package/tests/yamllint_compat_colors.rs +80 -0
  194. package/tests/yamllint_compat_commas.rs +375 -0
  195. package/tests/yamllint_compat_comments.rs +167 -0
  196. package/tests/yamllint_compat_comments_indentation.rs +281 -0
  197. package/tests/yamllint_compat_config.rs +170 -0
  198. package/tests/yamllint_compat_document_end.rs +243 -0
  199. package/tests/yamllint_compat_document_start.rs +136 -0
  200. package/tests/yamllint_compat_empty_lines.rs +117 -0
  201. package/tests/yamllint_compat_empty_values.rs +179 -0
  202. package/tests/yamllint_compat_float_values.rs +216 -0
  203. package/tests/yamllint_compat_hyphens.rs +223 -0
  204. package/tests/yamllint_compat_indentation.rs +398 -0
  205. package/tests/yamllint_compat_key_duplicates.rs +139 -0
  206. package/tests/yamllint_compat_key_ordering.rs +170 -0
  207. package/tests/yamllint_compat_line_length.rs +375 -0
  208. package/tests/yamllint_compat_list.rs +127 -0
  209. package/tests/yamllint_compat_new_line.rs +133 -0
  210. package/tests/yamllint_compat_newline_types.rs +185 -0
  211. package/tests/yamllint_compat_octal_values.rs +172 -0
  212. package/tests/yamllint_compat_quoted_strings.rs +154 -0
  213. package/tests/yamllint_compat_syntax.rs +200 -0
  214. package/tests/yamllint_compat_trailing_spaces.rs +162 -0
  215. package/tests/yamllint_compat_truthy.rs +130 -0
  216. package/tests/yamllint_compat_yaml_files.rs +81 -0
  217. package/typos.toml +2 -0
@@ -0,0 +1,229 @@
1
+ use std::fs;
2
+ use std::process::Command;
3
+
4
+ use tempfile::tempdir;
5
+
6
+ fn run(cmd: &mut Command) -> (i32, String, String) {
7
+ let out = cmd.output().expect("failed to run ryl");
8
+ let code = out.status.code().unwrap_or(-1);
9
+ let stdout = String::from_utf8_lossy(&out.stdout).into_owned();
10
+ let stderr = String::from_utf8_lossy(&out.stderr).into_owned();
11
+ (code, stdout, stderr)
12
+ }
13
+
14
+ #[test]
15
+ fn migrate_configs_dry_run_does_not_write_files() {
16
+ let td = tempdir().unwrap();
17
+ let root = td.path();
18
+ fs::write(
19
+ root.join(".yamllint"),
20
+ "rules: { document-start: disable }\n",
21
+ )
22
+ .unwrap();
23
+
24
+ let exe = env!("CARGO_BIN_EXE_ryl");
25
+ let (code, stdout, stderr) = run(Command::new(exe)
26
+ .arg("--migrate-configs")
27
+ .arg("--migrate-root")
28
+ .arg(root));
29
+ assert_eq!(code, 0, "stdout={stdout} stderr={stderr}");
30
+ assert!(stdout.contains(".yamllint ->"));
31
+ assert!(!root.join(".ryl.toml").exists());
32
+ }
33
+
34
+ #[test]
35
+ fn migrate_configs_write_with_rename_flattens_extends() {
36
+ let td = tempdir().unwrap();
37
+ let root = td.path();
38
+ fs::write(
39
+ root.join("base.yaml"),
40
+ "rules: { truthy: { level: error } }\n",
41
+ )
42
+ .unwrap();
43
+ fs::write(
44
+ root.join(".yamllint"),
45
+ "extends: base.yaml\nrules: { document-start: disable }\n",
46
+ )
47
+ .unwrap();
48
+
49
+ let exe = env!("CARGO_BIN_EXE_ryl");
50
+ let (code, stdout, stderr) = run(Command::new(exe)
51
+ .arg("--migrate-configs")
52
+ .arg("--migrate-root")
53
+ .arg(root)
54
+ .arg("--migrate-write")
55
+ .arg("--migrate-rename-old")
56
+ .arg(".bak"));
57
+ assert_eq!(code, 0, "stdout={stdout} stderr={stderr}");
58
+
59
+ let toml = fs::read_to_string(root.join(".ryl.toml")).unwrap();
60
+ assert!(toml.contains("document-start = \"disable\""));
61
+ assert!(toml.contains("[rules.truthy]"));
62
+ assert!(toml.contains("level = \"error\""));
63
+ assert!(!root.join(".yamllint").exists());
64
+ assert!(root.join(".yamllint.bak").exists());
65
+ }
66
+
67
+ #[test]
68
+ fn migrate_configs_warns_when_multiple_yaml_configs_share_directory() {
69
+ let td = tempdir().unwrap();
70
+ let root = td.path();
71
+ fs::write(root.join(".yamllint"), "rules: {}\n").unwrap();
72
+ fs::write(
73
+ root.join(".yamllint.yml"),
74
+ "rules: { document-start: disable }\n",
75
+ )
76
+ .unwrap();
77
+
78
+ let exe = env!("CARGO_BIN_EXE_ryl");
79
+ let (code, _stdout, stderr) = run(Command::new(exe)
80
+ .arg("--migrate-configs")
81
+ .arg("--migrate-root")
82
+ .arg(root));
83
+ assert_eq!(code, 0, "stderr={stderr}");
84
+ assert!(stderr.contains("warning: skipping lower-precedence config"));
85
+ }
86
+
87
+ #[test]
88
+ fn migrate_configs_write_with_delete_old_removes_skipped_lower_precedence_files() {
89
+ let td = tempdir().unwrap();
90
+ let root = td.path();
91
+ let primary = root.join(".yamllint");
92
+ let skipped = root.join(".yamllint.yml");
93
+ fs::write(&primary, "rules: {}\n").unwrap();
94
+ fs::write(&skipped, "rules: { document-start: disable }\n").unwrap();
95
+
96
+ let exe = env!("CARGO_BIN_EXE_ryl");
97
+ let (code, _stdout, stderr) = run(Command::new(exe)
98
+ .arg("--migrate-configs")
99
+ .arg("--migrate-root")
100
+ .arg(root)
101
+ .arg("--migrate-write")
102
+ .arg("--migrate-delete-old"));
103
+ assert_eq!(code, 0, "stderr={stderr}");
104
+ assert!(!primary.exists());
105
+ assert!(!skipped.exists());
106
+ }
107
+
108
+ #[test]
109
+ fn migrate_configs_write_with_rename_old_renames_skipped_lower_precedence_files() {
110
+ let td = tempdir().unwrap();
111
+ let root = td.path();
112
+ let primary = root.join(".yamllint");
113
+ let skipped = root.join(".yamllint.yml");
114
+ fs::write(&primary, "rules: {}\n").unwrap();
115
+ fs::write(&skipped, "rules: { document-start: disable }\n").unwrap();
116
+
117
+ let exe = env!("CARGO_BIN_EXE_ryl");
118
+ let (code, _stdout, stderr) = run(Command::new(exe)
119
+ .arg("--migrate-configs")
120
+ .arg("--migrate-root")
121
+ .arg(root)
122
+ .arg("--migrate-write")
123
+ .arg("--migrate-rename-old")
124
+ .arg(".bak"));
125
+ assert_eq!(code, 0, "stderr={stderr}");
126
+ assert!(!primary.exists());
127
+ assert!(!skipped.exists());
128
+ assert!(root.join(".yamllint.bak").exists());
129
+ assert!(root.join(".yamllint.yml.bak").exists());
130
+ }
131
+
132
+ #[test]
133
+ fn migrate_rename_and_delete_conflict() {
134
+ let td = tempdir().unwrap();
135
+ let exe = env!("CARGO_BIN_EXE_ryl");
136
+ let (code, _stdout, stderr) = run(Command::new(exe)
137
+ .arg("--migrate-configs")
138
+ .arg("--migrate-root")
139
+ .arg(td.path())
140
+ .arg("--migrate-write")
141
+ .arg("--migrate-rename-old")
142
+ .arg(".bak")
143
+ .arg("--migrate-delete-old"));
144
+ assert_eq!(code, 2, "stderr={stderr}");
145
+ assert!(stderr.contains("cannot be used with"));
146
+ }
147
+
148
+ #[test]
149
+ fn migrate_delete_old_requires_write() {
150
+ let td = tempdir().unwrap();
151
+ let exe = env!("CARGO_BIN_EXE_ryl");
152
+ let (code, _stdout, stderr) = run(Command::new(exe)
153
+ .arg("--migrate-configs")
154
+ .arg("--migrate-root")
155
+ .arg(td.path())
156
+ .arg("--migrate-delete-old"));
157
+ assert_eq!(code, 2, "stderr={stderr}");
158
+ assert!(stderr.contains("required"));
159
+ }
160
+
161
+ #[test]
162
+ fn migrate_options_require_migrate_configs() {
163
+ let td = tempdir().unwrap();
164
+ let exe = env!("CARGO_BIN_EXE_ryl");
165
+ let (code, _stdout, stderr) = run(Command::new(exe)
166
+ .arg("--migrate-root")
167
+ .arg(td.path())
168
+ .arg(td.path()));
169
+ assert_eq!(code, 2, "stderr={stderr}");
170
+ assert!(stderr.contains("--migrate-configs"));
171
+ }
172
+
173
+ #[test]
174
+ fn migrate_configs_empty_default_root_prints_no_configs_message() {
175
+ let td = tempdir().unwrap();
176
+ let exe = env!("CARGO_BIN_EXE_ryl");
177
+ let (code, stdout, stderr) = run(Command::new(exe)
178
+ .current_dir(td.path())
179
+ .arg("--migrate-configs"));
180
+ assert_eq!(code, 0, "stdout={stdout} stderr={stderr}");
181
+ assert!(stdout.contains("No legacy YAML config files found under"));
182
+ }
183
+
184
+ #[test]
185
+ fn migrate_configs_stdout_prints_generated_toml() {
186
+ let td = tempdir().unwrap();
187
+ fs::write(
188
+ td.path().join(".yamllint"),
189
+ "rules: { document-start: disable }\n",
190
+ )
191
+ .unwrap();
192
+ let exe = env!("CARGO_BIN_EXE_ryl");
193
+ let (code, stdout, stderr) = run(Command::new(exe)
194
+ .arg("--migrate-configs")
195
+ .arg("--migrate-root")
196
+ .arg(td.path())
197
+ .arg("--migrate-stdout"));
198
+ assert_eq!(code, 0, "stdout={stdout} stderr={stderr}");
199
+ assert!(stdout.contains("# "));
200
+ assert!(stdout.contains("[rules]"));
201
+ }
202
+
203
+ #[test]
204
+ fn migrate_configs_write_with_delete_old_removes_source() {
205
+ let td = tempdir().unwrap();
206
+ let source = td.path().join(".yamllint");
207
+ fs::write(&source, "rules: { document-start: disable }\n").unwrap();
208
+ let exe = env!("CARGO_BIN_EXE_ryl");
209
+ let (code, _stdout, stderr) = run(Command::new(exe)
210
+ .arg("--migrate-configs")
211
+ .arg("--migrate-root")
212
+ .arg(td.path())
213
+ .arg("--migrate-write")
214
+ .arg("--migrate-delete-old"));
215
+ assert_eq!(code, 0, "stderr={stderr}");
216
+ assert!(!source.exists());
217
+ assert!(td.path().join(".ryl.toml").exists());
218
+ }
219
+
220
+ #[test]
221
+ fn migrate_configs_missing_root_returns_usage_error() {
222
+ let exe = env!("CARGO_BIN_EXE_ryl");
223
+ let (code, _stdout, stderr) = run(Command::new(exe)
224
+ .arg("--migrate-configs")
225
+ .arg("--migrate-root")
226
+ .arg("/definitely/no/such/ryl/path"));
227
+ assert_eq!(code, 2, "stderr={stderr}");
228
+ assert!(stderr.contains("migrate root does not exist"));
229
+ }
@@ -0,0 +1,92 @@
1
+ use std::fs;
2
+ use std::process::Command;
3
+
4
+ use tempfile::tempdir;
5
+
6
+ fn run(cmd: &mut Command) -> (i32, String, String) {
7
+ let out = cmd.output().expect("process");
8
+ let code = out.status.code().unwrap_or(-1);
9
+ let stdout = String::from_utf8_lossy(&out.stdout).into_owned();
10
+ let stderr = String::from_utf8_lossy(&out.stderr).into_owned();
11
+ (code, stdout, stderr)
12
+ }
13
+
14
+ #[test]
15
+ fn missing_marker_reports_error() {
16
+ let dir = tempdir().unwrap();
17
+ let file = dir.path().join("missing.yaml");
18
+ fs::write(&file, "---\nname: value\n").unwrap();
19
+
20
+ let config = dir.path().join("config.yml");
21
+ fs::write(
22
+ &config,
23
+ "rules:\n document-end:\n level: error\n present: true\n",
24
+ )
25
+ .unwrap();
26
+
27
+ let exe = env!("CARGO_BIN_EXE_ryl");
28
+ let (code, stdout, stderr) =
29
+ run(Command::new(exe).arg("-c").arg(&config).arg(&file));
30
+ assert_eq!(code, 1, "expected error: stdout={stdout} stderr={stderr}");
31
+ let output = if stderr.is_empty() { stdout } else { stderr };
32
+ assert!(
33
+ output.contains("missing document end \"...\""),
34
+ "missing message: {output}"
35
+ );
36
+ assert!(
37
+ output.contains("document-end"),
38
+ "rule id missing from output: {output}"
39
+ );
40
+ }
41
+
42
+ #[test]
43
+ fn forbidding_marker_flags_explicit_document() {
44
+ let dir = tempdir().unwrap();
45
+ let file = dir.path().join("explicit.yaml");
46
+ fs::write(&file, "---\nname: value\n...\n").unwrap();
47
+
48
+ let config = dir.path().join("config.yml");
49
+ fs::write(
50
+ &config,
51
+ "rules:\n document-end:\n level: error\n present: false\n",
52
+ )
53
+ .unwrap();
54
+
55
+ let exe = env!("CARGO_BIN_EXE_ryl");
56
+ let (code, stdout, stderr) =
57
+ run(Command::new(exe).arg("-c").arg(&config).arg(&file));
58
+ assert_eq!(code, 1, "expected error: stdout={stdout} stderr={stderr}");
59
+ let output = if stderr.is_empty() { stdout } else { stderr };
60
+ assert!(
61
+ output.contains("found forbidden document end \"...\""),
62
+ "missing forbidden message: {output}"
63
+ );
64
+ assert!(
65
+ output.contains("document-end"),
66
+ "rule id missing from output: {output}"
67
+ );
68
+ }
69
+
70
+ #[test]
71
+ fn forbidding_marker_allows_implicit_document() {
72
+ let dir = tempdir().unwrap();
73
+ let file = dir.path().join("implicit.yaml");
74
+ fs::write(&file, "---\nname: value\n").unwrap();
75
+
76
+ let config = dir.path().join("config.yml");
77
+ fs::write(
78
+ &config,
79
+ "rules:\n document-end:\n level: error\n present: false\n",
80
+ )
81
+ .unwrap();
82
+
83
+ let exe = env!("CARGO_BIN_EXE_ryl");
84
+ let (code, stdout, stderr) =
85
+ run(Command::new(exe).arg("-c").arg(&config).arg(&file));
86
+ assert_eq!(
87
+ code, 0,
88
+ "implicit end should pass: stdout={stdout} stderr={stderr}"
89
+ );
90
+ assert!(stdout.trim().is_empty(), "expected no stdout: {stdout}");
91
+ assert!(stderr.trim().is_empty(), "expected no stderr: {stderr}");
92
+ }
@@ -0,0 +1,92 @@
1
+ use std::fs;
2
+ use std::process::Command;
3
+
4
+ use tempfile::tempdir;
5
+
6
+ fn run(cmd: &mut Command) -> (i32, String, String) {
7
+ let out = cmd.output().expect("process");
8
+ let code = out.status.code().unwrap_or(-1);
9
+ let stdout = String::from_utf8_lossy(&out.stdout).into_owned();
10
+ let stderr = String::from_utf8_lossy(&out.stderr).into_owned();
11
+ (code, stdout, stderr)
12
+ }
13
+
14
+ #[test]
15
+ fn missing_marker_reports_error() {
16
+ let dir = tempdir().unwrap();
17
+ let file = dir.path().join("missing.yaml");
18
+ fs::write(&file, "name: value\n").unwrap();
19
+
20
+ let config = dir.path().join("config.yml");
21
+ fs::write(
22
+ &config,
23
+ "rules:\n document-start:\n level: error\n present: true\n",
24
+ )
25
+ .unwrap();
26
+
27
+ let exe = env!("CARGO_BIN_EXE_ryl");
28
+ let (code, stdout, stderr) =
29
+ run(Command::new(exe).arg("-c").arg(&config).arg(&file));
30
+ assert_eq!(code, 1, "expected error: stdout={stdout} stderr={stderr}");
31
+ let output = if stderr.is_empty() { stdout } else { stderr };
32
+ assert!(
33
+ output.contains("missing document start \"---\""),
34
+ "missing message: {output}"
35
+ );
36
+ assert!(
37
+ output.contains("document-start"),
38
+ "rule id missing from output: {output}"
39
+ );
40
+ }
41
+
42
+ #[test]
43
+ fn forbidding_marker_flags_explicit_document() {
44
+ let dir = tempdir().unwrap();
45
+ let file = dir.path().join("explicit.yaml");
46
+ fs::write(&file, "---\nname: value\n").unwrap();
47
+
48
+ let config = dir.path().join("config.yml");
49
+ fs::write(
50
+ &config,
51
+ "rules:\n document-start:\n level: error\n present: false\n",
52
+ )
53
+ .unwrap();
54
+
55
+ let exe = env!("CARGO_BIN_EXE_ryl");
56
+ let (code, stdout, stderr) =
57
+ run(Command::new(exe).arg("-c").arg(&config).arg(&file));
58
+ assert_eq!(code, 1, "expected error: stdout={stdout} stderr={stderr}");
59
+ let output = if stderr.is_empty() { stdout } else { stderr };
60
+ assert!(
61
+ output.contains("found forbidden document start \"---\""),
62
+ "missing forbidden message: {output}"
63
+ );
64
+ assert!(
65
+ output.contains("document-start"),
66
+ "rule id missing from output: {output}"
67
+ );
68
+ }
69
+
70
+ #[test]
71
+ fn forbidding_marker_allows_implicit_document() {
72
+ let dir = tempdir().unwrap();
73
+ let file = dir.path().join("implicit.yaml");
74
+ fs::write(&file, "name: value\n").unwrap();
75
+
76
+ let config = dir.path().join("config.yml");
77
+ fs::write(
78
+ &config,
79
+ "rules:\n document-start:\n level: error\n present: false\n",
80
+ )
81
+ .unwrap();
82
+
83
+ let exe = env!("CARGO_BIN_EXE_ryl");
84
+ let (code, stdout, stderr) =
85
+ run(Command::new(exe).arg("-c").arg(&config).arg(&file));
86
+ assert_eq!(
87
+ code, 0,
88
+ "implicit start should pass: stdout={stdout} stderr={stderr}"
89
+ );
90
+ assert!(stdout.trim().is_empty(), "expected no stdout: {stdout}");
91
+ assert!(stderr.trim().is_empty(), "expected no stderr: {stderr}");
92
+ }
@@ -0,0 +1,87 @@
1
+ use std::fs;
2
+ use std::process::Command;
3
+
4
+ use tempfile::tempdir;
5
+
6
+ fn run(cmd: &mut Command) -> (i32, String, String) {
7
+ let out = cmd.output().expect("process");
8
+ let code = out.status.code().unwrap_or(-1);
9
+ let stdout = String::from_utf8_lossy(&out.stdout).into_owned();
10
+ let stderr = String::from_utf8_lossy(&out.stderr).into_owned();
11
+ (code, stdout, stderr)
12
+ }
13
+
14
+ fn command_output<'a>(stdout: &'a str, stderr: &'a str) -> &'a str {
15
+ if stderr.is_empty() { stdout } else { stderr }
16
+ }
17
+
18
+ #[test]
19
+ fn reports_interior_blank_run() {
20
+ let dir = tempdir().unwrap();
21
+ let file = dir.path().join("interior.yaml");
22
+ fs::write(&file, "key: value\n\n\n\nnext: value\n").unwrap();
23
+ let config = dir.path().join("config.yml");
24
+ fs::write(
25
+ &config,
26
+ "rules:\n document-start: disable\n new-line-at-end-of-file: disable\n empty-lines:\n max: 2\n",
27
+ )
28
+ .unwrap();
29
+
30
+ let exe = env!("CARGO_BIN_EXE_ryl");
31
+ let (code, stdout, stderr) =
32
+ run(Command::new(exe).arg("-c").arg(&config).arg(&file));
33
+ assert_eq!(code, 1, "expected failure: stdout={stdout} stderr={stderr}");
34
+ let output = command_output(&stdout, &stderr);
35
+ assert!(
36
+ output.contains("too many blank lines (3 > 2)"),
37
+ "missing message: {output}"
38
+ );
39
+ assert!(output.contains("empty-lines"), "rule id missing: {output}");
40
+ assert!(output.contains("4:1"), "incorrect location: {output}");
41
+ }
42
+
43
+ #[test]
44
+ fn enforces_start_and_end_limits() {
45
+ let dir = tempdir().unwrap();
46
+
47
+ let start_file = dir.path().join("start.yaml");
48
+ fs::write(&start_file, "\n\nkey: value\n").unwrap();
49
+ let start_config = dir.path().join("start-config.yml");
50
+ fs::write(
51
+ &start_config,
52
+ "rules:\n document-start: disable\n new-line-at-end-of-file: disable\n empty-lines:\n max: 5\n max-start: 1\n",
53
+ )
54
+ .unwrap();
55
+
56
+ let exe = env!("CARGO_BIN_EXE_ryl");
57
+ let (code, stdout, stderr) = run(Command::new(exe)
58
+ .arg("-c")
59
+ .arg(&start_config)
60
+ .arg(&start_file));
61
+ assert_eq!(code, 1, "expected failure: stdout={stdout} stderr={stderr}");
62
+ let output = command_output(&stdout, &stderr);
63
+ assert!(
64
+ output.contains("too many blank lines (2 > 1)"),
65
+ "missing start message: {output}"
66
+ );
67
+ assert!(output.contains("2:1"), "incorrect start location: {output}");
68
+
69
+ let end_file = dir.path().join("end.yaml");
70
+ fs::write(&end_file, "key: value\n\n\n").unwrap();
71
+ let end_config = dir.path().join("end-config.yml");
72
+ fs::write(
73
+ &end_config,
74
+ "rules:\n document-start: disable\n new-line-at-end-of-file: disable\n empty-lines:\n max: 5\n max-end: 1\n",
75
+ )
76
+ .unwrap();
77
+
78
+ let (code, stdout, stderr) =
79
+ run(Command::new(exe).arg("-c").arg(&end_config).arg(&end_file));
80
+ assert_eq!(code, 1, "expected failure: stdout={stdout} stderr={stderr}");
81
+ let output = command_output(&stdout, &stderr);
82
+ assert!(
83
+ output.contains("too many blank lines (2 > 1)"),
84
+ "missing end message: {output}"
85
+ );
86
+ assert!(output.contains("3:1"), "incorrect end location: {output}");
87
+ }
@@ -0,0 +1,68 @@
1
+ use std::fs;
2
+ use std::process::Command;
3
+
4
+ use tempfile::tempdir;
5
+
6
+ fn run(cmd: &mut Command) -> (i32, String, String) {
7
+ let out = cmd.output().expect("process");
8
+ let code = out.status.code().unwrap_or(-1);
9
+ let stdout = String::from_utf8_lossy(&out.stdout).into_owned();
10
+ let stderr = String::from_utf8_lossy(&out.stderr).into_owned();
11
+ (code, stdout, stderr)
12
+ }
13
+
14
+ #[test]
15
+ fn empty_values_reports_all_diagnostics() {
16
+ let dir = tempdir().unwrap();
17
+ let file = dir.path().join("invalid.yaml");
18
+ fs::write(&file, "block:\n missing:\nflow: { missing: }\nseq:\n -\n").unwrap();
19
+
20
+ let config = dir.path().join("config.yml");
21
+ fs::write(
22
+ &config,
23
+ "rules:\n document-start: disable\n empty-values: enable\n",
24
+ )
25
+ .unwrap();
26
+
27
+ let exe = env!("CARGO_BIN_EXE_ryl");
28
+ let (code, stdout, stderr) =
29
+ run(Command::new(exe).arg("-c").arg(&config).arg(&file));
30
+ assert_eq!(code, 1, "expected failure: stdout={stdout} stderr={stderr}");
31
+ let output = if stderr.is_empty() { &stdout } else { &stderr };
32
+ assert!(
33
+ output.contains("empty value in block mapping"),
34
+ "missing block mapping message: {output}"
35
+ );
36
+ assert!(
37
+ output.contains("empty value in flow mapping"),
38
+ "missing flow mapping message: {output}"
39
+ );
40
+ assert!(
41
+ output.contains("empty value in block sequence"),
42
+ "missing block sequence message: {output}"
43
+ );
44
+ }
45
+
46
+ #[test]
47
+ fn empty_values_honors_flags() {
48
+ let dir = tempdir().unwrap();
49
+ let file = dir.path().join("ok.yaml");
50
+ fs::write(&file, "block:\n missing:\nflow: { missing: }\nseq:\n -\n").unwrap();
51
+
52
+ let config = dir.path().join("config.yml");
53
+ fs::write(
54
+ &config,
55
+ "rules:\n document-start: disable\n empty-values:\n forbid-in-block-mappings: false\n forbid-in-flow-mappings: false\n forbid-in-block-sequences: false\n",
56
+ )
57
+ .unwrap();
58
+
59
+ let exe = env!("CARGO_BIN_EXE_ryl");
60
+ let (code, stdout, stderr) =
61
+ run(Command::new(exe).arg("-c").arg(&config).arg(&file));
62
+ assert_eq!(
63
+ code, 0,
64
+ "expected success when all checks disabled: stdout={stdout} stderr={stderr}"
65
+ );
66
+ assert!(stdout.trim().is_empty(), "expected no stdout: {stdout}");
67
+ assert!(stderr.trim().is_empty(), "expected no stderr: {stderr}");
68
+ }
@@ -0,0 +1,34 @@
1
+ use std::fs;
2
+ use std::process::Command;
3
+
4
+ use tempfile::tempdir;
5
+
6
+ fn run(cmd: &mut Command) -> (i32, String, String) {
7
+ let out = cmd.output().expect("process");
8
+ let code = out.status.code().unwrap_or(-1);
9
+ let stdout = String::from_utf8_lossy(&out.stdout).into_owned();
10
+ let stderr = String::from_utf8_lossy(&out.stderr).into_owned();
11
+ (code, stdout, stderr)
12
+ }
13
+
14
+ #[test]
15
+ fn env_config_file_is_honored() {
16
+ let dir = tempdir().unwrap();
17
+ let cfg = dir.path().join("env-config.yml");
18
+ fs::write(
19
+ &cfg,
20
+ "rules:\n new-line-at-end-of-file: disable\n document-start: disable\n",
21
+ )
22
+ .unwrap();
23
+ let file = dir.path().join("no_newline.yaml");
24
+ fs::write(&file, "key: value").unwrap();
25
+
26
+ let exe = env!("CARGO_BIN_EXE_ryl");
27
+ let (code, stdout, stderr) = run(Command::new(exe)
28
+ .env("YAMLLINT_CONFIG_FILE", cfg.display().to_string())
29
+ .arg(&file));
30
+ assert_eq!(
31
+ code, 0,
32
+ "env-config should disable rule: stdout={stdout} stderr={stderr}"
33
+ );
34
+ }
@@ -0,0 +1,41 @@
1
+ use std::process::Command;
2
+ use tempfile::tempdir;
3
+
4
+ fn run(cmd: &mut Command) -> (i32, String, String) {
5
+ let out = cmd.output().expect("failed to run ryl");
6
+ let code = out.status.code().unwrap_or(-1);
7
+ let stdout = String::from_utf8_lossy(&out.stdout).into_owned();
8
+ let stderr = String::from_utf8_lossy(&out.stderr).into_owned();
9
+ (code, stdout, stderr)
10
+ }
11
+
12
+ #[test]
13
+ fn no_arguments_returns_usage_error_code_2() {
14
+ let exe = env!("CARGO_BIN_EXE_ryl");
15
+ let (code, _out, err) = run(&mut Command::new(exe));
16
+ assert_eq!(code, 2, "expected usage error exit code 2: {err}");
17
+ assert!(
18
+ err.contains("expected one or more paths"),
19
+ "expected usage message in stderr: {err}"
20
+ );
21
+ }
22
+
23
+ #[test]
24
+ fn empty_directory_results_in_success() {
25
+ let dir = tempdir().unwrap();
26
+ let exe = env!("CARGO_BIN_EXE_ryl");
27
+ let (code, _out, err) = run(Command::new(exe).arg(dir.path()));
28
+ assert_eq!(code, 0, "expected success when no YAML files: {err}");
29
+ }
30
+
31
+ #[test]
32
+ fn non_existent_file_reports_read_error() {
33
+ let exe = env!("CARGO_BIN_EXE_ryl");
34
+ let bogus = std::path::Path::new("this/file/does/not/exist.yaml");
35
+ let (code, _out, err) = run(Command::new(exe).arg(bogus));
36
+ assert_eq!(code, 1, "expected failure for unreadable file");
37
+ assert!(
38
+ err.contains("failed to read"),
39
+ "expected read error in stderr: {err}"
40
+ );
41
+ }