Skip to content

Commit 8220514

Browse files
committed
Add MIGRATION.md
1 parent 30b6e66 commit 8220514

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

MIGRATION.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Migrating from Liaison CS Config Factory
2+
3+
The following were the changes implemented in considering the transition to NexusPHP CS Config:
4+
5+
## Added
6+
7+
- Public methods `forProjects` and `forLibrary` were added to `Factory` class.
8+
- `forProjects` accepts no arguments and acts as the old `Factory::create`.
9+
- `forLibrary` accepts two required and two optional arguments and behaves as the old `Factory::createForLibrary`.
10+
- The `Nexus73` ruleset is added and meant for use in PHP 7.3+.
11+
- `declare(strict_types=1)` was added to all PHP files for additional type safety.
12+
13+
## Changed
14+
15+
- Root namespace of `Liaison\CS\Config` was renamed to `Nexus\CsConfig`.
16+
- `Factory::create` now returns an instance of `Factory` instead of `PhpCsFixer\Config`. This allows it
17+
to be chained with either `forProjects` or `forLibrary` public methods.
18+
19+
## Removed
20+
21+
- `Factory::createForLibrary` was removed. Use the public method `forLibrary` to get similar effect.
22+
- The `Liaison` and `CodeIgniter4` rulesets were removed.
23+
- The deprecated `BaseRuleset` class was removed.
24+
- Custom fixers were removed and moved to a new repository, [NexusPHP CS Fixers][1].
25+
26+
[1]: https://github.com/NexusPHP/cs-fixers
27+
28+
Please have a look at this library's [`.php_cs.dist`](.php_cs.dist) to have a glance of the new changes
29+
in action. You can also refer to the [README](README.md) for additional details.

0 commit comments

Comments
 (0)