Merge pull request #102 from andreaswolf/issue-61

[TASK] Add README.md for other packages

Author: sabbelasichon

README.md

@@ -33,15 +33,51 @@ At minimum, a configuration file must specify the paths to process:
 
 ```php
 <?php
-    
-use a9f\Fractor\DependencyInjection\FractorConfiguration;      
+
+use a9f\Fractor\Configuration\FractorConfiguration;
 
 return FractorConfiguration::configure()
     ->withPaths([__DIR__ . '/packages/'])
     ->withSets([
         Typo3LevelSetList::UP_TO_TYPO3_13
     ]);
+```
+
+If you want to apply only one specific rule you can do so:
+
+```php
+<?php
+
+use a9f\Fractor\Configuration\FractorConfiguration;
+use a9f\Typo3Fractor\TYPO3v7\FlexForm\AddRenderTypeToFlexFormFractor;
+use a9f\FractorComposerJson\AddPackageToRequireDevComposerJsonFractorRule;
+
+return FractorConfiguration::configure()
+    ->withPaths([__DIR__ . '/packages/'])
+    ->withConfiguredRule(AddPackageToRequireDevComposerJsonFractorRule::class, [new PackageAndVersion('vendor1/package3', '^3.0')]
+    )
+    ->withRules([AddRenderTypeToFlexFormFractor::class]);
+```
 
+You can even skip some rules or files and folders. Do it the following way:
+
+```php
+<?php
+
+use a9f\Fractor\Configuration\FractorConfiguration;
+
+return FractorConfiguration::configure()
+    ->withPaths([__DIR__ . '/packages/'])
+    ->withSkip([
+        __DIR__ . '/packages/my_package/crappy_file.txt',
+        AddRenderTypeToFlexFormFractor::class,
+        __DIR__ . '/packages/my_package/other_crappy_file.txt' => [
+            AddRenderTypeToFlexFormFractor::class,
+        ]
+    ])
+    ->withSets([
+        Typo3LevelSetList::UP_TO_TYPO3_13
+    ]);
 ```
 
 ## Processing

packages/fractor-composer-json/README.md

@@ -0,0 +1,16 @@
+# Fractor for composer.json files
+
+FileProcessor for composer.json files.
+
+## Installation
+
+```bash
+composer require a9f/fractor-composer-json --dev
+```
+
+## Configuration
+
+All rules must implement the a9f\FractorComposerJson\Contract\ComposerJsonFractorRule interface.
+The rule will be tagged with 'fractor.composer_json_rule' and be injected in the ComposerJsonFileProcessor.
+
+Have a look at all available rules [Overview of all rules](docs/composer-json-fractor-rules.md)

packages/fractor-composer-json/docs/composer-json-fractor-rules.md

@@ -0,0 +1,112 @@
+# 6 Rules Overview
+
+## AddPackageToRequireComposerJsonFractorRule
+
+Add package to "require" in `composer.json`
+
+:wrench: **configure it!**
+
+- class: [`a9f\FractorComposerJson\AddPackageToRequireComposerJsonFractorRule`](../rules/AddPackageToRequireComposerJsonFractorRule.php)
+
+```diff
+ {
++    "require": {
++        "symfony/console": "^3.4"
++    }
+ }
+```
+
+<br>
+
+## AddPackageToRequireDevComposerJsonFractorRule
+
+Add package to "require-dev" in `composer.json`
+
+:wrench: **configure it!**
+
+- class: [`a9f\FractorComposerJson\AddPackageToRequireDevComposerJsonFractorRule`](../rules/AddPackageToRequireDevComposerJsonFractorRule.php)
+
+```diff
+ {
++    "require-dev": {
++        "symfony/console": "^3.4"
++    }
+ }
+```
+
+<br>
+
+## ChangePackageVersionComposerJsonFractorRule
+
+Change package version `composer.json`
+
+:wrench: **configure it!**
+
+- class: [`a9f\FractorComposerJson\ChangePackageVersionComposerJsonFractorRule`](../rules/ChangePackageVersionComposerJsonFractorRule.php)
+
+```diff
+ {
+     "require": {
+-        "symfony/console": "^3.4"
++        "symfony/console": "^4.4"
+     }
+ }
+```
+
+<br>
+
+## RemovePackageComposerJsonFractorRule
+
+Remove package from "require" and "require-dev" in `composer.json`
+
+:wrench: **configure it!**
+
+- class: [`a9f\FractorComposerJson\RemovePackageComposerJsonFractorRule`](../rules/RemovePackageComposerJsonFractorRule.php)
+
+```diff
+ {
+-    "require": {
+-        "symfony/console": "^3.4"
+-    }
+ }
+```
+
+<br>
+
+## RenamePackageComposerJsonFractorRule
+
+Change package name in `composer.json`
+
+:wrench: **configure it!**
+
+- class: [`a9f\FractorComposerJson\RenamePackageComposerJsonFractorRule`](../rules/RenamePackageComposerJsonFractorRule.php)
+
+```diff
+ {
+     "require": {
+-        "rector/rector": "dev-main"
++        "rector/rector-src": "dev-main"
+     }
+ }
+```
+
+<br>
+
+## ReplacePackageAndVersionComposerJsonFractorRule
+
+Change package name and version `composer.json`
+
+:wrench: **configure it!**
+
+- class: [`a9f\FractorComposerJson\ReplacePackageAndVersionComposerJsonFractorRule`](../rules/ReplacePackageAndVersionComposerJsonFractorRule.php)
+
+```diff
+ {
+     "require-dev": {
+-        "symfony/console": "^3.4"
++        "symfony/http-kernel": "^4.4"
+     }
+ }
+```
+
+<br>

packages/fractor-fluid/README.md

@@ -0,0 +1,14 @@
+# Fractor for Fluid Templates
+
+FileProcessor for Fluid templates.
+
+## Installation
+
+```bash
+composer require a9f/fractor-fluid --dev
+```
+
+## Configuration
+
+All rules must implement the a9f\FractorFluid\Contract\FluidFractorRule interface.
+The rule will be tagged with 'fractor.fluid_rule' and be injected in the FluidFileProcessor.

packages/fractor-xml/README.md

@@ -0,0 +1,14 @@
+# Fractor for XML files
+
+FileProcessor for XML files.
+
+## Installation
+
+```bash
+composer require a9f/fractor-xml --dev
+```
+
+## Configuration
+
+All rules must implement the a9f\FractorXml\Contract\XmlFractor interface.
+The rule will be tagged with 'fractor.xml_rule' and be injected in the XmlFileProcessor.

packages/fractor-yaml/README.md

@@ -0,0 +1,14 @@
+# Fractor for YAML files
+
+FileProcessor for YAML files.
+
+## Installation
+
+```bash
+composer require a9f/fractor-yaml --dev
+```
+
+## Configuration
+
+All rules must implement the a9f\FractorYaml\Contract\YamlFractorRule interface.
+The rule will be tagged with 'fractor.yaml_rule' and be injected in the YamlFileProcessor.