@bigbinary/eslint-plugin-neeto

eslint-plugin-neeto

An ESLint plugin for enforcing common front-end best practices specifically for neeto.

Usage

Install the plugin from npm:

yarn add -D "@bigbinary/eslint-plugin-neeto@latest"

In your .eslintrc.js file, add neeto in the plugins list and add the configuration 'recommended' in extends with prefix as 'plugin:'.

module.exports = {
  // ...other configurations
  plugins: [
    // ...other plugins
    "@bigbinary/neeto",
  ],
  extends: [
    "plugin:@bigbinary/neeto/recommended",
    // ...other plugins/extensions
  ],
};

Optionally, if you don't need all the recommended rules, follow this approach:

module.exports = {
  // ...other configurations
  plugins: [
    // ...other plugins
    "@bigbinary/neeto",
  ],
  rules: {
    "@bigbinary/neeto/ramda-tips": "warn",
    // ...other rules
  },
};

Exported rules

• no-unnecessary-classnames
• no-snake-case-destructuring-for-use-query-params-and-get-query-params
• no-local-storage
• no-lowercase-on-translation
• use-use-query-client-hook
• use-early-return
• use-classnames-for-dynamic-classes
• use-use-mutation-with-invalidation-hook
• no-withT-for-smart-components
• no-large-functions-inside-jsx
• use-standard-date-time-formats
• no-dumb-components-with-use-translation
• no-unnecessary-if-condition
• api-connector-name-should-match-filename
• api-connector-should-use-default-export
• combine-multiple-independent-awaits
• consistent-button-link-anchor
• ensure-compact-objects
• ensure-formik-eager-validation
• ensure-zustand-stores-are-type-annotated
• files-inside-react-query-folder-should-end-with-api
• file-name-and-export-name-standards
• hard-coded-strings-should-be-localized
• minimize-zustand-store-access-scope
• neetocommons-tips
• no-axios-import-outside-apis
• no-blacklisted-imports
• no-conditional-overlays
• no-deprecated-imports-from-zustand
• no-dangling-constants
• no-excess-function-arguments
• no-globalProps-destructure
• no-globalProps-reassignment
• no-missing-localization
• no-multiple-components-in-a-file
• no-multiple-translation-functions-under-same-parent
• no-namespace-specifier-import-for-ramda
• no-redundant-jsx-expression
• no-redundant-string-templates
• no-routes-destructure-and-reassignment
• no-translation-functions-in-string-interpolation
• prefix-neeto-ui-import-alias
• ramda-tips
• routes-should-be-declared-and-default-exported
• routes-should-match-object-path
• use-array-methods
• use-axios-config-for-passing-query-parameters
• use-camel-case-or-pascal-case-for-function-names
• use-common-constants
• use-common-routes
• use-components-children-prop-in-trans
• use-create-subscription-util-function
• use-i18next-plurals
• use-inline-svg-for-render
• use-neeto-in-strings
• use-neetoui-classes
• use-permissions-prop-in-private-route
• use-pluralize-package
• use-react-query-for-managing-remote-data
• use-snake-case-for-api-connector-filename
• use-translation-hook-in-components
• use-trans-components-and-values-props
• use-webpack-alias
• use-zustand-for-global-state-management
• webpack-aliases-and-jsconfig-paths-should-be-in-sync
• zustand-recommend-comparator-function-usage
• zustand-use-prop-to-pick-single-item
• use-zustand-pick-transformer
• props-inside-spread-attributes-should-be-sorted
• merge-spread-attributes
• props-with-different-key-value-should-be-outside-spread-attribute
• no-repetition-in-prop-key-value-names
• use-functions-and-hooks-from-neeto-commons-frontend.md
• zustand-use-with-immutable-actions-wrapper-inside-create
• add-required-peer-dependencies
• move-spread-attributes-to-top-position
• prefer-function-reference.md
• jsx-prefer-guard-clause.md
• use-show-thumbs-up-toastr.md

Other references

• Development instructions
• Creating new rules
• Running test
• Building and releasing