eslint-plugin-no-jquery

eslint-plugin-no-jquery

Disallow jQuery functions, with suggestions for native equivalents where possible.

Originally a fork of eslint-plugin-jquery.

Installation

You'll first need to install ESLint:

$ npm install eslint --save-dev

Next, install eslint-plugin-no-jquery:

$ npm install eslint-plugin-no-jquery --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-no-jquery globally.

Usage

Add no-jquery to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "extends": "plugin:no-jquery/deprecated",
  "plugins": [
    "no-jquery"
  ]
}

The pre-set profile plugin:no-jquery/deprecated includes all known deprecated and removed code, and is updated as new releases of jQuery come out. You can instead use profiles targetting specific versions of jQuery if you know the environment in which your code will operate. There are profiles for jQuery 3.4.x+ environments (deprecated-3.4), 3.0.x+ (deprecated-3.0), and several others for completeness. Deprecation profiles are cumulative, so include all the rules for jQuery versions below them.

Alternatively, you can pick out rules individually (see below).

Settings

The following global settings can be used under the "no-jquery" property to configure the linter:

• variablePattern - An array of aliases for the jQuery constructor. Defaults to [ "$", "jQuery" ]
• constructorAliases - Regular expression pattern for matching jQuery variables. Defaults to "^\\$."

{
  "settings": {
    "no-jquery": {
        "variablePattern": [ "$", "jQuery" ],
        "constructorAliases": "^\\$.|^element$"
    }
  },
  "plugins": [
    "no-jquery"
  ]

Rules

• no-jquery/no-ajax
• no-jquery/no-ajax-events
• no-jquery/no-and-self
• no-jquery/no-animate
• no-jquery/no-animate-toggle
• no-jquery/no-attr
• no-jquery/no-bind
• no-jquery/no-box-model
• no-jquery/no-browser
• no-jquery/no-class
• no-jquery/no-class-state
• no-jquery/no-clone
• no-jquery/no-closest
• no-jquery/no-constructor-attributes
• no-jquery/no-context-prop
• no-jquery/no-css
• no-jquery/no-data
• no-jquery/no-deferred
• no-jquery/no-delegate
• no-jquery/no-die
• no-jquery/no-each
• no-jquery/no-each-collection
• no-jquery/no-each-util
• no-jquery/no-error-shorthand
• no-jquery/no-event-shorthand
• no-jquery/no-extend
• no-jquery/no-fade
• no-jquery/no-filter
• no-jquery/no-find
• no-jquery/no-fx-interval
• no-jquery/no-global-eval
• no-jquery/no-grep
• no-jquery/no-has
• no-jquery/no-hide
• no-jquery/no-hold-ready
• no-jquery/no-html
• no-jquery/no-in-array
• no-jquery/no-is-array
• no-jquery/no-is-function
• no-jquery/no-is-numeric
• no-jquery/no-is-window
• no-jquery/no-is
• no-jquery/no-live
• no-jquery/no-load
• no-jquery/no-load-shorthand
• no-jquery/no-map
• no-jquery/no-map-collection
• no-jquery/no-map-util
• no-jquery/no-merge
• no-jquery/no-noop
• no-jquery/no-now
• no-jquery/no-on-ready
• no-jquery/no-param
• no-jquery/no-parent
• no-jquery/no-parents
• no-jquery/no-parse-html
• no-jquery/no-parse-html-literal
• no-jquery/no-parse-json
• no-jquery/no-prop
• no-jquery/no-proxy
• no-jquery/no-ready
• no-jquery/no-ready-shorthand
• no-jquery/no-global-selector
• no-jquery/no-selector-prop
• no-jquery/no-serialize
• no-jquery/no-show
• no-jquery/no-size
• no-jquery/no-sizzle
• no-jquery/no-slide
• no-jquery/no-sub
• no-jquery/no-submit
• no-jquery/no-support
• no-jquery/no-text
• no-jquery/no-toggle
• no-jquery/no-trigger
• no-jquery/no-trim
• no-jquery/no-type
• no-jquery/no-unbind
• no-jquery/no-undelegate
• no-jquery/no-unique
• no-jquery/no-unload-shorthand
• no-jquery/no-val
• no-jquery/no-when
• no-jquery/no-wrap

Development

npm install
npm test

To update documentation after modifying a rule or its tests, use

npm run doc

License

Distributed under the MIT license. See LICENSE for details.