From ca396f860245590af76a3065b4243828ed24454e Mon Sep 17 00:00:00 2001 From: Ed S Date: Fri, 22 Oct 2021 21:36:54 +0100 Subject: [PATCH] Docs: Update eslint-docgen to 0.5.1 (#290) --- docs/rules/no-ajax-events.md | 4 ++- docs/rules/no-ajax.md | 6 +++-- docs/rules/no-and-self.md | 4 ++- docs/rules/no-animate-toggle.md | 4 ++- docs/rules/no-animate.md | 6 +++-- docs/rules/no-append-html.md | 2 ++ docs/rules/no-attr.md | 4 ++- docs/rules/no-bind.md | 6 +++-- docs/rules/no-box-model.md | 4 ++- docs/rules/no-browser.md | 4 ++- docs/rules/no-camel-case.md | 6 +++-- docs/rules/no-class-state.md | 2 ++ docs/rules/no-class.md | 4 ++- docs/rules/no-clone.md | 4 ++- docs/rules/no-closest.md | 4 ++- docs/rules/no-constructor-attributes.md | 2 ++ docs/rules/no-contains.md | 4 ++- docs/rules/no-context-prop.md | 4 ++- docs/rules/no-css.md | 4 ++- docs/rules/no-data.md | 4 ++- docs/rules/no-deferred.md | 4 ++- docs/rules/no-delegate.md | 6 +++-- docs/rules/no-die.md | 2 ++ docs/rules/no-each-collection.md | 4 ++- docs/rules/no-each-util.md | 4 ++- docs/rules/no-each.md | 2 ++ docs/rules/no-error-shorthand.md | 4 ++- docs/rules/no-error.md | 4 ++- docs/rules/no-escape-selector.md | 4 ++- docs/rules/no-event-shorthand.md | 8 +++--- docs/rules/no-extend.md | 4 ++- docs/rules/no-fade.md | 6 +++-- docs/rules/no-filter.md | 4 ++- docs/rules/no-find-collection.md | 4 ++- docs/rules/no-find-util.md | 4 ++- docs/rules/no-find.md | 2 ++ docs/rules/no-fx-interval.md | 4 ++- docs/rules/no-global-eval.md | 4 ++- docs/rules/no-global-selector.md | 2 ++ docs/rules/no-grep.md | 4 ++- docs/rules/no-has.md | 4 ++- docs/rules/no-hide.md | 2 ++ docs/rules/no-hold-ready.md | 6 +++-- docs/rules/no-html.md | 4 ++- docs/rules/no-in-array.md | 4 ++- docs/rules/no-is-array.md | 6 +++-- docs/rules/no-is-empty-object.md | 4 ++- docs/rules/no-is-function.md | 6 +++-- docs/rules/no-is-numeric.md | 6 +++-- docs/rules/no-is-plain-object.md | 4 ++- docs/rules/no-is-window.md | 6 +++-- docs/rules/no-is.md | 4 ++- docs/rules/no-jquery-constructor.md | 4 ++- docs/rules/no-live.md | 6 +++-- docs/rules/no-load-shorthand.md | 4 ++- docs/rules/no-load.md | 6 +++-- docs/rules/no-map-collection.md | 4 ++- docs/rules/no-map-util.md | 4 ++- docs/rules/no-map.md | 2 ++ docs/rules/no-merge.md | 4 ++- docs/rules/no-node-name.md | 6 +++-- docs/rules/no-noop.md | 4 ++- docs/rules/no-now.md | 6 +++-- docs/rules/no-on-ready.md | 4 ++- docs/rules/no-other-methods.md | 4 ++- docs/rules/no-other-utils.md | 4 ++- docs/rules/no-param.md | 4 ++- docs/rules/no-parent.md | 4 ++- docs/rules/no-parents.md | 4 ++- docs/rules/no-parse-html-literal.md | 2 ++ docs/rules/no-parse-html.md | 4 ++- docs/rules/no-parse-json.md | 6 +++-- docs/rules/no-parse-xml.md | 6 +++-- docs/rules/no-prop.md | 4 ++- docs/rules/no-proxy.md | 6 +++-- docs/rules/no-ready-shorthand.md | 6 +++-- docs/rules/no-ready.md | 2 ++ docs/rules/no-selector-prop.md | 4 ++- docs/rules/no-serialize.md | 4 ++- docs/rules/no-show.md | 2 ++ docs/rules/no-size.md | 6 +++-- docs/rules/no-sizzle.md | 4 ++- docs/rules/no-slide.md | 6 +++-- docs/rules/no-sub.md | 6 +++-- docs/rules/no-submit.md | 2 ++ docs/rules/no-support.md | 4 ++- docs/rules/no-text.md | 4 ++- docs/rules/no-toggle.md | 2 ++ docs/rules/no-trigger.md | 4 ++- docs/rules/no-trim.md | 6 +++-- docs/rules/no-type.md | 6 +++-- docs/rules/no-unbind.md | 2 ++ docs/rules/no-undelegate.md | 2 ++ docs/rules/no-unique.md | 6 +++-- docs/rules/no-unload-shorthand.md | 4 ++- docs/rules/no-val.md | 4 ++- docs/rules/no-visibility.md | 4 ++- docs/rules/no-when.md | 4 ++- docs/rules/no-wrap.md | 4 ++- docs/rules/variable-pattern.md | 4 ++- package-lock.json | 35 ++++++++++++++----------- package.json | 2 +- 102 files changed, 331 insertions(+), 128 deletions(-) diff --git a/docs/rules/no-ajax-events.md b/docs/rules/no-ajax-events.md index 802e1c5..5b08da6 100644 --- a/docs/rules/no-ajax-events.md +++ b/docs/rules/no-ajax-events.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-ajax-events Disallows global ajax events handlers: [`.ajaxComplete`](https://api.jquery.com/ajaxComplete/)/[`.ajaxError`](https://api.jquery.com/ajaxError/)/[`.ajaxSend`](https://api.jquery.com/ajaxSend/)/[`.ajaxStart`](https://api.jquery.com/ajaxStart/)/[`.ajaxStop`](https://api.jquery.com/ajaxStop/)/[`.ajaxSuccess`](https://api.jquery.com/ajaxSuccess/). Prefer local events. -⚙️ This rule is enabled in `plugin:no-jquery/slim`. +📋 This rule is enabled in `plugin:no-jquery/slim`. ## Rule details diff --git a/docs/rules/no-ajax.md b/docs/rules/no-ajax.md index 6e939c4..131ee4b 100644 --- a/docs/rules/no-ajax.md +++ b/docs/rules/no-ajax.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-ajax Disallows the [`$.ajax`](https://api.jquery.com/jQuery.ajax/)/[`$.get`](https://api.jquery.com/jQuery.get/)/[`$.getJSON`](https://api.jquery.com/jQuery.getJSON/)/[`$.getScript`](https://api.jquery.com/jQuery.getScript/)/[`$.post`](https://api.jquery.com/jQuery.post/) utilies. Prefer `Window.fetch`. -⚙️ This rule is enabled in `plugin:no-jquery/slim`. +📋 This rule is enabled in `plugin:no-jquery/slim`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-and-self.md b/docs/rules/no-and-self.md index 817a177..c96403a 100644 --- a/docs/rules/no-and-self.md +++ b/docs/rules/no-and-self.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-and-self Disallows the [`.andSelf`](https://api.jquery.com/andSelf/) method. Prefer `.addBack`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-1.8`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-1.8`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-animate-toggle.md b/docs/rules/no-animate-toggle.md index cc91028..3494a72 100644 --- a/docs/rules/no-animate-toggle.md +++ b/docs/rules/no-animate-toggle.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-animate-toggle Disallows the duration argument when using the [`.show`](https://api.jquery.com/show/), [`.hide`](https://api.jquery.com/hide/) & [`.toggle`](https://api.jquery.com/toggle/) methods. Prefer CSS transitions. -⚙️ This rule is enabled in `plugin:no-jquery/slim`. +📋 This rule is enabled in `plugin:no-jquery/slim`. ## Rule details diff --git a/docs/rules/no-animate.md b/docs/rules/no-animate.md index 154a942..5e2eb0d 100644 --- a/docs/rules/no-animate.md +++ b/docs/rules/no-animate.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-animate Disallows the [`.animate`](https://api.jquery.com/animate/) method. Use the `allowScroll` option to allow animations which are just used for scrolling. Prefer CSS transitions. -⚙️ This rule is enabled in `plugin:no-jquery/slim`. +📋 This rule is enabled in `plugin:no-jquery/slim`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-append-html.md b/docs/rules/no-append-html.md index 2131477..0efbe81 100644 --- a/docs/rules/no-append-html.md +++ b/docs/rules/no-append-html.md @@ -1,3 +1,5 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-append-html Disallows using [`.append`](https://api.jquery.com/append/)/[`.prepend`](https://api.jquery.com/prepend/)/[`.before`](https://api.jquery.com/before/)/[`.after`](https://api.jquery.com/after/)/[`.replaceWith`](https://api.jquery.com/replaceWith/) to inject HTML, in order to prevent possible XSS bugs. diff --git a/docs/rules/no-attr.md b/docs/rules/no-attr.md index 8930067..ca812f2 100644 --- a/docs/rules/no-attr.md +++ b/docs/rules/no-attr.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-attr Disallows the [`.attr`](https://api.jquery.com/attr/)/[`.removeAttr`](https://api.jquery.com/removeAttr/) methods and `$.attr`/[`$.removeAttr`](https://api.jquery.com/jQuery.removeAttr/) utilies. Prefer `Element#getAttribute`/`setAttribute`/`removeAttribute`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-bind.md b/docs/rules/no-bind.md index eea80c1..bbe278f 100644 --- a/docs/rules/no-bind.md +++ b/docs/rules/no-bind.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-bind Disallows the [`.bind`](https://api.jquery.com/bind/)/[`.unbind`](https://api.jquery.com/unbind/) methods. Prefer `.on`/`.off` or `EventTarget#addEventListener`/`removeEventListener`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.0`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.0`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-box-model.md b/docs/rules/no-box-model.md index 03b84b9..c99b2a2 100644 --- a/docs/rules/no-box-model.md +++ b/docs/rules/no-box-model.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-box-model Disallows the [`$.boxModel`](https://api.jquery.com/jQuery.boxModel/) property. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-1.3`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-1.3`. ## Rule details diff --git a/docs/rules/no-browser.md b/docs/rules/no-browser.md index 2d3fa46..322cbea 100644 --- a/docs/rules/no-browser.md +++ b/docs/rules/no-browser.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-browser Disallows the [`$.browser`](https://api.jquery.com/jQuery.browser/) property. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-1.3`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-1.3`. ## Rule details diff --git a/docs/rules/no-camel-case.md b/docs/rules/no-camel-case.md index df9e99a..4ec6fb7 100644 --- a/docs/rules/no-camel-case.md +++ b/docs/rules/no-camel-case.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-camel-case Disallows the `$.camelCase` utility. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.3`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.3`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-class-state.md b/docs/rules/no-class-state.md index 02f8994..abb1b93 100644 --- a/docs/rules/no-class-state.md +++ b/docs/rules/no-class-state.md @@ -1,3 +1,5 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-class-state Disallows [`.hasClass`](https://api.jquery.com/hasClass/) and [`.toggleClass`](https://api.jquery.com/toggleClass/) to discourage querying the DOM for state information. [`.toggleClass`](https://api.jquery.com/toggleClass/) may be used with a boolean argument as then it behaves like [`.addClass`](https://api.jquery.com/addClass/)/[`.removeClass`](https://api.jquery.com/removeClass/). diff --git a/docs/rules/no-class.md b/docs/rules/no-class.md index 96e22d6..fe7b0ef 100644 --- a/docs/rules/no-class.md +++ b/docs/rules/no-class.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-class Disallows the [`.addClass`](https://api.jquery.com/addClass/)/[`.hasClass`](https://api.jquery.com/hasClass/)/[`.removeClass`](https://api.jquery.com/removeClass/)/[`.toggleClass`](https://api.jquery.com/toggleClass/) methods. Prefer `Element#classList`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-clone.md b/docs/rules/no-clone.md index 9fd5ab6..a6a4e1a 100644 --- a/docs/rules/no-clone.md +++ b/docs/rules/no-clone.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-clone Disallows the [`.clone`](https://api.jquery.com/clone/) method and `$.clone` utility. Prefer `Node#cloneNode`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-closest.md b/docs/rules/no-closest.md index efd4102..b869479 100644 --- a/docs/rules/no-closest.md +++ b/docs/rules/no-closest.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-closest Disallows the [`.closest`](https://api.jquery.com/closest/) method. Prefer `Element#closest`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-constructor-attributes.md b/docs/rules/no-constructor-attributes.md index e0cbebc..040de56 100644 --- a/docs/rules/no-constructor-attributes.md +++ b/docs/rules/no-constructor-attributes.md @@ -1,3 +1,5 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-constructor-attributes Disallows passing attributes to the jQuery constructor. Prefer `.attr`. diff --git a/docs/rules/no-contains.md b/docs/rules/no-contains.md index aee7aab..4cf2a8d 100644 --- a/docs/rules/no-contains.md +++ b/docs/rules/no-contains.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-contains Disallows the [`$.contains`](https://api.jquery.com/jQuery.contains/) utility. Prefer `Node#contains`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-context-prop.md b/docs/rules/no-context-prop.md index c36e928..54e0a0c 100644 --- a/docs/rules/no-context-prop.md +++ b/docs/rules/no-context-prop.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-context-prop Disallows the [`.context`](https://api.jquery.com/context/) property. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-1.10`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-1.10`. ## Rule details diff --git a/docs/rules/no-css.md b/docs/rules/no-css.md index 7ec2562..81bbdc5 100644 --- a/docs/rules/no-css.md +++ b/docs/rules/no-css.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-css Disallows the [`.css`](https://api.jquery.com/css/) method and `$.css` utility. Prefer `Window#getComputedStyle`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-data.md b/docs/rules/no-data.md index 1d08fdd..8c9765a 100644 --- a/docs/rules/no-data.md +++ b/docs/rules/no-data.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-data Disallows the [`.data`](https://api.jquery.com/data/)/[`.removeData`](https://api.jquery.com/removeData/)/`.hasData` methods and [`$.data`](https://api.jquery.com/jQuery.data/)/[`$.removeData`](https://api.jquery.com/jQuery.removeData/)/[`$.hasData`](https://api.jquery.com/jQuery.hasData/) utilies. Prefer `WeakMap`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-deferred.md b/docs/rules/no-deferred.md index 19b1e13..08f1db6 100644 --- a/docs/rules/no-deferred.md +++ b/docs/rules/no-deferred.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-deferred Disallows [`$.Deferred`](https://api.jquery.com/jQuery.Deferred/) constructor. Prefer `Promise`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-delegate.md b/docs/rules/no-delegate.md index 1fb1c70..071e04d 100644 --- a/docs/rules/no-delegate.md +++ b/docs/rules/no-delegate.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-delegate Disallows the [`.delegate`](https://api.jquery.com/delegate/)/[`.undelegate`](https://api.jquery.com/undelegate/) methods. Prefer `.on`/`.off` or `EventTarget#addEventListener`/`removeEventListener`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.0`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.0`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-die.md b/docs/rules/no-die.md index 8da05b3..174a590 100644 --- a/docs/rules/no-die.md +++ b/docs/rules/no-die.md @@ -1,3 +1,5 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-die Disallows the [`.die`](https://api.jquery.com/die/) method. Prefer `.off`/`EventTarget#removeEventListener`. diff --git a/docs/rules/no-each-collection.md b/docs/rules/no-each-collection.md index a38799f..6cc9159 100644 --- a/docs/rules/no-each-collection.md +++ b/docs/rules/no-each-collection.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-each-collection Disallows the [`.each`](https://api.jquery.com/each/) method. Prefer `Array#forEach`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-each-util.md b/docs/rules/no-each-util.md index 60a14b1..700bbfd 100644 --- a/docs/rules/no-each-util.md +++ b/docs/rules/no-each-util.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-each-util Disallows the [`$.each`](https://api.jquery.com/jQuery.each/) utility. Prefer `Array#forEach`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-each.md b/docs/rules/no-each.md index 5a618d8..a16450b 100644 --- a/docs/rules/no-each.md +++ b/docs/rules/no-each.md @@ -1,3 +1,5 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-each Disallows the [`.each`](https://api.jquery.com/each/) method and [`$.each`](https://api.jquery.com/jQuery.each/) utility. Prefer `Array#forEach`. diff --git a/docs/rules/no-error-shorthand.md b/docs/rules/no-error-shorthand.md index 5f24ba8..19bd461 100644 --- a/docs/rules/no-error-shorthand.md +++ b/docs/rules/no-error-shorthand.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-error-shorthand Disallows the [`.error`](https://api.jquery.com/error/) method. Prefer `.on` or `.trigger`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-1.8`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-1.8`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-error.md b/docs/rules/no-error.md index d536212..157c0e6 100644 --- a/docs/rules/no-error.md +++ b/docs/rules/no-error.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-error Disallows the [`$.error`](https://api.jquery.com/jQuery.error/) utility. Prefer `throw`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-escape-selector.md b/docs/rules/no-escape-selector.md index ad75561..dd9836d 100644 --- a/docs/rules/no-escape-selector.md +++ b/docs/rules/no-escape-selector.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-escape-selector Disallows the [`$.escapeSelector`](https://api.jquery.com/jQuery.escapeSelector/) utility. Prefer `CSS.escape`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-event-shorthand.md b/docs/rules/no-event-shorthand.md index d112db2..048522b 100644 --- a/docs/rules/no-event-shorthand.md +++ b/docs/rules/no-event-shorthand.md @@ -1,12 +1,14 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-event-shorthand Disallows the [`.error`](https://api.jquery.com/error/)/[`.resize`](https://api.jquery.com/resize/)/[`.scroll`](https://api.jquery.com/scroll/)/[`.unload`](https://api.jquery.com/unload/)/[`.blur`](https://api.jquery.com/blur/)/[`.change`](https://api.jquery.com/change/)/[`.focus`](https://api.jquery.com/focus/)/[`.focusin`](https://api.jquery.com/focusin/)/[`.focusout`](https://api.jquery.com/focusout/)/[`.select`](https://api.jquery.com/select/)/[`.submit`](https://api.jquery.com/submit/)/[`.keydown`](https://api.jquery.com/keydown/)/[`.keypress`](https://api.jquery.com/keypress/)/[`.keyup`](https://api.jquery.com/keyup/)/[`.click`](https://api.jquery.com/click/)/[`.contextmenu`](https://api.jquery.com/contextmenu/)/[`.dblclick`](https://api.jquery.com/dblclick/)/[`.hover`](https://api.jquery.com/hover/)/[`.mousedown`](https://api.jquery.com/mousedown/)/[`.mouseenter`](https://api.jquery.com/mouseenter/)/[`.mouseleave`](https://api.jquery.com/mouseleave/)/[`.mousemove`](https://api.jquery.com/mousemove/)/[`.mouseout`](https://api.jquery.com/mouseout/)/[`.mouseover`](https://api.jquery.com/mouseover/)/[`.mouseup`](https://api.jquery.com/mouseup/)/[`.ajaxComplete`](https://api.jquery.com/ajaxComplete/)/[`.ajaxError`](https://api.jquery.com/ajaxError/)/[`.ajaxSend`](https://api.jquery.com/ajaxSend/)/[`.ajaxStart`](https://api.jquery.com/ajaxStart/)/[`.ajaxStop`](https://api.jquery.com/ajaxStop/)/[`.ajaxSuccess`](https://api.jquery.com/ajaxSuccess/) methods. Use the `allowAjaxEvents` option to allow `ajax*` methods. Prefer `.on` or `.trigger`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.5`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.5`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.3` with `[{"allowAjaxEvents":true}]` options. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.3` with `[{"allowAjaxEvents":true}]` options. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-extend.md b/docs/rules/no-extend.md index ecce56e..f66844d 100644 --- a/docs/rules/no-extend.md +++ b/docs/rules/no-extend.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-extend Disallows the [`$.extend`](https://api.jquery.com/jQuery.extend/) utility. Prefer `Object.assign` or the spread operator. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-fade.md b/docs/rules/no-fade.md index 4a02cdd..a7c03df 100644 --- a/docs/rules/no-fade.md +++ b/docs/rules/no-fade.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-fade Disallows the [`.fadeIn`](https://api.jquery.com/fadeIn/)/[`.fadeOut`](https://api.jquery.com/fadeOut/)/[`.fadeTo`](https://api.jquery.com/fadeTo/)/[`.fadeToggle`](https://api.jquery.com/fadeToggle/) methods. Prefer CSS transitions. -⚙️ This rule is enabled in `plugin:no-jquery/slim`. +📋 This rule is enabled in `plugin:no-jquery/slim`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-filter.md b/docs/rules/no-filter.md index 60cbe25..7ca80e5 100644 --- a/docs/rules/no-filter.md +++ b/docs/rules/no-filter.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-filter Disallows the [`.filter`](https://api.jquery.com/filter/) method and `$.filter` utility. Prefer `Array#filter`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-find-collection.md b/docs/rules/no-find-collection.md index ed89037..16ca879 100644 --- a/docs/rules/no-find-collection.md +++ b/docs/rules/no-find-collection.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-find-collection Disallows the [`.find`](https://api.jquery.com/find/) method. Prefer `Document#querySelectorAll`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-find-util.md b/docs/rules/no-find-util.md index fcfa2f5..5b448a9 100644 --- a/docs/rules/no-find-util.md +++ b/docs/rules/no-find-util.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-find-util Disallows the `$.find` utility. Prefer `Document#querySelectorAll`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-find.md b/docs/rules/no-find.md index 4ad6fc0..f52c6b7 100644 --- a/docs/rules/no-find.md +++ b/docs/rules/no-find.md @@ -1,3 +1,5 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-find Disallows the [`.find`](https://api.jquery.com/find/) method and `$.find` utility. Prefer `Document#querySelectorAll`. diff --git a/docs/rules/no-fx-interval.md b/docs/rules/no-fx-interval.md index 64dbb06..de67a67 100644 --- a/docs/rules/no-fx-interval.md +++ b/docs/rules/no-fx-interval.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-fx-interval Disallows [`$.fx.interval`](https://api.jquery.com/jQuery.fx.interval/). -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.0`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.0`. ## Rule details diff --git a/docs/rules/no-global-eval.md b/docs/rules/no-global-eval.md index 6eb6576..1337dfd 100644 --- a/docs/rules/no-global-eval.md +++ b/docs/rules/no-global-eval.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-global-eval Disallows the [`$.globalEval`](https://api.jquery.com/jQuery.globalEval/) utility. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-global-selector.md b/docs/rules/no-global-selector.md index 334ca3c..3373e02 100644 --- a/docs/rules/no-global-selector.md +++ b/docs/rules/no-global-selector.md @@ -1,3 +1,5 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-global-selector Disallows global selectors which search the whole document. Encourages users to keep references to DOM nodes in memory, instead of selecting them from the DOM each time. Use the `allowIds` option to allow single ID selectors. diff --git a/docs/rules/no-grep.md b/docs/rules/no-grep.md index e2af49e..4572def 100644 --- a/docs/rules/no-grep.md +++ b/docs/rules/no-grep.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-grep Disallows the [`$.grep`](https://api.jquery.com/jQuery.grep/) utility. Prefer `Array#filter`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-has.md b/docs/rules/no-has.md index 1e89ca2..ec4a7b5 100644 --- a/docs/rules/no-has.md +++ b/docs/rules/no-has.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-has Disallows the [`.has`](https://api.jquery.com/has/) method. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-hide.md b/docs/rules/no-hide.md index 02ba8a3..3b99a83 100644 --- a/docs/rules/no-hide.md +++ b/docs/rules/no-hide.md @@ -1,3 +1,5 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-hide Disallows the [`.hide`](https://api.jquery.com/hide/) method. diff --git a/docs/rules/no-hold-ready.md b/docs/rules/no-hold-ready.md index 29fbdf7..b323e01 100644 --- a/docs/rules/no-hold-ready.md +++ b/docs/rules/no-hold-ready.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-hold-ready Disallows the [`$.holdReady`](https://api.jquery.com/jQuery.holdReady/) utility. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.2`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.2`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-html.md b/docs/rules/no-html.md index 8a3b39d..ff427da 100644 --- a/docs/rules/no-html.md +++ b/docs/rules/no-html.md @@ -1,3 +1,5 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-html Disallows the [`.html`](https://api.jquery.com/html/) method. Prefer `Element#innerHTML`. @@ -7,7 +9,7 @@ Using this method only as a getter or a setter can be allowed using the `allowGe * `"get"` the method can only be used as a getter i.e. with no arguments * `"set"` the method can only be used as a setter i.e. with arguments -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-in-array.md b/docs/rules/no-in-array.md index 0aef00e..7eaa627 100644 --- a/docs/rules/no-in-array.md +++ b/docs/rules/no-in-array.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-in-array Disallows the [`$.inArray`](https://api.jquery.com/jQuery.inArray/) utility. Prefer `Array#indexOf`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-is-array.md b/docs/rules/no-is-array.md index 9fd660d..d3dc1cd 100644 --- a/docs/rules/no-is-array.md +++ b/docs/rules/no-is-array.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-is-array Disallows the [`$.isArray`](https://api.jquery.com/jQuery.isArray/) utility. Prefer `Array.isArray`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.2`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.2`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-is-empty-object.md b/docs/rules/no-is-empty-object.md index 0704009..627b38f 100644 --- a/docs/rules/no-is-empty-object.md +++ b/docs/rules/no-is-empty-object.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-is-empty-object Disallows the [`$.isEmptyObject`](https://api.jquery.com/jQuery.isEmptyObject/) utility. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-is-function.md b/docs/rules/no-is-function.md index 0c983e5..bee4955 100644 --- a/docs/rules/no-is-function.md +++ b/docs/rules/no-is-function.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-is-function Disallows the [`$.isFunction`](https://api.jquery.com/jQuery.isFunction/) utility. Prefer `typeof`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.3`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.3`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-is-numeric.md b/docs/rules/no-is-numeric.md index aa54cff..0f07ba5 100644 --- a/docs/rules/no-is-numeric.md +++ b/docs/rules/no-is-numeric.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-is-numeric Disallows the [`$.isNumeric`](https://api.jquery.com/jQuery.isNumeric/) utility. Prefer `typeof`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.3`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.3`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-is-plain-object.md b/docs/rules/no-is-plain-object.md index 4f6801c..ba1eb38 100644 --- a/docs/rules/no-is-plain-object.md +++ b/docs/rules/no-is-plain-object.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-is-plain-object Disallows the [`$.isPlainObject`](https://api.jquery.com/jQuery.isPlainObject/) utility. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-is-window.md b/docs/rules/no-is-window.md index 646a63a..bfbf234 100644 --- a/docs/rules/no-is-window.md +++ b/docs/rules/no-is-window.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-is-window Disallows the [`$.isWindow`](https://api.jquery.com/jQuery.isWindow/) utility. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.3`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.3`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-is.md b/docs/rules/no-is.md index 23e8e37..c66519e 100644 --- a/docs/rules/no-is.md +++ b/docs/rules/no-is.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-is Disallows the [`.is`](https://api.jquery.com/is/) method. Prefer `Element#matches`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-jquery-constructor.md b/docs/rules/no-jquery-constructor.md index b55b445..b4ae20c 100644 --- a/docs/rules/no-jquery-constructor.md +++ b/docs/rules/no-jquery-constructor.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-jquery-constructor Disallows the jQuery constructor `$()`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-live.md b/docs/rules/no-live.md index 1e45227..28174fc 100644 --- a/docs/rules/no-live.md +++ b/docs/rules/no-live.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-live Disallows the [`.live`](https://api.jquery.com/live/)/[`.die`](https://api.jquery.com/die/) methods. Prefer `.on`/`.off` or `EventTarget#addEventListener`/`removeEventListener`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-1.7`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-1.7`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-load-shorthand.md b/docs/rules/no-load-shorthand.md index e7658ad..bdc6335 100644 --- a/docs/rules/no-load-shorthand.md +++ b/docs/rules/no-load-shorthand.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-load-shorthand Disallows the [`.load`](https://api.jquery.com/load-event/) method when used as a shorthand for `.on( 'load', function )` or `.trigger( 'load' )`. Prefer `.on` or `.trigger`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-1.8`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-1.8`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-load.md b/docs/rules/no-load.md index ffcae61..1c5d665 100644 --- a/docs/rules/no-load.md +++ b/docs/rules/no-load.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-load Disallows the [`.load`](https://api.jquery.com/load/) method. Prefer `fetch`. -⚙️ This rule is enabled in `plugin:no-jquery/slim`. +📋 This rule is enabled in `plugin:no-jquery/slim`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-map-collection.md b/docs/rules/no-map-collection.md index d4053f7..6f09f26 100644 --- a/docs/rules/no-map-collection.md +++ b/docs/rules/no-map-collection.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-map-collection Disallows the [`.map`](https://api.jquery.com/map/) method. Prefer `Array#map`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-map-util.md b/docs/rules/no-map-util.md index 231cab5..c68d3f2 100644 --- a/docs/rules/no-map-util.md +++ b/docs/rules/no-map-util.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-map-util Disallows the [`$.map`](https://api.jquery.com/jQuery.map/) utility. Prefer `Array#map`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-map.md b/docs/rules/no-map.md index 8b29622..aae8d14 100644 --- a/docs/rules/no-map.md +++ b/docs/rules/no-map.md @@ -1,3 +1,5 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-map Disallows the [`.map`](https://api.jquery.com/map/) method and [`$.map`](https://api.jquery.com/jQuery.map/) utility. Prefer `Array#map`. diff --git a/docs/rules/no-merge.md b/docs/rules/no-merge.md index 9f69350..1d82694 100644 --- a/docs/rules/no-merge.md +++ b/docs/rules/no-merge.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-merge Disallows the [`$.merge`](https://api.jquery.com/jQuery.merge/) utility. Prefer `Array#concat`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-node-name.md b/docs/rules/no-node-name.md index f893e48..3fbe93d 100644 --- a/docs/rules/no-node-name.md +++ b/docs/rules/no-node-name.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-node-name Disallows the [`$.nodeName`](https://api.jquery.com/jQuery.nodeName/) utility. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.2`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.2`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-noop.md b/docs/rules/no-noop.md index 51bc9bb..6e1e562 100644 --- a/docs/rules/no-noop.md +++ b/docs/rules/no-noop.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-noop Disallows the [`$.noop`](https://api.jquery.com/jQuery.noop/) property. Prefer `function(){}`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-now.md b/docs/rules/no-now.md index 827fdbc..aaed196 100644 --- a/docs/rules/no-now.md +++ b/docs/rules/no-now.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-now Disallows the [`$.now`](https://api.jquery.com/jQuery.now/) utility. Prefer `Date.now`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.3`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.3`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-on-ready.md b/docs/rules/no-on-ready.md index 0e016db..2fb50e9 100644 --- a/docs/rules/no-on-ready.md +++ b/docs/rules/no-on-ready.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-on-ready Disallows using the ready event on the document. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-1.8`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-1.8`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-other-methods.md b/docs/rules/no-other-methods.md index 3e7877e..a148c8b 100644 --- a/docs/rules/no-other-methods.md +++ b/docs/rules/no-other-methods.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-other-methods Disallows all methods not covered by more specific rules. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-other-utils.md b/docs/rules/no-other-utils.md index 0326b7e..15a406a 100644 --- a/docs/rules/no-other-utils.md +++ b/docs/rules/no-other-utils.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-other-utils Disallows all utilities not covered by more specific rules. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-param.md b/docs/rules/no-param.md index 4495847..9d01a70 100644 --- a/docs/rules/no-param.md +++ b/docs/rules/no-param.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-param Disallows the [`$.param`](https://api.jquery.com/jQuery.param/) utility. Prefer `FormData` or `URLSearchParams`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-parent.md b/docs/rules/no-parent.md index d94765a..1bf4c8c 100644 --- a/docs/rules/no-parent.md +++ b/docs/rules/no-parent.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-parent Disallows the [`.parent`](https://api.jquery.com/parent/) method. Prefer `Node#parentElement`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-parents.md b/docs/rules/no-parents.md index 5a3c06f..3758891 100644 --- a/docs/rules/no-parents.md +++ b/docs/rules/no-parents.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-parents Disallows the [`.parents`](https://api.jquery.com/parents/) method. Prefer `Element#closest`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-parse-html-literal.md b/docs/rules/no-parse-html-literal.md index 42c9b6d..d41fa4a 100644 --- a/docs/rules/no-parse-html-literal.md +++ b/docs/rules/no-parse-html-literal.md @@ -1,3 +1,5 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-parse-html-literal Disallows parsing of HTML literal strings using either the jQuery method [`$()`](https://api.jquery.com/jquery/) or [`$.parseHTML`](https://api.jquery.com/jQuery.parseHTML/). Single tags are still allowed for creating new nodes as these don't tirgger the HTML parser. DOM build and manipulation methods should be used instead. diff --git a/docs/rules/no-parse-html.md b/docs/rules/no-parse-html.md index 2410160..c924f42 100644 --- a/docs/rules/no-parse-html.md +++ b/docs/rules/no-parse-html.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-parse-html Disallows the [`$.parseHTML`](https://api.jquery.com/jQuery.parseHTML/) utility. Prefer `DOMImplementation#createHTMLDocument`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-parse-json.md b/docs/rules/no-parse-json.md index 9a12039..3a668f2 100644 --- a/docs/rules/no-parse-json.md +++ b/docs/rules/no-parse-json.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-parse-json Disallows the [`$.parseJSON`](https://api.jquery.com/jQuery.parseJSON/) utility. Prefer `JSON.parse`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.0`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.0`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-parse-xml.md b/docs/rules/no-parse-xml.md index 514d18e..f48d2c4 100644 --- a/docs/rules/no-parse-xml.md +++ b/docs/rules/no-parse-xml.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-parse-xml Disallows the [`$.parseXML`](https://api.jquery.com/jQuery.parseXML/) utility. Prefer `DOMParser#parseFromString`. -⚙️ This rule is enabled in `plugin:no-jquery/slim`. +📋 This rule is enabled in `plugin:no-jquery/slim`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-prop.md b/docs/rules/no-prop.md index e4ceaf6..e5b413b 100644 --- a/docs/rules/no-prop.md +++ b/docs/rules/no-prop.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-prop Disallows the [`.prop`](https://api.jquery.com/prop/)/[`.removeProp`](https://api.jquery.com/removeProp/) methods and `$.prop`/[`$.removeProp`](https://api.jquery.com/jQuery.removeProp/) utilies. Prefer direct property access. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-proxy.md b/docs/rules/no-proxy.md index b08c70e..a2b1876 100644 --- a/docs/rules/no-proxy.md +++ b/docs/rules/no-proxy.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-proxy Disallows the [`$.proxy`](https://api.jquery.com/jQuery.proxy/) utility. Prefer `Function#bind`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.3`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.3`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-ready-shorthand.md b/docs/rules/no-ready-shorthand.md index 4eb6d3a..c0de11d 100644 --- a/docs/rules/no-ready-shorthand.md +++ b/docs/rules/no-ready-shorthand.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-ready-shorthand Disallows the [`.ready`](https://api.jquery.com/ready/) method. Prefer `$()`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.0`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.0`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-ready.md b/docs/rules/no-ready.md index 0b05bd9..fe5ddd0 100644 --- a/docs/rules/no-ready.md +++ b/docs/rules/no-ready.md @@ -1,3 +1,5 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-ready Disallows the document ready event, either `$( function() {} )` or `$( document ).ready()`. diff --git a/docs/rules/no-selector-prop.md b/docs/rules/no-selector-prop.md index 4233d99..e170429 100644 --- a/docs/rules/no-selector-prop.md +++ b/docs/rules/no-selector-prop.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-selector-prop Disallows the [`.selector`](https://api.jquery.com/selector/) property. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-1.7`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-1.7`. ## Rule details diff --git a/docs/rules/no-serialize.md b/docs/rules/no-serialize.md index 98e3876..9333ce9 100644 --- a/docs/rules/no-serialize.md +++ b/docs/rules/no-serialize.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-serialize Disallows the [`.serialize`](https://api.jquery.com/serialize/)/[`.serializeArray`](https://api.jquery.com/serializeArray/) methods. Prefer `FormData` or `URLSearchParams`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-show.md b/docs/rules/no-show.md index 2f1c640..26e0203 100644 --- a/docs/rules/no-show.md +++ b/docs/rules/no-show.md @@ -1,3 +1,5 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-show Disallows the [`.show`](https://api.jquery.com/show/) method. diff --git a/docs/rules/no-size.md b/docs/rules/no-size.md index c3373f5..e004cb3 100644 --- a/docs/rules/no-size.md +++ b/docs/rules/no-size.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-size Disallows the [`.size`](https://api.jquery.com/size/) method. Prefer `.length`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-1.8`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-1.8`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-sizzle.md b/docs/rules/no-sizzle.md index 41192a4..683e69f 100644 --- a/docs/rules/no-sizzle.md +++ b/docs/rules/no-sizzle.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-sizzle Disallows selector extensions provided by Sizzle. Use the `allowPositional` option to allow positional selectors. Use the `allowOther` option to allow all other selectors. These options are used in the `deprecated-3.4` ruleset as only positional selectors were deprecated in that version. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.4` with `[{"allowPositional":false,"allowOther":true}]` options. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.4` with `[{"allowPositional":false,"allowOther":true}]` options. ## Rule details diff --git a/docs/rules/no-slide.md b/docs/rules/no-slide.md index 00146a1..429008f 100644 --- a/docs/rules/no-slide.md +++ b/docs/rules/no-slide.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-slide Disallows the [`.slideDown`](https://api.jquery.com/slideDown/)/[`.slideToggle`](https://api.jquery.com/slideToggle/)/[`.slideUp`](https://api.jquery.com/slideUp/) methods. Prefer CSS transitions. -⚙️ This rule is enabled in `plugin:no-jquery/slim`. +📋 This rule is enabled in `plugin:no-jquery/slim`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-sub.md b/docs/rules/no-sub.md index 1ba2062..32142c7 100644 --- a/docs/rules/no-sub.md +++ b/docs/rules/no-sub.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-sub Disallows the [`$.sub`](https://api.jquery.com/jQuery.sub/) utility. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-1.7`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-1.7`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-submit.md b/docs/rules/no-submit.md index c889bab..61e280d 100644 --- a/docs/rules/no-submit.md +++ b/docs/rules/no-submit.md @@ -1,3 +1,5 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-submit Disallows the [`.submit`](https://api.jquery.com/submit/) method. Prefer `EventTarget#dispatchEvent` + `HTMLFormElement#submit`. diff --git a/docs/rules/no-support.md b/docs/rules/no-support.md index ebc927b..08a4511 100644 --- a/docs/rules/no-support.md +++ b/docs/rules/no-support.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-support Disallows the [`$.support`](https://api.jquery.com/jQuery.support/) property. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-1.9`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-1.9`. ## Rule details diff --git a/docs/rules/no-text.md b/docs/rules/no-text.md index 3d36547..9476fad 100644 --- a/docs/rules/no-text.md +++ b/docs/rules/no-text.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-text Disallows the [`.text`](https://api.jquery.com/text/) method and `$.text` utility. Prefer `Node#textContent`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-toggle.md b/docs/rules/no-toggle.md index 114d9d8..0e3bb09 100644 --- a/docs/rules/no-toggle.md +++ b/docs/rules/no-toggle.md @@ -1,3 +1,5 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-toggle Disallows the [`.toggle`](https://api.jquery.com/toggle/) method. diff --git a/docs/rules/no-trigger.md b/docs/rules/no-trigger.md index 3d22b55..7573697 100644 --- a/docs/rules/no-trigger.md +++ b/docs/rules/no-trigger.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-trigger Disallows the [`.trigger`](https://api.jquery.com/trigger/) method. Prefer `EventTarget#dispatchEvent`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-trim.md b/docs/rules/no-trim.md index 10a3c3c..25decc7 100644 --- a/docs/rules/no-trim.md +++ b/docs/rules/no-trim.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-trim Disallows the [`$.trim`](https://api.jquery.com/jQuery.trim/) utility. Prefer `String#trim`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.5`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.5`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-type.md b/docs/rules/no-type.md index fed8477..5800ae7 100644 --- a/docs/rules/no-type.md +++ b/docs/rules/no-type.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-type Disallows the [`$.type`](https://api.jquery.com/jQuery.type/) utility. Prefer `typeof`/`instanceof`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.3`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.3`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-unbind.md b/docs/rules/no-unbind.md index d2a680b..2388691 100644 --- a/docs/rules/no-unbind.md +++ b/docs/rules/no-unbind.md @@ -1,3 +1,5 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-unbind Disallows the [`.unbind`](https://api.jquery.com/unbind/) method. Prefer `.off`/`EventTarget#removeEventListener`. diff --git a/docs/rules/no-undelegate.md b/docs/rules/no-undelegate.md index 71f475c..229afd4 100644 --- a/docs/rules/no-undelegate.md +++ b/docs/rules/no-undelegate.md @@ -1,3 +1,5 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-undelegate Disallows the [`.undelegate`](https://api.jquery.com/undelegate/) method. Prefer `.off`/`EventTarget#removeEventListener`. diff --git a/docs/rules/no-unique.md b/docs/rules/no-unique.md index e03431a..64fe652 100644 --- a/docs/rules/no-unique.md +++ b/docs/rules/no-unique.md @@ -1,10 +1,12 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-unique Disallows the [`$.unique`](https://api.jquery.com/jQuery.unique/) utility. Prefer `$.uniqueSort`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-3.0`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-3.0`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-unload-shorthand.md b/docs/rules/no-unload-shorthand.md index 58e7f26..a105dd3 100644 --- a/docs/rules/no-unload-shorthand.md +++ b/docs/rules/no-unload-shorthand.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-unload-shorthand Disallows the [`.unload`](https://api.jquery.com/unload/) method. Prefer `.on` or `.trigger`. -⚙️ This rule is enabled in `plugin:no-jquery/deprecated-1.8`. +📋 This rule is enabled in `plugin:no-jquery/deprecated-1.8`. 🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. diff --git a/docs/rules/no-val.md b/docs/rules/no-val.md index f9058f7..81cdc23 100644 --- a/docs/rules/no-val.md +++ b/docs/rules/no-val.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-val Disallows the [`.val`](https://api.jquery.com/val/) method. Prefer `HTMLInputElement#value`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-visibility.md b/docs/rules/no-visibility.md index e21fbe2..85eeb2e 100644 --- a/docs/rules/no-visibility.md +++ b/docs/rules/no-visibility.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-visibility Disallows the [`.show`](https://api.jquery.com/show/)/[`.hide`](https://api.jquery.com/hide/)/[`.toggle`](https://api.jquery.com/toggle/) methods. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-when.md b/docs/rules/no-when.md index ace8e1b..f30fe1e 100644 --- a/docs/rules/no-when.md +++ b/docs/rules/no-when.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-when Disallows the [`$.when`](https://api.jquery.com/jQuery.when/) utility. Prefer `Promise.all`. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/no-wrap.md b/docs/rules/no-wrap.md index c13c2e6..42dabf4 100644 --- a/docs/rules/no-wrap.md +++ b/docs/rules/no-wrap.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # no-wrap Disallows the [`.wrap`](https://api.jquery.com/wrap/)/[`.wrapAll`](https://api.jquery.com/wrapAll/)/[`.wrapInner`](https://api.jquery.com/wrapInner/)/[`.unwrap`](https://api.jquery.com/unwrap/) methods. -⚙️ This rule is enabled in `plugin:no-jquery/all`. +📋 This rule is enabled in `plugin:no-jquery/all`. ## Rule details diff --git a/docs/rules/variable-pattern.md b/docs/rules/variable-pattern.md index cb741f3..7b55a84 100644 --- a/docs/rules/variable-pattern.md +++ b/docs/rules/variable-pattern.md @@ -1,8 +1,10 @@ +[//]: # (This file is generated by eslint-docgen. Do not edit it directly.) + # variable-pattern Disallows variable names which don't match `variablePattern` in settings (by default a `$`-prefix). -⚙️ This rule is enabled in `plugin:no-jquery/recommended`. +📋 This rule is enabled in `plugin:no-jquery/recommended`. ## Rule details diff --git a/package-lock.json b/package-lock.json index aa8157b..100fd70 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,7 +10,7 @@ "devDependencies": { "codecov": "^3.8.3", "eslint-config-wikimedia": "^0.20.0", - "eslint-docgen": "^0.4.5", + "eslint-docgen": "^0.5.1", "eslint-plugin-eslint-plugin": "^3.6.1", "eslint-plugin-self": "^1.2.1", "jquery": "3.6.0", @@ -837,15 +837,18 @@ "dev": true }, "node_modules/chalk": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.1.tgz", - "integrity": "sha512-diHzdDKxcU+bAsUboHLPEDQiw0qEe0qd7SYUn3HgcFlWgbDcfLGswOHYeGrHKzG9z6UYf01d9VFMfZxPM1xZSg==", + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", "dependencies": { "ansi-styles": "^4.1.0", "supports-color": "^7.1.0" }, "engines": { "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" } }, "node_modules/chokidar": { @@ -1339,12 +1342,12 @@ } }, "node_modules/eslint-docgen": { - "version": "0.4.5", - "resolved": "https://registry.npmjs.org/eslint-docgen/-/eslint-docgen-0.4.5.tgz", - "integrity": "sha512-V8sA/9xbdBjeYyr22PwY13E3xhJGW+qZmnMf1eWWaC9egz+wQPDlN9hP7zoyRCcP82o2ysPdXSKOnx04BZ6aqA==", + "version": "0.5.1", + "resolved": "https://registry.npmjs.org/eslint-docgen/-/eslint-docgen-0.5.1.tgz", + "integrity": "sha512-s6VLq/UF8v8bU80qEWCE5cn4eSBDh23ivDePN14DDOnlF6GvlTa3+DWeOhMs41Cppj4r53zYtSccPGstG7yGTg==", "dev": true, "dependencies": { - "chalk": "^4.1.0", + "chalk": "^4.1.2", "ejs": "^3.1.6", "eslint": ">=5.0.0", "import-fresh": "^3.3.0", @@ -1357,7 +1360,7 @@ "upath": "^2.0.1" }, "engines": { - "node": ">=10.0.0" + "node": ">=12.0.0" } }, "node_modules/eslint-plugin-compat": { @@ -4884,9 +4887,9 @@ "dev": true }, "chalk": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.1.tgz", - "integrity": "sha512-diHzdDKxcU+bAsUboHLPEDQiw0qEe0qd7SYUn3HgcFlWgbDcfLGswOHYeGrHKzG9z6UYf01d9VFMfZxPM1xZSg==", + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", "requires": { "ansi-styles": "^4.1.0", "supports-color": "^7.1.0" @@ -5285,12 +5288,12 @@ } }, "eslint-docgen": { - "version": "0.4.5", - "resolved": "https://registry.npmjs.org/eslint-docgen/-/eslint-docgen-0.4.5.tgz", - "integrity": "sha512-V8sA/9xbdBjeYyr22PwY13E3xhJGW+qZmnMf1eWWaC9egz+wQPDlN9hP7zoyRCcP82o2ysPdXSKOnx04BZ6aqA==", + "version": "0.5.1", + "resolved": "https://registry.npmjs.org/eslint-docgen/-/eslint-docgen-0.5.1.tgz", + "integrity": "sha512-s6VLq/UF8v8bU80qEWCE5cn4eSBDh23ivDePN14DDOnlF6GvlTa3+DWeOhMs41Cppj4r53zYtSccPGstG7yGTg==", "dev": true, "requires": { - "chalk": "^4.1.0", + "chalk": "^4.1.2", "ejs": "^3.1.6", "eslint": ">=5.0.0", "import-fresh": "^3.3.0", diff --git a/package.json b/package.json index 447b748..5050ee6 100644 --- a/package.json +++ b/package.json @@ -32,7 +32,7 @@ "devDependencies": { "codecov": "^3.8.3", "eslint-config-wikimedia": "^0.20.0", - "eslint-docgen": "^0.4.5", + "eslint-docgen": "^0.5.1", "eslint-plugin-eslint-plugin": "^3.6.1", "eslint-plugin-self": "^1.2.1", "jquery": "3.6.0",