Skip to content

Commit

Permalink
feat(functional-parameters): allow overriding options based on where …
Browse files Browse the repository at this point in the history
…the function type is declared

fix #575
  • Loading branch information
RebeccaStevens committed Apr 22, 2024
1 parent ffaaa6b commit 4a927d8
Show file tree
Hide file tree
Showing 8 changed files with 423 additions and 83 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,9 @@ The [below section](#rules) gives details on which rules are enabled by each rul

### Currying

| Name | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | 💭 ||
| :----------------------------------------------------------- | :----------------------------- | :--------------------------- | :-- | :-- | :-- | :-- | :-- | :-- |
| [functional-parameters](docs/rules/functional-parameters.md) | Enforce functional parameters. | ☑️ ✅ 🔒 ![badge-currying][] | | | | | | |
| Name | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | 💭 ||
| :----------------------------------------------------------- | :----------------------------- | :--------------------------- | :-- | :---------------------------- | :-- | :-- | :-- | :-- |
| [functional-parameters](docs/rules/functional-parameters.md) | Enforce functional parameters. | ☑️ ✅ 🔒 ![badge-currying][] | | ![badge-disableTypeChecked][] | | | 💭 | |

### No Exceptions

Expand Down
61 changes: 60 additions & 1 deletion docs/rules/functional-parameters.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Enforce functional parameters (`functional/functional-parameters`)

💼 This rule is enabled in the following configs: `currying`, ☑️ `lite`, ✅ `recommended`, 🔒 `strict`.
💼🚫 This rule is enabled in the following configs: `currying`, ☑️ `lite`, ✅ `recommended`, 🔒 `strict`. This rule is _disabled_ in the `disableTypeChecked` config.

💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).

<!-- end auto-generated rule header -->

Disallow use of rest parameters, the `arguments` keyword and enforces that functions take at least 1 parameter.

Note: type information is only required when using the [overrides](#overrides) option.

## Rule Details

In functions, `arguments` is a special variable that is implicitly available.
Expand Down Expand Up @@ -67,6 +71,36 @@ type Options = {
};
ignoreIdentifierPattern?: string[] | string;
ignorePrefixSelector?: string[] | string;
overrides?: Array<{
match: Array<
| {
from: "file";
path?: string;
name?: string | string[];
pattern?: RegExp | RegExp[];
ignoreName?: string | string[];
ignorePattern?: RegExp | RegExp[];
}
| {
from: "lib";
name?: string | string[];
pattern?: RegExp | RegExp[];
ignoreName?: string | string[];
ignorePattern?: RegExp | RegExp[];
}
| {
from: "package";
package?: string;
name?: string | string[];
pattern?: RegExp | RegExp[];
ignoreName?: string | string[];
ignorePattern?: RegExp | RegExp[];
}
>;
options: Omit<Options, "overrides">;
inherit?: boolean;
disable: boolean;
}>;
};
```

Expand Down Expand Up @@ -196,3 +230,28 @@ const sum = [1, 2, 3].reduce((carry, current) => current, 0);

This option takes a RegExp string or an array of RegExp strings.
It allows for the ability to ignore violations based on a function's name.

### `overrides`

_Using this option requires type infomation._

Allows for applying overrides to the options based on where the function's type is defined.
This can be used to override the settings for types coming from 3rd party libraries.

Note: Only the first matching override will be used.

#### `overrides[n].specifiers`

A specifier, or an array of specifiers to match the function type against.

#### `overrides[n].options`

The options to use when a specifiers matches.

#### `overrides[n].inherit`

Inherit the root options? Default is `true`.

#### `overrides[n].disable`

If true, when a specifier matches, this rule will not be applied to the matching node.
171 changes: 101 additions & 70 deletions src/rules/functional-parameters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import { deepmerge } from "deepmerge-ts";
import {
type IgnoreIdentifierPatternOption,
type IgnorePrefixSelectorOption,
type OverridableOptions,
getCoreOptions,
ignoreIdentifierPatternOptionSchema,
ignorePrefixSelectorOptionSchema,
shouldIgnorePattern,
Expand All @@ -20,7 +22,9 @@ import {
type RuleResult,
createRuleUsingFunction,
} from "#eslint-plugin-functional/utils/rule";
import { overridableOptionsSchema } from "#eslint-plugin-functional/utils/schemas";
import {
getEnclosingFunction,
isArgument,
isGetter,
isIIFE,
Expand All @@ -45,77 +49,75 @@ export const fullName = `${ruleNameScope}/${name}`;
*/
type ParameterCountOptions = "atLeastOne" | "exactlyOne";

type CoreOptions = IgnoreIdentifierPatternOption &
IgnorePrefixSelectorOption & {
allowRestParameter: boolean;
allowArgumentsKeyword: boolean;
enforceParameterCount:
| ParameterCountOptions
| false
| {
count: ParameterCountOptions;
ignoreLambdaExpression: boolean;
ignoreIIFE: boolean;
ignoreGettersAndSetters: boolean;
};
};

/**
* The options this rule can take.
*/
type Options = [
IgnoreIdentifierPatternOption &
IgnorePrefixSelectorOption & {
allowRestParameter: boolean;
allowArgumentsKeyword: boolean;
enforceParameterCount:
| ParameterCountOptions
| false
| {
count: ParameterCountOptions;
ignoreLambdaExpression: boolean;
ignoreIIFE: boolean;
ignoreGettersAndSetters: boolean;
};
},
];
type Options = [OverridableOptions<CoreOptions>];

/**
* The schema for the rule options.
*/
const schema: JSONSchema4[] = [
const coreOptionsPropertiesSchema = deepmerge(
ignoreIdentifierPatternOptionSchema,
ignorePrefixSelectorOptionSchema,
{
type: "object",
properties: deepmerge(
ignoreIdentifierPatternOptionSchema,
ignorePrefixSelectorOptionSchema,
{
allowRestParameter: {
allowRestParameter: {
type: "boolean",
},
allowArgumentsKeyword: {
type: "boolean",
},
enforceParameterCount: {
oneOf: [
{
type: "boolean",
enum: [false],
},
allowArgumentsKeyword: {
type: "boolean",
{
type: "string",
enum: ["atLeastOne", "exactlyOne"],
},
enforceParameterCount: {
oneOf: [
{
type: "boolean",
enum: [false],
},
{
{
type: "object",
properties: {
count: {
type: "string",
enum: ["atLeastOne", "exactlyOne"],
},
{
type: "object",
properties: {
count: {
type: "string",
enum: ["atLeastOne", "exactlyOne"],
},
ignoreGettersAndSetters: {
type: "boolean",
},
ignoreLambdaExpression: {
type: "boolean",
},
ignoreIIFE: {
type: "boolean",
},
},
additionalProperties: false,
ignoreGettersAndSetters: {
type: "boolean",
},
ignoreLambdaExpression: {
type: "boolean",
},
],
ignoreIIFE: {
type: "boolean",
},
},
additionalProperties: false,
},
} satisfies JSONSchema4ObjectSchema["properties"],
),
additionalProperties: false,
],
},
},
) as NonNullable<JSONSchema4ObjectSchema["properties"]>;

/**
* The schema for the rule options.
*/
const schema: JSONSchema4[] = [
overridableOptionsSchema(coreOptionsPropertiesSchema),
];

/**
Expand Down Expand Up @@ -156,6 +158,7 @@ const meta: NamedCreateRuleCustomMeta<keyof typeof errorMessages, Options> = {
description: "Enforce functional parameters.",
recommended: "recommended",
recommendedSeverity: "error",
requiresTypeChecking: true,
},
messages: errorMessages,
schema,
Expand All @@ -165,7 +168,7 @@ const meta: NamedCreateRuleCustomMeta<keyof typeof errorMessages, Options> = {
* Get the rest parameter violations.
*/
function getRestParamViolations(
[{ allowRestParameter }]: Readonly<Options>,
{ allowRestParameter }: Readonly<CoreOptions>,
node: ESFunction,
): RuleResult<keyof typeof errorMessages, Options>["descriptors"] {
return !allowRestParameter &&
Expand All @@ -184,7 +187,7 @@ function getRestParamViolations(
* Get the parameter count violations.
*/
function getParamCountViolations(
[{ enforceParameterCount }]: Readonly<Options>,
{ enforceParameterCount }: Readonly<CoreOptions>,
node: ESFunction,
): RuleResult<keyof typeof errorMessages, Options>["descriptors"] {
if (
Expand Down Expand Up @@ -235,8 +238,20 @@ function checkFunction(
context: Readonly<RuleContext<keyof typeof errorMessages, Options>>,
options: Readonly<Options>,
): RuleResult<keyof typeof errorMessages, Options> {
const [optionsObject] = options;
const { ignoreIdentifierPattern } = optionsObject;
const optionsToUse = getCoreOptions<CoreOptions, Options>(
node,
context,
options,
);

if (optionsToUse === null) {
return {
context,
descriptors: [],
};
}

const { ignoreIdentifierPattern } = optionsToUse;

if (shouldIgnorePattern(node, context, ignoreIdentifierPattern)) {
return {
Expand All @@ -248,8 +263,8 @@ function checkFunction(
return {
context,
descriptors: [
...getRestParamViolations(options, node),
...getParamCountViolations(options, node),
...getRestParamViolations(optionsToUse, node),
...getParamCountViolations(optionsToUse, node),
],
};
}
Expand All @@ -262,8 +277,27 @@ function checkIdentifier(
context: Readonly<RuleContext<keyof typeof errorMessages, Options>>,
options: Readonly<Options>,
): RuleResult<keyof typeof errorMessages, Options> {
const [optionsObject] = options;
const { ignoreIdentifierPattern } = optionsObject;
if (node.name !== "arguments") {
return {
context,
descriptors: [],
};
}

const functionNode = getEnclosingFunction(node);
const optionsToUse =
functionNode === null
? options[0]
: getCoreOptions<CoreOptions, Options>(functionNode, context, options);

if (optionsToUse === null) {
return {
context,
descriptors: [],
};
}

const { ignoreIdentifierPattern } = optionsToUse;

if (shouldIgnorePattern(node, context, ignoreIdentifierPattern)) {
return {
Expand All @@ -272,15 +306,12 @@ function checkIdentifier(
};
}

const { allowArgumentsKeyword } = optionsObject;
const { allowArgumentsKeyword } = optionsToUse;

return {
context,
descriptors:
!allowArgumentsKeyword &&
node.name === "arguments" &&
!isPropertyName(node) &&
!isPropertyAccess(node)
!allowArgumentsKeyword && !isPropertyName(node) && !isPropertyAccess(node)
? [
{
node,
Expand Down
Loading

0 comments on commit 4a927d8

Please sign in to comment.