Permalink
Cannot retrieve contributors at this time
73 lines (59 sloc)
2.04 KB
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
codeql-action/node_modules/eslint/lib/rules/symbol-description.js
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* @fileoverview Rule to enforce description with the `Symbol` object | |
* @author Jarek Rencz | |
*/ | |
"use strict"; | |
//------------------------------------------------------------------------------ | |
// Requirements | |
//------------------------------------------------------------------------------ | |
const astUtils = require("./utils/ast-utils"); | |
//------------------------------------------------------------------------------ | |
// Rule Definition | |
//------------------------------------------------------------------------------ | |
/** @type {import('../shared/types').Rule} */ | |
module.exports = { | |
meta: { | |
type: "suggestion", | |
docs: { | |
description: "Require symbol descriptions", | |
recommended: false, | |
url: "https://eslint.org/docs/latest/rules/symbol-description" | |
}, | |
fixable: null, | |
schema: [], | |
messages: { | |
expected: "Expected Symbol to have a description." | |
} | |
}, | |
create(context) { | |
const sourceCode = context.sourceCode; | |
/** | |
* 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, | |
messageId: "expected" | |
}); | |
} | |
} | |
return { | |
"Program:exit"(node) { | |
const scope = sourceCode.getScope(node); | |
const variable = astUtils.getVariableByName(scope, "Symbol"); | |
if (variable && variable.defs.length === 0) { | |
variable.references.forEach(reference => { | |
const idNode = reference.identifier; | |
if (astUtils.isCallee(idNode)) { | |
checkArgument(idNode.parent); | |
} | |
}); | |
} | |
} | |
}; | |
} | |
}; |