123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119 |
- /**
- * @fileoverview Rule that warns when identifier names are shorter or longer
- * than the values provided in configuration.
- * @author Burak Yigit Kaya aka BYK
- */
-
- "use strict";
-
- //------------------------------------------------------------------------------
- // Rule Definition
- //------------------------------------------------------------------------------
-
- module.exports = {
- meta: {
- type: "suggestion",
-
- docs: {
- description: "enforce minimum and maximum identifier lengths",
- category: "Stylistic Issues",
- recommended: false,
- url: "https://eslint.org/docs/rules/id-length"
- },
-
- schema: [
- {
- type: "object",
- properties: {
- min: {
- type: "number"
- },
- max: {
- type: "number"
- },
- exceptions: {
- type: "array",
- uniqueItems: true,
- items: {
- type: "string"
- }
- },
- properties: {
- enum: ["always", "never"]
- }
- },
- additionalProperties: false
- }
- ]
- },
-
- create(context) {
- const options = context.options[0] || {};
- const minLength = typeof options.min !== "undefined" ? options.min : 2;
- const maxLength = typeof options.max !== "undefined" ? options.max : Infinity;
- const properties = options.properties !== "never";
- const exceptions = (options.exceptions ? options.exceptions : [])
- .reduce((obj, item) => {
- obj[item] = true;
-
- return obj;
- }, {});
-
- const SUPPORTED_EXPRESSIONS = {
- MemberExpression: properties && function(parent) {
- return !parent.computed && (
-
- // regular property assignment
- (parent.parent.left === parent && parent.parent.type === "AssignmentExpression" ||
-
- // or the last identifier in an ObjectPattern destructuring
- parent.parent.type === "Property" && parent.parent.value === parent &&
- parent.parent.parent.type === "ObjectPattern" && parent.parent.parent.parent.left === parent.parent.parent)
- );
- },
- AssignmentPattern(parent, node) {
- return parent.left === node;
- },
- VariableDeclarator(parent, node) {
- return parent.id === node;
- },
- Property: properties && function(parent, node) {
- return parent.key === node;
- },
- ImportDefaultSpecifier: true,
- RestElement: true,
- FunctionExpression: true,
- ArrowFunctionExpression: true,
- ClassDeclaration: true,
- FunctionDeclaration: true,
- MethodDefinition: true,
- CatchClause: true
- };
-
- return {
- Identifier(node) {
- const name = node.name;
- const parent = node.parent;
-
- const isShort = name.length < minLength;
- const isLong = name.length > maxLength;
-
- if (!(isShort || isLong) || exceptions[name]) {
- return; // Nothing to report
- }
-
- const isValidExpression = SUPPORTED_EXPRESSIONS[parent.type];
-
- if (isValidExpression && (isValidExpression === true || isValidExpression(parent, node))) {
- context.report({
- node,
- message: isShort
- ? "Identifier name '{{name}}' is too short (< {{min}})."
- : "Identifier name '{{name}}' is too long (> {{max}}).",
- data: { name, min: minLength, max: maxLength }
- });
- }
- }
- };
- }
- };
|