File: prefer-object-rule.md

package info (click to toggle)
node-eslint-plugin-eslint-plugin 2.3.0%2B~0.3.0-6
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 652 kB
  • sloc: javascript: 5,372; makefile: 34; sh: 1
file content (49 lines) | stat: -rw-r--r-- 1,126 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# Disallow rule exports where the export is a function. (prefer-object-rule)

(fixable) The `--fix` option on the [command line](../user-guide/command-line-interface#fix) automatically fixes problems reported by this rule.

## Rule Details

The rule reports an error if it encounters a rule that's defined using the old style of just a `create` function.

Examples of **incorrect** code for this rule:

```js
/* eslint eslint-plugin/prefer-object-rule: error */

module.exports = function (context) {
  return { Program() { context.report() } };
};

module.exports = function create(context) {
  return { Program() { context.report() } };
};

module.exports = (context) => {
  return { Program() { context.report() } };
};
```

Examples of **correct** code for this rule:

```js
/* eslint eslint-plugin/prefer-object-rule: error */

module.exports = {
  create(context) {
    return { Program() { context.report() } };
  },
};

module.exports = {
  create(context) {
    return { Program() { context.report() } };
  },
};

module.exports = {
  create: (context) => {
    return { Program() { context.report() } };
  },
};
```