Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TASK] Autoformat the changelog #718

Merged
merged 1 commit into from
Sep 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 77 additions & 33 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
## x.y.z

### Added

- Add official support for PHP 8.4 (#657)
- Support arithmetic operators in CSS function arguments (#607)
- Add support for inserting an item in a CSS list (#545)
Expand All @@ -23,9 +24,9 @@ This project adheres to [Semantic Versioning](https://semver.org/).

### Deprecated

- Deprecate `Parser::setCharset()` and `Parser::getCharset()` (#688)
- Deprecate `Parser::setCharset()` and `Parser::getCharset()` (#688)
- Deprecate the expansion of shorthand properties (#578, #580, #579, #577, #576,
#575, #574, #573, #572, #571, #570, #569, #566, #567, #558)
#575, #574, #573, #572, #571, #570, #569, #566, #567, #558)

### Removed

Expand All @@ -41,7 +42,8 @@ This project adheres to [Semantic Versioning](https://semver.org/).
- Fix type errors in PHP strict mode (#664)
- Fix comment parsing to support multiple comments (#672)
- Fix undefined local variable in `CalcFunction::parse()` (#593)
- Fix PHP notice caused by parsing invalid color values having less than 6 characters (#485)
- Fix PHP notice caused by parsing invalid color values having less than 6
characters (#485)
- Fix (regression) failure to parse at-rules with strict parsing (#456)

@ziegenberg is a new contributor to this release and did a lot of the heavy
Expand Down Expand Up @@ -69,7 +71,8 @@ lifting. Thanks! :heart:

* Support for PHP 8.x
* PHPDoc annotations
* Allow usage of CSS variables inside color functions (by parsing them as regular functions)
* Allow usage of CSS variables inside color functions (by parsing them as
regular functions)
* Use PSR-12 code style
* *No deprecations*

Expand All @@ -84,7 +87,10 @@ lifting. Thanks! :heart:
* Allow a file to end after an `@import`
* Preserve case of CSS variables as specced
* Allow identifiers to use escapes the same way as strings
* No longer use `eval` for the comparison in `getSelectorsBySpecificity`, in case it gets passed untrusted input (CVE-2020-13756). Also fixed in 8.3.1, 8.2.1, 8.1.1, 8.0.1, 7.0.4, 6.0.2, 5.2.1, 5.1.3, 5.0.9, 4.0.1, 3.0.1, 2.0.1, 1.0.1.
* No longer use `eval` for the comparison in `getSelectorsBySpecificity`, in
case it gets passed untrusted input (CVE-2020-13756). Also fixed in 8.3.1,
8.2.1, 8.1.1, 8.0.1, 7.0.4, 6.0.2, 5.2.1, 5.1.3, 5.0.9, 4.0.1, 3.0.1, 2.0.1,
1.0.1.
* Prevent an infinite loop when parsing invalid grid line names
* Remove invalid unit `vm`
* Retain rule order after expanding shorthands
Expand All @@ -96,28 +102,37 @@ lifting. Thanks! :heart:

## 8.3.0 (2019-02-22)

* Refactor parsing logic to mostly reside in the class files whose data structure is to be parsed (this should eventually allow us to unit-test specific parts of the parsing logic individually).
* Fix error in parsing `calc` expessions when the first operand is a negative number, thanks to @raxbg.
* Support parsing CSS4 colors in hex notation with alpha values, thanks to @raxbg.
* Refactor parsing logic to mostly reside in the class files whose data
structure is to be parsed (this should eventually allow us to unit-test
specific parts of the parsing logic individually).
* Fix error in parsing `calc` expessions when the first operand is a negative
number, thanks to @raxbg.
* Support parsing CSS4 colors in hex notation with alpha values, thanks to
@raxbg.
* Swallow more errors in lenient mode, thanks to @raxbg.
* Allow specifying arbitrary strings to output before and after declaration blocks, thanks to @westonruter.
* Allow specifying arbitrary strings to output before and after declaration
blocks, thanks to @westonruter.
* *No backwards-incompatible changes*
* *No deprecations*

## 8.2.0 (2018-07-13)

* Support parsing `calc()`, thanks to @raxbg.
* Support parsing grid-lines, again thanks to @raxbg.
* Support parsing legacy IE filters (`progid:`) in lenient mode, thanks to @FMCorz
* Support parsing legacy IE filters (`progid:`) in lenient mode, thanks to
@FMCorz
* Performance improvements parsing large files, again thanks to @FMCorz
* *No backwards-incompatible changes*
* *No deprecations*

## 8.1.0 (2016-07-19)

* Comments are no longer silently ignored but stored with the object with which they appear (no render support, though). Thanks to @FMCorz.
* The IE hacks using `\0` and `\9` can now be parsed (and rendered) in lenient mode. Thanks (again) to @FMCorz.
* Media queries with or without spaces before the query are parsed. Still no *real* parsing support, though. Sorry…
* Comments are no longer silently ignored but stored with the object with which
they appear (no render support, though). Thanks to @FMCorz.
* The IE hacks using `\0` and `\9` can now be parsed (and rendered) in lenient
mode. Thanks (again) to @FMCorz.
* Media queries with or without spaces before the query are parsed. Still no
*real* parsing support, though. Sorry…
* PHPUnit is now listed as a dev-dependency in composer.json.
* *No backwards-incompatible changes*
* *No deprecations*
Expand All @@ -129,7 +144,8 @@ lifting. Thanks! :heart:

### Backwards-incompatible changes

* Unrecoverable parser errors throw an exception of type `Sabberworm\CSS\Parsing\SourceException` instead of `\Exception`.
* Unrecoverable parser errors throw an exception of type
`Sabberworm\CSS\Parsing\SourceException` instead of `\Exception`.

## 7.0.3 (2016-04-27)

Expand All @@ -139,7 +155,8 @@ lifting. Thanks! :heart:

## 7.0.2 (2016-02-11)

* 150 time performance boost thanks to @[ossinkine](https://github.com/ossinkine)
* 150 time performance boost thanks
to @[ossinkine](https://github.com/ossinkine)
* *No backwards-incompatible changes*
* *No deprecations*

Expand All @@ -156,7 +173,8 @@ lifting. Thanks! :heart:

### Backwards-incompatible changes

* The `Sabberworm\CSS\Value\String` class has been renamed to `Sabberworm\CSS\Value\CSSString`.
* The `Sabberworm\CSS\Value\String` class has been renamed to
`Sabberworm\CSS\Value\CSSString`.

## 6.0.1 (2015-08-24)

Expand All @@ -170,22 +188,27 @@ lifting. Thanks! :heart:

### Deprecations

* The parse() method replaces __toString with an optional argument (instance of the OutputFormat class)
* The parse() method replaces __toString with an optional argument (instance of
the OutputFormat class)

## 5.2.0 (2014-06-30)

* Support removing a selector from a declaration block using `$oBlock->removeSelector($mSelector)`
* Introduce a specialized exception (Sabberworm\CSS\Parsing\OuputException) for exceptions during output rendering
* Support removing a selector from a declaration block using
`$oBlock->removeSelector($mSelector)`
* Introduce a specialized exception (Sabberworm\CSS\Parsing\OuputException) for
exceptions during output rendering

* *No deprecations*

#### Backwards-incompatible changes

* Outputting a declaration block that has no selectors throws an OuputException instead of outputting an invalid ` {…}` into the CSS document.
* Outputting a declaration block that has no selectors throws an OuputException
instead of outputting an invalid ` {…}` into the CSS document.

## 5.1.2 (2013-10-30)

* Remove the use of consumeUntil in comment parsing. This makes it possible to parse comments such as `/** Perfectly valid **/`
* Remove the use of consumeUntil in comment parsing. This makes it possible to
parse comments such as `/** Perfectly valid **/`
* Add fr relative size unit
* Fix some issues with HHVM
* *No backwards-incompatible changes*
Expand All @@ -200,13 +223,15 @@ lifting. Thanks! :heart:
## 5.1.0 (2013-10-24)

* Performance enhancements by Michael M Slusarz
* More rescue entry points for lenient parsing (unexpected tokens between declaration blocks and unclosed comments)
* More rescue entry points for lenient parsing (unexpected tokens between
declaration blocks and unclosed comments)
* *No backwards-incompatible changes*
* *No deprecations*

## 5.0.8 (2013-08-15)

* Make default settings’ multibyte parsing option dependent on whether or not the mbstring extension is actually installed.
* Make default settings’ multibyte parsing option dependent on whether or not
the mbstring extension is actually installed.
* *No backwards-incompatible changes*
* *No deprecations*

Expand All @@ -224,7 +249,9 @@ lifting. Thanks! :heart:

## 5.0.5 (2013-04-17)

* Initial support for lenient parsing (setting this parser option will catch some exceptions internally and recover the parser’s state as neatly as possible).
* Initial support for lenient parsing (setting this parser option will catch
some exceptions internally and recover the parser’s state as neatly as
possible).
* *No backwards-incompatible changes*
* *No deprecations*

Expand Down Expand Up @@ -261,18 +288,22 @@ lifting. Thanks! :heart:

### Backwards-incompatible changes

* `Sabberworm\CSS\Value\Color`’s `__toString` method overrides `CSSList`’s to maybe return something other than `type(value, …)` (see above).
* `Sabberworm\CSS\Value\Color`’s `__toString` method overrides `CSSList`’s to
maybe return something other than `type(value, …)` (see above).

## 4.0.0 (2013-03-19)

* Support for more @-rules
* Generic interface `Sabberworm\CSS\Property\AtRule`, implemented by all @-rule classes
* Generic interface `Sabberworm\CSS\Property\AtRule`, implemented by all @-rule
classes
* *No deprecations*

### Backwards-incompatible changes

* `Sabberworm\CSS\RuleSet\AtRule` renamed to `Sabberworm\CSS\RuleSet\AtRuleSet`
* `Sabberworm\CSS\CSSList\MediaQuery` renamed to `Sabberworm\CSS\RuleSet\CSSList\AtRuleBlockList` with differing semantics and API (which also works for other block-list-based @-rules like `@supports`).
* `Sabberworm\CSS\CSSList\MediaQuery` renamed to
`Sabberworm\CSS\RuleSet\CSSList\AtRuleBlockList` with differing semantics and
API (which also works for other block-list-based @-rules like `@supports`).

## 3.0.0 (2013-03-06)

Expand All @@ -281,19 +312,32 @@ lifting. Thanks! :heart:

### Backwards-incompatible changes

* All properties (like whether or not to use `mb_`-functions, which default charset to use and – new – whether or not to be forgiving when parsing) are now encapsulated in an instance of `Sabberworm\CSS\Settings` which can be passed as the second argument to `Sabberworm\CSS\Parser->__construct()`.
* Specifying a charset as the second argument to `Sabberworm\CSS\Parser->__construct()` is no longer supported. Use `Sabberworm\CSS\Settings::create()->withDefaultCharset('some-charset')` instead.
* Setting `Sabberworm\CSS\Parser->bUseMbFunctions` has no effect. Use `Sabberworm\CSS\Settings::create()->withMultibyteSupport(true/false)` instead.
* `Sabberworm\CSS\Parser->parse()` may throw a `Sabberworm\CSS\Parsing\UnexpectedTokenException` when in strict parsing mode.
* All properties (like whether or not to use `mb_`-functions, which default
charset to use and – new – whether or not to be forgiving when parsing) are
now encapsulated in an instance of `Sabberworm\CSS\Settings` which can be
passed as the second argument to `Sabberworm\CSS\Parser->__construct()`.
* Specifying a charset as the second argument to
`Sabberworm\CSS\Parser->__construct()` is no longer supported. Use
`Sabberworm\CSS\Settings::create()->withDefaultCharset('some-charset')`
instead.
* Setting `Sabberworm\CSS\Parser->bUseMbFunctions` has no effect. Use
`Sabberworm\CSS\Settings::create()->withMultibyteSupport(true/false)` instead.
* `Sabberworm\CSS\Parser->parse()` may throw a
`Sabberworm\CSS\Parsing\UnexpectedTokenException` when in strict parsing mode.

## 2.0.0 (2013-01-29)

* Allow multiple rules of the same type per rule set

### Backwards-incompatible changes

* `Sabberworm\CSS\RuleSet->getRules()` returns an index-based array instead of an associative array. Use `Sabberworm\CSS\RuleSet->getRulesAssoc()` (which eliminates duplicate rules and lets the later rule of the same name win).
* `Sabberworm\CSS\RuleSet->removeRule()` works as it did before except when passed an instance of `Sabberworm\CSS\Rule\Rule`, in which case it would only remove the exact rule given instead of all the rules of the same type. To get the old behaviour, use `Sabberworm\CSS\RuleSet->removeRule($oRule->getRule()`;
* `Sabberworm\CSS\RuleSet->getRules()` returns an index-based array instead of
an associative array. Use `Sabberworm\CSS\RuleSet->getRulesAssoc()` (which
eliminates duplicate rules and lets the later rule of the same name win).
* `Sabberworm\CSS\RuleSet->removeRule()` works as it did before except when
passed an instance of `Sabberworm\CSS\Rule\Rule`, in which case it would only
remove the exact rule given instead of all the rules of the same type. To get
the old behaviour, use `Sabberworm\CSS\RuleSet->removeRule($oRule->getRule()`;

## 1.0

Expand Down