File: enforce-define.js

package info (click to toggle)
node-eslint-plugin-requirejs 4.0.0-7
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 916 kB
  • sloc: javascript: 4,677; perl: 48; makefile: 31; sh: 6
file content (78 lines) | stat: -rw-r--r-- 2,097 bytes parent folder | download
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/**
 * @file    Rule to disallow files that are not wrapped in a call to `define`
 * @author  Casey Visco <cvisco@gmail.com>
 */

"use strict";

const path = require("path");
const rjs = require("../utils/rjs");
const ast = require("../utils/ast");

const isDefineCall = rjs.isDefineCall;
const isExprStatement = ast.isExprStatement;
const basename = path.basename;

// -----------------------------------------------------------------------------
// Configuration
// -----------------------------------------------------------------------------

const docs = {
    description: "Disallow files that are not wrapped in a call to `define`",
    category: "Stylistic Choices",
    recommended: false,
    url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/enforce-define.md"
};

const schema = [
    {
        anyOf: [
            {
                type: "string"
            },
            {
                type: "array",
                uniqueItems: true,
                items: {
                    type: "string"
                }
            }
        ]
    }
];

const message = "File must be wrapped in a `define` call";

// -----------------------------------------------------------------------------
// Helpers
// -----------------------------------------------------------------------------

const includes = (list, item) => list.indexOf(item) !== -1;

const isDefineExpr = child =>
    isExprStatement(child) && isDefineCall(child.expression);

// -----------------------------------------------------------------------------
// Rule Definition
// -----------------------------------------------------------------------------

function create(context) {
    const ignoredFiles = context.options[0] || [];

    return {
        Program(node) {
            const filename = basename(context.getFilename());

            if (includes(ignoredFiles, filename)) return;

            if (!node.body.every(isDefineExpr)) {
                context.report(node, message);
            }
        }
    };
}

module.exports = {
    meta: { docs, schema },
    create
};