eslint-plugin-the-step-down-rule v0.1.0

eslint-plugin-the-step-down-rule

Enforces that functions follow a top-down call structure when calling a lower-level function.

This is basically just the opposite of the no-use-before-define rule, except it only applies to functions that are called outside the scope they are defined in.

Example

Good

const a = require('a');

function b() {
  a();
  d();
}

function c() {
  d();
}

const d = () => {};

b();

Bad

a();

function a() {
  b();
}

const b = () => {};

function c() {
  b();
}

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-the-step-down-rule:

$ npm install eslint-plugin-the-step-down-rule --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-the-step-down-rule globally.

Usage

Add the-step-down-rule to your .eslintrc configuration file.

{
    "plugins": [
        "the-step-down-rule"
    ],
    "rules": {
        "the-step-down-rule/the-step-down-rule": "warn" || "err"
    }
}

Additional Rules

Depending on your setup, you might need to disable the no-use-before-define rule.

"no-use-before-define": ["error", { "variables": false, "functions": false }]