npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

eslint-plugin-i18n-guard

v1.0.2

Published

ESLint plugin designed to help ensure that every key in your JSON i18n translation files has a corresponding translation. This can help avoid missing translations and ensure consistency across languages.

Downloads

211

Readme

eslint-plugin-i18n-guard

ESLint plugin designed to help ensure that every key in your JSON i18n translation files has a corresponding translation. This can help avoid missing translations and ensure consistency across languages.

Installation

npm install eslint-plugin-i18n-guard --save-dev
pnpm install eslint-plugin-i18n-guard --save-dev
yarn add eslint eslint-plugin-i18n-guard --dev

Usage

In your ESLint configuration (.eslintrc.json, .eslintrc.js), add the plugin and configure the rules:

import i18nGuard from "eslint-plugin-i18n-guard";

const i18nOptions = {
    "directories": ["src/translations"],
    "entryPoint": "src/App.tsx"
}
export default eslint.config(
    //.....

    plugins: {
      "i18n-guard": i18nGuard,
    },
    rules: {
        "i18n-guard/i18n-no-missing-keys": [
            "error",
            i18nOptions
        ],
        "i18n-guard/i18n-consistent-json": [
            "warn",
            i18nOptions
        ]
    }
)

Rules

i18n-no-missing-keys

This rule ensures that all translation files have the same keys. If any key is missing in one or more files, an error will be reported.

This will prevent not translated texts across our application.

Example

// translations/en.json
{
  "welcome": "Welcome",
  "logout": "Log out"
}

// translations/fr.json
{
  "welcome": "Bienvenue"
}
"logout" is missing in file: translations/fr.json

i18n-consistent-json-files.js

This rule checks that the order of the keys is the same across all translation files. It warns if the key order is inconsistent.

Example

// translations/en.json
{
  "welcome": "Welcome",
  "logout": "Log out"
}

// translations/fr.json
{
  "logout": "Se déconnecter",
  "welcome": "Bienvenue"
}
"welcome" is not consistent in files: translations/en.json, translations/fr.json

Options

Both rules accept the following options:

  • directories: An array of directory paths containing the i18n JSON files that should be checked for consistency.
  • entryPoint: The entry point file of your application (e.g., main.tsx, App.tsx). The ESLint error or warning messages will appear in this file.