# Validator

The **Transloco Validator** package helps ensure the integrity of your translation files by validating their JSON structure and detecting duplicate keys. This tool is handy for maintaining consistent and error-free translation files throughout your project.

## **Installation**

{% tabs %}
{% tab title="pnpm" %}

```bash
pnpm add @jsverse/transloco-validator --save-dev
```

{% endtab %}

{% tab title="yarn" %}

```bash
yarn add @jsverse/transloco-validator --dev
```

{% endtab %}

{% tab title="npm" %}

```bash
npm install @jsverse/transloco-validator --save-dev
```

{% endtab %}
{% endtabs %}

## **Usage**

{% tabs %}
{% tab title="lintstaged" %}
To ensure your translation files are always valid, configure Transloco Validator to run on specific paths during pre-commit checks. You can easily set this up in your `lint-staged` configuration.

`lint-staged` supports [multiple configuration formats](https://github.com/lint-staged/lint-staged?tab=readme-ov-file#configuration). All you need to do is add the following line to the configuration of your choice:

```json
"src/assets/i18n/*.json": ["transloco-validator"]
```

This ensures that any changes to your translation files are validated before they are committed.
{% endtab %}

{% tab title="GitHub Actions" %}
Here’s an example workflow that triggers when your translation files are changed and verifies them using the `transloco-validator`:

{% code title="validate-translations.yml" %}

```yaml
name: Validate Translation Files

on:
  pull_request:
    paths:
      # Trigger when any i18n JSON file is modified
      - 'src/assets/i18n/**.json'

jobs:
  validate-translations:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: '20'

      - name: Install Dependencies
        run: npm ci

      - name: Run Transloco Validator on Changed i18n Files
        run: |
          # Find the changed i18n files and run the validator on them
          git diff --name-only ${{ github.event.before }} ${{ github.sha }} | grep 'src/assets/i18n/.*\.json' | xargs npx transloco-validator
```

{% endcode %}
{% endtab %}
{% endtabs %}

## **Benefits**

* **JSON Validation:** Verifies that all translation files have a valid JSON structure.
* **Duplicate Key Detection:** Ensures no duplicate keys are present in your translation files.

By incorporating Transloco Validator into your workflow, you can maintain high-quality translation files and avoid runtime issues caused by invalid JSON or key conflicts.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://jsverse.gitbook.io/transloco/developer-tools/validator.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.