Sha256: d81c2a90d8737ed9ac3bf5d3bb1e9275f55aa6d11c4973e6db809e4a6bb9d7a0
Contents?: true
Size: 1.86 KB
Versions: 43
Compression:
Stored size: 1.86 KB
Contents
/**
* @fileoverview Rule to enforce description with the `Symbol` object
* @author Jarek Rencz
*/
"use strict";
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const astUtils = require("../util/ast-utils");
//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
module.exports = {
meta: {
docs: {
description: "require symbol descriptions",
category: "ECMAScript 6",
recommended: false,
url: "https://eslint.org/docs/rules/symbol-description"
},
schema: []
},
create(context) {
/**
* Reports if node does not conform the rule in case rule is set to
* report missing description
*
* @param {ASTNode} node - A CallExpression node to check.
* @returns {void}
*/
function checkArgument(node) {
if (node.arguments.length === 0) {
context.report({
node,
message: "Expected Symbol to have a description."
});
}
}
return {
"Program:exit"() {
const scope = context.getScope();
const variable = astUtils.getVariableByName(scope, "Symbol");
if (variable && variable.defs.length === 0) {
variable.references.forEach(reference => {
const node = reference.identifier;
if (astUtils.isCallee(node)) {
checkArgument(node.parent);
}
});
}
}
};
}
};
Version data entries
43 entries across 43 versions & 1 rubygems