Skip to content

Commit

Permalink
Docs: Update eslint-docgen to 0.5.1 (#290)
Browse files Browse the repository at this point in the history
  • Loading branch information
edg2s committed Oct 22, 2021
1 parent abca2a2 commit ca396f8
Show file tree
Hide file tree
Showing 102 changed files with 331 additions and 128 deletions.
4 changes: 3 additions & 1 deletion docs/rules/no-ajax-events.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
6 changes: 4 additions & 2 deletions docs/rules/no-ajax.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-and-self.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-animate-toggle.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
6 changes: 4 additions & 2 deletions docs/rules/no-animate.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions docs/rules/no-append-html.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-attr.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
6 changes: 4 additions & 2 deletions docs/rules/no-bind.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-box-model.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-browser.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
6 changes: 4 additions & 2 deletions docs/rules/no-camel-case.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions docs/rules/no-class-state.md
Original file line number Diff line number Diff line change
@@ -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/).
Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-class.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-clone.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-closest.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions docs/rules/no-constructor-attributes.md
Original file line number Diff line number Diff line change
@@ -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`.
Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-contains.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-context-prop.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-css.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-data.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-deferred.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
6 changes: 4 additions & 2 deletions docs/rules/no-delegate.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions docs/rules/no-die.md
Original file line number Diff line number Diff line change
@@ -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`.
Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-each-collection.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-each-util.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions docs/rules/no-each.md
Original file line number Diff line number Diff line change
@@ -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`.
Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-error-shorthand.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-error.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-escape-selector.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
8 changes: 5 additions & 3 deletions docs/rules/no-event-shorthand.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-extend.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
6 changes: 4 additions & 2 deletions docs/rules/no-fade.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 3 additions & 1 deletion docs/rules/no-filter.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Loading

0 comments on commit ca396f8

Please sign in to comment.