README.md

Support Languages : English | 日本語

eslint-plugin-scd

This ESLint Plugin for introducing Specific Component Design ( SCD ). Currently applicable only to Functional Components.

install

$> npm install eslint-plugin-scd

or

$> yarn add eslint-plugin-scd

Usage

apply to eslint

// .eslintrc.js

module.exports = {
  extends: ["plugin:scd/recommended"],
  plugins: ["scd"],
  rules: {
    /* You can override the rules */
  },
};

Supported Rules

See below for the features and options of each rule.

Name	Description
nue-element-size	Determines the size of the Nue component
nue-not-use-hooks	Determine if Hooks are used in the Nue component
otem-element-size	Determines the size of the Otem component
otem-not-use-hooks	Determine if Hooks are used in the Otem component
pafe-conditions	Determine if Pafe component has more than 10 elements or if Hooks are used
page-must-have-main-tag	Determine if the Page component has a main tag.

Contribution

Do you have bugs, feature additions, questions, etc. in this repository? If so, please refer to this file and contribute!

MIT LICENSE

MIT