summaryrefslogtreecommitdiffstats
path: root/docs/code-quality/lint/linters/eslint-plugin-mozilla/rules/no-addtask-setup.rst
blob: f26a869371f27726d71b06265475e72d4052883c (plain)
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
no-addtask-setup
================

Reject using ``add_task(async function setup() { ... })`` in favour of
``add_setup(async function() { ... })``.

Using semantically separate setup functions makes ``.only`` work correctly
and will allow for future improvements to setup/cleanup abstractions.

This option can be autofixed (``--fix``).

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

.. code-block:: js

    add_task(async function setup() { ... });
    add_task(function setup() { ... });
    add_task(function init() { ... });

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

.. code-block:: js

    add_setup(async function() { ... });
    add_setup(function() { ... });