Git Product home page Git Product logo

eslint-plugin-no-jp's Introduction

eslint-plugin-no-jp

npm CI npm bundle size

Overview

Helps the team(you) stick to English throuout the codebase. In other words, it helps the team(you) not rely on Japanese🇯🇵)

Installation

  • with Yarn
yarn add -D eslint-plugin-no-jp
  • with npm
npm install eslint-plugin-no-jp --save-dev

Usage

Add eslint-plugin-no-jp to the plugins section and add the rules to the rules section of your .eslintrc configuration file. (You can also omit the eslint-plugin- prefix.)

{
    "plugins": [
        "eslint-plugin-no-jp"
    ],
    "rules": [
        "no-jp/no-jp-identifier": 2,
        "no-jp/no-jp-comment": 2
    ]
}

📖 Rule Details

no-jp/no-jp-comment

Examples of 👎 incorrect code for this rule:

// 日本語のコメントを書いているとLintに怒られる
const greeting = () => {
    return "Hello"
}

Examples of 👍 correct code for this rule:

// Gotta stick to English
const greeting = () => {
    return "Hello"
}

no-jp/no-jp-identifiers

Examples of 👎 incorrect code for this rule:

const 日本語の関数名 = () => {
    return "Hello"
}

const 日本語の変数 = "Konnichiha"

Examples of 👍 correct code for this rule:

const stickToEnglish = () => {
    return "Hello"
}

const englishVar = "Hello World"

📜LICENCE

MIT

eslint-plugin-no-jp's People

Contributors

k-sato1995 avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.