Skip to content

Commit c5b896b

Browse files
Lukasss93Lukasss93
committed
Update readme.md + upgrading.md
1 parent 9eb8c95 commit c5b896b

File tree

2 files changed

+57
-35
lines changed

2 files changed

+57
-35
lines changed

‎README.md

Lines changed: 34 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -131,10 +131,10 @@ php artisan vendor:publish --provider="Lukasss93\Larex\LarexServiceProvider" --t
131131
The `larex:export <exporter>` command exports CSV strings to a specific location based on the selected exporter.
132132

133133
| Exporter | Default | Description |
134-
|------------|---------|----------------------------------------------------|
135-
| laravel | Yes | Export data from CSV to Laravel localization files |
136-
| json:group | No | Export data from CSV to JSON by group |
137-
| json:lang | No | Export data from CSV to JSON by language |
134+
|------------|:-------:|----------------------------------------------------|
135+
| laravel | ✅ | Export data from CSV to Laravel localization files |
136+
| json:group | ❌ | Export data from CSV to JSON by group |
137+
| json:lang | ❌ | Export data from CSV to JSON by language |
138138

139139
##### How to create an exporter:
140140

@@ -145,11 +145,11 @@ The `larex:export <exporter>` command exports CSV strings to a specific location
145145

146146
The `larex:import <importer>` command imports the strings of the selected importer, into the CSV.
147147

148-
| Importer | Default | Description |
149-
|------------|---------|----------------------------------------------------|
150-
| laravel | Yes | Import data from Laravel localization files to CSV |
151-
| json:group | No | Import data from JSON by group to CSV |
152-
| json:lang | No | Import data from JSON by language to CSV |
148+
| Importer | Default | Description |
149+
|------------|:---------:|----------------------------------------------------|
150+
| laravel | ✅ | Import data from Laravel localization files to CSV |
151+
| json:group | ❌ | Import data from JSON by group to CSV |
152+
| json:lang | ❌ | Import data from JSON by language to CSV |
153153

154154
##### How to create an importer:
155155

@@ -162,17 +162,18 @@ Larex provides a linting system by using the `php artisan larex:lint` command to
162162

163163
##### Available linters:
164164

165-
| Linter | Enabled by default | Description |
166-
|---------------------------|--------------------|---------------------------------------------------|
167-
| ValidHeaderLinter | Yes | Validate the header structure |
168-
| ValidLanguageCodeLinter | Yes | Validate the language codes in the header columns |
169-
| DuplicateKeyLinter | Yes | Find duplicated keys |
170-
| ConcurrentKeyLinter | Yes | Find concurrent keys |
171-
| NoValueLinter | Yes | Find missing values |
172-
| DuplicateValueLinter | Yes | Find duplicated values in the same row |
173-
| UntranslatedStringsLinter | No | Find untranslated strings |
174-
| UntranslatedStringsLinter | No | Find unused strings |
175-
| ValidHtmlValueLinter | No | Check valid html values |
165+
| Linter | Enabled<br>by default | Description |
166+
|---------------------------|:---------------------:|---------------------------------------------------|
167+
| ValidHeaderLinter | ✅ | Validate the header structure |
168+
| ValidLanguageCodeLinter | ✅ | Validate the language codes in the header columns |
169+
| DuplicateKeyLinter | ✅ | Find duplicated keys |
170+
| ConcurrentKeyLinter | ✅ | Find concurrent keys |
171+
| NoValueLinter | ✅ | Find missing values |
172+
| DuplicateValueLinter | ✅ | Find duplicated values in the same row |
173+
| UntranslatedStringsLinter | ❌ | Find untranslated strings |
174+
| UntranslatedStringsLinter | ❌ | Find unused strings |
175+
| ValidHtmlValueLinter | ❌ | Check valid html values |
176+
| SameParametersLinter | ❌ | Check same parameters in each language |
176177

177178
You can enable/disable any linter you want by comment/uncomment it inside the larex config.
178179

@@ -193,19 +194,19 @@ composer test
193194

194195
## 🔰 Version Support
195196

196-
| Larex | L5.8 | L6.x | L7.x | L8.x | L9.x |
197-
|------------------|------|------|------|------|------|
198-
| ^1.0 | ✅ | ✅ | ✅ | ✅ | ❌ |
199-
| ^1.2 &#124; ^2.0 | ❌ | ✅ | ✅ | ✅ | ❌ |
200-
| ^3.0 | ❌ | ❌ | ✅ | ✅ | ❌ |
201-
| ^4.0 | ❌ | ❌ | ❌ | ✅ | ✅ |
202-
203-
| Larex | PHP7.2 | PHP7.3 | PHP7.4 | PHP8.0 | PHP8.1 |
204-
|------------------|--------|--------|--------|--------|--------|
205-
| ^1.0 | ✅ | ✅ | ✅ | ❌ | ❌ |
206-
| ^1.6 &#124; ^2.0 | ❌ | ✅ | ✅ | ✅ | ✅ |
207-
| ^3.0 | ❌ | ❌ | ✅ | ✅ | ✅ |
208-
| ^4.0 | ❌ | ❌ | ❌ | ✅ | ✅ |
197+
| Larex | L5.8 | L6.x | L7.x | L8.x | L9.x |
198+
|:----------------:|:----:|:----:|:----:|:----:|:----:|
199+
| ^1.0 | ✅ | ✅ | ✅ | ✅ | ❌ |
200+
| ^1.2 &#124; ^2.0 | ❌ | ✅ | ✅ | ✅ | ❌ |
201+
| ^3.0 | ❌ | ❌ | ✅ | ✅ | ❌ |
202+
| ^4.0 | ❌ | ❌ | ❌ | ✅ | ✅ |
203+
204+
| Larex | PHP7.2 | PHP7.3 | PHP7.4 | PHP8.0 | PHP8.1 |
205+
|:----------------:|:------:|:------:|:------:|:------:|:------:|
206+
| ^1.0 | ✅ | ✅ | ✅ | ❌ | ❌ |
207+
| ^1.6 &#124; ^2.0 | ❌ | ✅ | ✅ | ✅ | ✅ |
208+
| ^3.0 | ❌ | ❌ | ✅ | ✅ | ✅ |
209+
| ^4.0 | ❌ | ❌ | ❌ | ✅ | ✅ |
209210

210211

211212
## 📃 Changelog

‎UPGRADING.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,28 @@
33
Because there are many breaking changes an upgrade is not that easy. There are many edge cases this guide does not
44
cover. We accept PRs to improve this guide.
55

6-
## From v3.0 to v4.0
6+
## From v4.0 to v4.2
7+
- The `larex.php` config was changed:
8+
- **Optional**. Please append new `SameParametersLinter` linter in this way:
9+
```php
10+
/**
11+
* Linters to run with larex:lint command.
12+
*/
13+
'linters' => [
14+
// other linters here
15+
// Lukasss93\Larex\Linters\SameParametersLinter::class,
16+
],
17+
```
18+
- **Optional**. Please append `ignore_empty_values` key in this way:
19+
```php
20+
/**
21+
* Used by SameParametersLinter
22+
*/
23+
'ignore_empty_values' => false,
24+
```
25+
_Or you can delete your current config and publish it again (copy your changes before)._
26+
27+
## From v3.x to v4.0
728
- The `larex.php` config was changed. Please change the `path` key in this way:
829
```php
930
// <project-root>/config/larex.php
@@ -23,7 +44,7 @@ _Or you can delete your current config and publish it again (copy your changes b
2344
- ⚠️ Dropped **Laravel 7** support, please upgrade at least to **Laravel 8**.
2445

2546

26-
## From v2.1 to v3.0
47+
## From v2.1 to v3.x
2748

2849
- The `larex.php` config was changed. Please delete your current config and publish it again (copy your changes before).
2950
- If you created a custom Linter, please follow this steps:

0 commit comments

Comments
 (0)