1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192 |
- /**
- * @fileoverview Rule to check multiple var declarations per line
- * @author Alberto Rodríguez
- */
- "use strict";
- //------------------------------------------------------------------------------
- // Rule Definition
- //------------------------------------------------------------------------------
- /** @type {import('../shared/types').Rule} */
- module.exports = {
- meta: {
- type: "suggestion",
- docs: {
- description: "Require or disallow newlines around variable declarations",
- recommended: false,
- url: "https://eslint.org/docs/rules/one-var-declaration-per-line"
- },
- schema: [
- {
- enum: ["always", "initializations"]
- }
- ],
- fixable: "whitespace",
- messages: {
- expectVarOnNewline: "Expected variable declaration to be on a new line."
- }
- },
- create(context) {
- const always = context.options[0] === "always";
- //--------------------------------------------------------------------------
- // Helpers
- //--------------------------------------------------------------------------
- /**
- * Determine if provided keyword is a variant of for specifiers
- * @private
- * @param {string} keyword keyword to test
- * @returns {boolean} True if `keyword` is a variant of for specifier
- */
- function isForTypeSpecifier(keyword) {
- return keyword === "ForStatement" || keyword === "ForInStatement" || keyword === "ForOfStatement";
- }
- /**
- * Checks newlines around variable declarations.
- * @private
- * @param {ASTNode} node `VariableDeclaration` node to test
- * @returns {void}
- */
- function checkForNewLine(node) {
- if (isForTypeSpecifier(node.parent.type)) {
- return;
- }
- const declarations = node.declarations;
- let prev;
- declarations.forEach(current => {
- if (prev && prev.loc.end.line === current.loc.start.line) {
- if (always || prev.init || current.init) {
- context.report({
- node,
- messageId: "expectVarOnNewline",
- loc: current.loc,
- fix: fixer => fixer.insertTextBefore(current, "\n")
- });
- }
- }
- prev = current;
- });
- }
- //--------------------------------------------------------------------------
- // Public
- //--------------------------------------------------------------------------
- return {
- VariableDeclaration: checkForNewLine
- };
- }
- };
|