Merge pull request #74 from move-elevator/disable-duplicate-values-validator

feat: skip DuplicateValuesValidator by default

Author: Konrad Michalik

docs/config-file.md

@@ -8,6 +8,12 @@ to customize validation behavior, specify paths and control which validators are
 >
 > See the [JSON Schema](../schema/translation-validator.schema.json) section for more details.
 
+> [!NOTE]
+> **DuplicateValuesValidator is disabled by default** (opt-in)
+>
+> The `DuplicateValuesValidator` is skipped by default to reduce noise in validation results.
+> You can enable it by explicitly including it in the `only` option or by setting an empty `skip` array.
+
 See the [Configuration Schema](schema.md) for details on available options.
 
 ## Formats
@@ -42,6 +48,37 @@ $config->setPaths(['translations/', 'locale/'])
 return $config;
 ```
 
+### Enabling DuplicateValuesValidator
+
+To enable the `DuplicateValuesValidator`, explicitly include it in the `only` option:
+
+```php
+<?php
+
+declare(strict_types=1);
+
+use MoveElevator\ComposerTranslationValidator\Config\TranslationValidatorConfig;
+use MoveElevator\ComposerTranslationValidator\Validator\DuplicateValuesValidator;
+
+$config = new TranslationValidatorConfig();
+$config->setPaths(['translations/'])
+    ->setOnly([
+        DuplicateValuesValidator::class,
+    ]);
+
+return $config;
+```
+
+Or remove it from the skip list:
+
+```php
+$config = new TranslationValidatorConfig();
+$config->setPaths(['translations/'])
+    ->setSkip([]); // Empty skip list enables all validators including DuplicateValuesValidator
+
+return $config;
+```
+
 ## Configuration in JSON file
 
 Create a JSON file with the following structure:
@@ -79,6 +116,28 @@ Create a JSON file with the following structure:
 }
 ```
 
+### Enabling DuplicateValuesValidator in JSON
+
+To enable the `DuplicateValuesValidator`:
+
+```json
+{
+  "paths": ["translations/"],
+  "skip": []
+}
+```
+
+Or use the `only` option:
+
+```json
+{
+  "paths": ["translations/"],
+  "only": [
+    "MoveElevator\\ComposerTranslationValidator\\Validator\\DuplicateValuesValidator"
+  ]
+}
+```
+
 ## Configuration in YAML file
 
 Create a YAML file with the following structure:
@@ -114,6 +173,25 @@ format: cli
 verbose: false
 ```
 
+### Enabling DuplicateValuesValidator in YAML
+
+To enable the `DuplicateValuesValidator`:
+
+```yaml
+paths:
+  - translations/
+skip: []
+```
+
+Or use the `only` option:
+
+```yaml
+paths:
+  - translations/
+only:
+  - MoveElevator\ComposerTranslationValidator\Validator\DuplicateValuesValidator
+```
+
 ## Configuration in composer.json
 
 You can also specify the path to a configuration file in your `composer.json`:

docs/validators.md

@@ -85,6 +85,27 @@ Identifies identical translation values that might indicate copy-paste errors or
 
 **Result:** ![Warning](https://img.shields.io/badge/WARNING-yellow)
 
+> [!NOTE]
+> This validator is disabled by default (opt-in).
+
+The `DuplicateValuesValidator` is skipped by default to reduce noise in validation results, as duplicate values are often intentional (e.g., common button labels like "OK" or "Cancel").
+
+To enable this validator, use one of the following methods:
+
+**Via CLI:**
+```bash
+composer validate-translations translations/ --only "MoveElevator\\ComposerTranslationValidator\\Validator\\DuplicateValuesValidator"
+```
+
+**Clear the skip entry via configuration file (YAML):**
+```yaml
+paths:
+  - translations/
+skip: []
+```
+
+See the [configuration documentation](config-file.md) for more details.
+
 ### Example
 
 **File: `errors.en.yaml`**
@@ -121,19 +142,7 @@ composer -d tests validate-translations Fixtures/examples/duplicate-values --onl
 </details>
 
 > [!TIP]
-> While sometimes duplicate values are intentional, they often reveal incomplete translations or copy-paste mistakes.
-> If you want to suppress these warnings, you can skip this validator using the `--skip` option or using the configuration file.
->
-> Example command to skip this validator:
-> ```bash
-> composer validate-translations ./translations --skip "MoveElevator\\ComposerTranslationValidator\\Validator\\DuplicateValuesValidator"
-> ```
->
-> or within your configuration file , e.g. `translation-validator.yaml`:
-> ```yaml
-> skip:
->   - MoveElevator\ComposerTranslationValidator\Validator\DuplicateKeysValidator
-> ```
+> While sometimes duplicate values are intentional (e.g., common UI elements like "OK", "Cancel", or "Close"), they often reveal incomplete translations or copy-paste mistakes that need attention.
 
 ---
 

src/Command/ValidateTranslationCommand.php

@@ -120,7 +120,7 @@ protected function configure(): void
 <comment>Available Validators:</comment>
   • <info>MismatchValidator</info>        - Detects mismatches between source and target
   • <info>DuplicateKeysValidator</info>   - Finds duplicate translation keys
-  • <info>DuplicateValuesValidator</info> - Finds duplicate translation values
+  • <info>DuplicateValuesValidator</info> - Finds duplicate translation values (opt-in, disabled by default)
   • <info>EmptyValuesValidator</info>     - Finds empty or whitespace-only translation values
   • <info>EncodingValidator</info>        - Validates file encoding and character issues
   • <info>HtmlTagValidator</info>         - Validates HTML tag consistency across translations

src/Config/TranslationValidatorConfig.php

@@ -13,6 +13,8 @@
 
 namespace MoveElevator\ComposerTranslationValidator\Config;
 
+use MoveElevator\ComposerTranslationValidator\Validator\DuplicateValuesValidator;
+
 /**
  * TranslationValidatorConfig.
  *
@@ -37,7 +39,9 @@ class TranslationValidatorConfig
     private array $only = [];
 
     /** @var string[] */
-    private array $skip = [];
+    private array $skip = [
+        DuplicateValuesValidator::class,
+    ];
 
     /** @var string[] */
     private array $exclude = [];

tests/src/Config/ConfigFactoryTest.php

@@ -73,7 +73,7 @@ public function testCreateFromArrayWithEmptyData(): void
         $this->assertSame([], $config->getFileDetectors());
         $this->assertSame([], $config->getParsers());
         $this->assertSame([], $config->getOnly());
-        $this->assertSame([], $config->getSkip());
+        $this->assertSame([\MoveElevator\ComposerTranslationValidator\Validator\DuplicateValuesValidator::class], $config->getSkip());
         $this->assertSame([], $config->getExclude());
         $this->assertFalse($config->getStrict());
         $this->assertFalse($config->getDryRun());

tests/src/Config/TranslationValidatorConfigTest.php

@@ -106,7 +106,7 @@ public function testSkipAndGetSkip(): void
     {
         $validator = 'SkipValidator';
         $this->config->skip($validator);
-        $this->assertSame([$validator], $this->config->getSkip());
+        $this->assertSame([\MoveElevator\ComposerTranslationValidator\Validator\DuplicateValuesValidator::class, $validator], $this->config->getSkip());
     }
 
     public function testSetAndGetSkip(): void
@@ -164,7 +164,7 @@ public function testDefaultValues(): void
         $this->assertSame([], $this->config->getFileDetectors());
         $this->assertSame([], $this->config->getParsers());
         $this->assertSame([], $this->config->getOnly());
-        $this->assertSame([], $this->config->getSkip());
+        $this->assertSame([\MoveElevator\ComposerTranslationValidator\Validator\DuplicateValuesValidator::class], $this->config->getSkip());
         $this->assertSame([], $this->config->getExclude());
         $this->assertFalse($this->config->getStrict());
         $this->assertFalse($this->config->getDryRun());
@@ -264,7 +264,7 @@ public function testToArrayWithDefaultValues(): void
             'file-detectors' => [],
             'parsers' => [],
             'only' => [],
-            'skip' => [],
+            'skip' => [\MoveElevator\ComposerTranslationValidator\Validator\DuplicateValuesValidator::class],
             'exclude' => [],
             'strict' => false,
             'dry-run' => false,