| 621 |
lars |
1 |
CHANGELOG
|
|
|
2 |
=========
|
|
|
3 |
|
|
|
4 |
6.2
|
|
|
5 |
---
|
|
|
6 |
|
|
|
7 |
* Add support for `!php/enum` and `!php/enum *->value`
|
|
|
8 |
* Deprecate the `!php/const:` tag in key which will be replaced by the `!php/const` tag (without the colon) since 3.4
|
|
|
9 |
|
|
|
10 |
6.1
|
|
|
11 |
---
|
|
|
12 |
|
|
|
13 |
* In cases where it will likely improve readability, strings containing single quotes will be double-quoted
|
|
|
14 |
|
|
|
15 |
5.4
|
|
|
16 |
---
|
|
|
17 |
|
|
|
18 |
* Add new `lint:yaml dirname --exclude=/dirname/foo.yaml --exclude=/dirname/bar.yaml`
|
|
|
19 |
option to exclude one or more specific files from multiple file list
|
|
|
20 |
* Allow negatable for the parse tags option with `--no-parse-tags`
|
|
|
21 |
|
|
|
22 |
5.3
|
|
|
23 |
---
|
|
|
24 |
|
|
|
25 |
* Added `github` format support & autodetection to render errors as annotations
|
|
|
26 |
when running the YAML linter command in a Github Action environment.
|
|
|
27 |
|
|
|
28 |
5.1.0
|
|
|
29 |
-----
|
|
|
30 |
|
|
|
31 |
* Added support for parsing numbers prefixed with `0o` as octal numbers.
|
|
|
32 |
* Deprecated support for parsing numbers starting with `0` as octal numbers. They will be parsed as strings as of Symfony 6.0. Prefix numbers with `0o`
|
|
|
33 |
so that they are parsed as octal numbers.
|
|
|
34 |
|
|
|
35 |
Before:
|
|
|
36 |
|
|
|
37 |
```yaml
|
|
|
38 |
Yaml::parse('072');
|
|
|
39 |
```
|
|
|
40 |
|
|
|
41 |
After:
|
|
|
42 |
|
|
|
43 |
```yaml
|
|
|
44 |
Yaml::parse('0o72');
|
|
|
45 |
```
|
|
|
46 |
|
|
|
47 |
* Added `yaml-lint` binary.
|
|
|
48 |
* Deprecated using the `!php/object` and `!php/const` tags without a value.
|
|
|
49 |
|
|
|
50 |
5.0.0
|
|
|
51 |
-----
|
|
|
52 |
|
|
|
53 |
* Removed support for mappings inside multi-line strings.
|
|
|
54 |
* removed support for implicit STDIN usage in the `lint:yaml` command, use `lint:yaml -` (append a dash) instead to make it explicit.
|
|
|
55 |
|
|
|
56 |
4.4.0
|
|
|
57 |
-----
|
|
|
58 |
|
|
|
59 |
* Added support for parsing the inline notation spanning multiple lines.
|
|
|
60 |
* Added support to dump `null` as `~` by using the `Yaml::DUMP_NULL_AS_TILDE` flag.
|
|
|
61 |
* deprecated accepting STDIN implicitly when using the `lint:yaml` command, use `lint:yaml -` (append a dash) instead to make it explicit.
|
|
|
62 |
|
|
|
63 |
4.3.0
|
|
|
64 |
-----
|
|
|
65 |
|
|
|
66 |
* Using a mapping inside a multi-line string is deprecated and will throw a `ParseException` in 5.0.
|
|
|
67 |
|
|
|
68 |
4.2.0
|
|
|
69 |
-----
|
|
|
70 |
|
|
|
71 |
* added support for multiple files or directories in `LintCommand`
|
|
|
72 |
|
|
|
73 |
4.0.0
|
|
|
74 |
-----
|
|
|
75 |
|
|
|
76 |
* The behavior of the non-specific tag `!` is changed and now forces
|
|
|
77 |
non-evaluating your values.
|
|
|
78 |
* complex mappings will throw a `ParseException`
|
|
|
79 |
* support for the comma as a group separator for floats has been dropped, use
|
|
|
80 |
the underscore instead
|
|
|
81 |
* support for the `!!php/object` tag has been dropped, use the `!php/object`
|
|
|
82 |
tag instead
|
|
|
83 |
* duplicate mapping keys throw a `ParseException`
|
|
|
84 |
* non-string mapping keys throw a `ParseException`, use the `Yaml::PARSE_KEYS_AS_STRINGS`
|
|
|
85 |
flag to cast them to strings
|
|
|
86 |
* `%` at the beginning of an unquoted string throw a `ParseException`
|
|
|
87 |
* mappings with a colon (`:`) that is not followed by a whitespace throw a
|
|
|
88 |
`ParseException`
|
|
|
89 |
* the `Dumper::setIndentation()` method has been removed
|
|
|
90 |
* being able to pass boolean options to the `Yaml::parse()`, `Yaml::dump()`,
|
|
|
91 |
`Parser::parse()`, and `Dumper::dump()` methods to configure the behavior of
|
|
|
92 |
the parser and dumper is no longer supported, pass bitmask flags instead
|
|
|
93 |
* the constructor arguments of the `Parser` class have been removed
|
|
|
94 |
* the `Inline` class is internal and no longer part of the BC promise
|
|
|
95 |
* removed support for the `!str` tag, use the `!!str` tag instead
|
|
|
96 |
* added support for tagged scalars.
|
|
|
97 |
|
|
|
98 |
```yml
|
|
|
99 |
Yaml::parse('!foo bar', Yaml::PARSE_CUSTOM_TAGS);
|
|
|
100 |
// returns TaggedValue('foo', 'bar');
|
|
|
101 |
```
|
|
|
102 |
|
|
|
103 |
3.4.0
|
|
|
104 |
-----
|
|
|
105 |
|
|
|
106 |
* added support for parsing YAML files using the `Yaml::parseFile()` or `Parser::parseFile()` method
|
|
|
107 |
|
|
|
108 |
* the `Dumper`, `Parser`, and `Yaml` classes are marked as final
|
|
|
109 |
|
|
|
110 |
* Deprecated the `!php/object:` tag which will be replaced by the
|
|
|
111 |
`!php/object` tag (without the colon) in 4.0.
|
|
|
112 |
|
|
|
113 |
* Deprecated the `!php/const:` tag which will be replaced by the
|
|
|
114 |
`!php/const` tag (without the colon) in 4.0.
|
|
|
115 |
|
|
|
116 |
* Support for the `!str` tag is deprecated, use the `!!str` tag instead.
|
|
|
117 |
|
|
|
118 |
* Deprecated using the non-specific tag `!` as its behavior will change in 4.0.
|
|
|
119 |
It will force non-evaluating your values in 4.0. Use plain integers or `!!float` instead.
|
|
|
120 |
|
|
|
121 |
3.3.0
|
|
|
122 |
-----
|
|
|
123 |
|
|
|
124 |
* Starting an unquoted string with a question mark followed by a space is
|
|
|
125 |
deprecated and will throw a `ParseException` in Symfony 4.0.
|
|
|
126 |
|
|
|
127 |
* Deprecated support for implicitly parsing non-string mapping keys as strings.
|
|
|
128 |
Mapping keys that are no strings will lead to a `ParseException` in Symfony
|
|
|
129 |
4.0. Use quotes to opt-in for keys to be parsed as strings.
|
|
|
130 |
|
|
|
131 |
Before:
|
|
|
132 |
|
|
|
133 |
```php
|
|
|
134 |
$yaml = <<<YAML
|
|
|
135 |
null: null key
|
|
|
136 |
true: boolean true
|
|
|
137 |
2.0: float key
|
|
|
138 |
YAML;
|
|
|
139 |
|
|
|
140 |
Yaml::parse($yaml);
|
|
|
141 |
```
|
|
|
142 |
|
|
|
143 |
After:
|
|
|
144 |
|
|
|
145 |
```php
|
|
|
146 |
|
|
|
147 |
$yaml = <<<YAML
|
|
|
148 |
"null": null key
|
|
|
149 |
"true": boolean true
|
|
|
150 |
"2.0": float key
|
|
|
151 |
YAML;
|
|
|
152 |
|
|
|
153 |
Yaml::parse($yaml);
|
|
|
154 |
```
|
|
|
155 |
|
|
|
156 |
* Omitted mapping values will be parsed as `null`.
|
|
|
157 |
|
|
|
158 |
* Omitting the key of a mapping is deprecated and will throw a `ParseException` in Symfony 4.0.
|
|
|
159 |
|
|
|
160 |
* Added support for dumping empty PHP arrays as YAML sequences:
|
|
|
161 |
|
|
|
162 |
```php
|
|
|
163 |
Yaml::dump([], 0, 0, Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE);
|
|
|
164 |
```
|
|
|
165 |
|
|
|
166 |
3.2.0
|
|
|
167 |
-----
|
|
|
168 |
|
|
|
169 |
* Mappings with a colon (`:`) that is not followed by a whitespace are deprecated
|
|
|
170 |
when the mapping key is not quoted and will lead to a `ParseException` in
|
|
|
171 |
Symfony 4.0 (e.g. `foo:bar` must be `foo: bar`).
|
|
|
172 |
|
|
|
173 |
* Added support for parsing PHP constants:
|
|
|
174 |
|
|
|
175 |
```php
|
|
|
176 |
Yaml::parse('!php/const:PHP_INT_MAX', Yaml::PARSE_CONSTANT);
|
|
|
177 |
```
|
|
|
178 |
|
|
|
179 |
* Support for silently ignoring duplicate mapping keys in YAML has been
|
|
|
180 |
deprecated and will lead to a `ParseException` in Symfony 4.0.
|
|
|
181 |
|
|
|
182 |
3.1.0
|
|
|
183 |
-----
|
|
|
184 |
|
|
|
185 |
* Added support to dump `stdClass` and `ArrayAccess` objects as YAML mappings
|
|
|
186 |
through the `Yaml::DUMP_OBJECT_AS_MAP` flag.
|
|
|
187 |
|
|
|
188 |
* Strings that are not UTF-8 encoded will be dumped as base64 encoded binary
|
|
|
189 |
data.
|
|
|
190 |
|
|
|
191 |
* Added support for dumping multi line strings as literal blocks.
|
|
|
192 |
|
|
|
193 |
* Added support for parsing base64 encoded binary data when they are tagged
|
|
|
194 |
with the `!!binary` tag.
|
|
|
195 |
|
|
|
196 |
* Added support for parsing timestamps as `\DateTime` objects:
|
|
|
197 |
|
|
|
198 |
```php
|
|
|
199 |
Yaml::parse('2001-12-15 21:59:43.10 -5', Yaml::PARSE_DATETIME);
|
|
|
200 |
```
|
|
|
201 |
|
|
|
202 |
* `\DateTime` and `\DateTimeImmutable` objects are dumped as YAML timestamps.
|
|
|
203 |
|
|
|
204 |
* Deprecated usage of `%` at the beginning of an unquoted string.
|
|
|
205 |
|
|
|
206 |
* Added support for customizing the YAML parser behavior through an optional bit field:
|
|
|
207 |
|
|
|
208 |
```php
|
|
|
209 |
Yaml::parse('{ "foo": "bar", "fiz": "cat" }', Yaml::PARSE_EXCEPTION_ON_INVALID_TYPE | Yaml::PARSE_OBJECT | Yaml::PARSE_OBJECT_FOR_MAP);
|
|
|
210 |
```
|
|
|
211 |
|
|
|
212 |
* Added support for customizing the dumped YAML string through an optional bit field:
|
|
|
213 |
|
|
|
214 |
```php
|
|
|
215 |
Yaml::dump(['foo' => new A(), 'bar' => 1], 0, 0, Yaml::DUMP_EXCEPTION_ON_INVALID_TYPE | Yaml::DUMP_OBJECT);
|
|
|
216 |
```
|
|
|
217 |
|
|
|
218 |
3.0.0
|
|
|
219 |
-----
|
|
|
220 |
|
|
|
221 |
* Yaml::parse() now throws an exception when a blackslash is not escaped
|
|
|
222 |
in double-quoted strings
|
|
|
223 |
|
|
|
224 |
2.8.0
|
|
|
225 |
-----
|
|
|
226 |
|
|
|
227 |
* Deprecated usage of a colon in an unquoted mapping value
|
|
|
228 |
* Deprecated usage of @, \`, | and > at the beginning of an unquoted string
|
|
|
229 |
* When surrounding strings with double-quotes, you must now escape `\` characters. Not
|
|
|
230 |
escaping those characters (when surrounded by double-quotes) is deprecated.
|
|
|
231 |
|
|
|
232 |
Before:
|
|
|
233 |
|
|
|
234 |
```yml
|
|
|
235 |
class: "Foo\Var"
|
|
|
236 |
```
|
|
|
237 |
|
|
|
238 |
After:
|
|
|
239 |
|
|
|
240 |
```yml
|
|
|
241 |
class: "Foo\\Var"
|
|
|
242 |
```
|
|
|
243 |
|
|
|
244 |
2.1.0
|
|
|
245 |
-----
|
|
|
246 |
|
|
|
247 |
* Yaml::parse() does not evaluate loaded files as PHP files by default
|
|
|
248 |
anymore (call Yaml::enablePhpParsing() to get back the old behavior)
|