feat: add a global option for checking constructors, getters or setters and remove avoidExampleOnConstructors option.

BREAKING CHANGE:

Replaces the option `avoidExampleOnConstructors` for
the `require-example` rule by `checkConstructors`

Also makes build-call platform independent and ensures env-variables work an all platforms.

Author: brettz9

.README/rules/require-description.md

@@ -24,13 +24,16 @@ An options object may have any of the following properties:
 - `descriptionStyle` - Whether to accept implicit descriptions (`"body"`) or
     `@description` tags (`"tag"`) as satisfying the rule. Set to `"any"` to
     accept either style. Defaults to `"body"`.
+- `checkConstructors` - A value indicating whether `constructor`s should be checked. Defaults to `true`.
+- `checkGetters` - A value indicating whether getters should be checked. Defaults to `true`.
+- `checkSetters` - A value indicating whether getters should be checked. Defaults to `true`.
 
-|||
-|---|---|
-|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
-|Tags|`description` or jsdoc block|
-|Aliases|`desc`|
-|Options|`contexts`, `exemptedBy`, `descriptionStyle`|
-|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
+|          |                                                                                                               |
+| -------- | ------------------------------------------------------------------------------------------------------------- |
+| Context  | `ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled |
+| Tags     | `description` or jsdoc block                                                                                  |
+| Aliases  | `desc`                                                                                                        |
+| Options  | `contexts`, `exemptedBy`, `descriptionStyle`, `checkConstructors`, `checkGetters`, `checkSetters`             |
+| Settings | `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`                               |
 
 <!-- assertions requireDescription -->

.README/rules/require-example.md

@@ -17,19 +17,25 @@ block avoids the need for an `@example`. Defaults to an array with
 so be sure to add back `inheritdoc` if you wish its presence to cause
 exemption of the rule.
 
-##### `avoidExampleOnConstructors`
-
-Set to `true` to avoid the need for an example on a constructor (whether
-indicated as such by a jsdoc tag or by being within an ES6 `class`).
-Defaults to `false`.
-
 ##### `contexts`
 
 Set this to an array of strings representing the AST context
 where you wish the rule to be applied (e.g., `ClassDeclaration` for ES6 classes).
 Overrides the default contexts (see below). Set to `"any"` if you want
 the rule to apply to any jsdoc block throughout your files.
 
+##### `checkConstructors`
+
+A value indicating whether `constructor`s should be checked. Defaults to `true`.
+
+##### `checkGetters`
+
+A value indicating whether getters should be checked. Defaults to `false`.
+
+##### `checkSetters`
+
+A value indicating whether getters should be checked. Defaults to `false`.
+
 #### Fixer
 
 The fixer for `require-example` will add an empty `@example`, but it will still

.README/rules/require-param.md

@@ -22,12 +22,24 @@ contexts (see below). May be useful for adding such as
 `TSMethodSignature` in TypeScript or restricting the contexts
 which are checked.
 
-|||
-|---|---|
-|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
-|Tags|`param`|
-|Aliases|`arg`, `argument`|
-|Options|`contexts`, `exemptedBy`|
-|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
+##### `checkConstructors`
+
+A value indicating whether `constructor`s should be checked. Defaults to `true`.
+
+##### `checkGetters`
+
+A value indicating whether getters should be checked. Defaults to `false`.
+
+##### `checkSetters`
+
+A value indicating whether getters should be checked. Defaults to `false`.
+
+|          |                                                                                                               |
+| -------- | ------------------------------------------------------------------------------------------------------------- |
+| Context  | `ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled |
+| Tags     | `param`                                                                                                       |
+| Aliases  | `arg`, `argument`                                                                                             |
+| Options  | `contexts`, `exemptedBy`, `checkConstructors`, `checkGetters`, `checkSetters`                                 |
+| Settings | `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`                               |
 
 <!-- assertions requireParam -->

.README/rules/require-returns.md

@@ -6,6 +6,8 @@ Will also report if multiple `@returns` tags are present.
 
 #### Options
 
+- `checkConstructors` - A value indicating whether `constructor`s should
+  be checked for `@returns` tags. Defaults to `false`.
 - `checkGetters` - Boolean to determine whether getter methods should
   be checked for `@returns` tags. Defaults to `true`.
 - `exemptedBy` - Array of tags (e.g., `['type']`) whose presence on the document
@@ -40,12 +42,12 @@ Will also report if multiple `@returns` tags are present.
 'jsdoc/require-returns': ['error', {forceReturnsWithAsync: true}]
 ```
 
-|||
-|---|---|
-|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
-|Tags|`returns`|
-|Aliases|`return`|
-|Options|`checkGetters`, `contexts`, `exemptedBy`, `forceRequireReturn`, `forceReturnsWithAsync`|
-|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
+|          |                                                                                                               |
+| -------- | ------------------------------------------------------------------------------------------------------------- |
+| Context  | `ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled |
+| Tags     | `returns`                                                                                                     |
+| Aliases  | `return`                                                                                                      |
+| Options  | `checkConstructors`, `checkGetters`, `contexts`, `exemptedBy`, `forceRequireReturn`, `forceReturnsWithAsync`  |
+| Settings | `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`                               |
 
 <!-- assertions requireReturns -->