eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
112 lines (111 loc) • 5.03 kB
JavaScript
;
/*
* SonarQube JavaScript Plugin
* Copyright (C) 2011-2025 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the Sonar Source-Available License for more details.
*
* You should have received a copy of the Sonar Source-Available License
* along with this program; if not, see https://sonarsource.com/license/ssal/
*/
// https://sonarsource.github.io/rspec/#/rspec/S3499/javascript
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.rule = void 0;
const index_js_1 = require("../helpers/index.js");
const meta = __importStar(require("./generated-meta.js"));
exports.rule = {
meta: (0, index_js_1.generateMeta)(meta),
create(context) {
function raiseIssue(node, begin, end, positionMessage) {
const properties = node.properties;
const secondaryLocations = [];
for (let i = begin; i < end; i++) {
const prop = properties[i];
if (prop.shorthand) {
secondaryLocations.push((0, index_js_1.toSecondaryLocation)(prop, `Move to ${positionMessage}`));
}
}
(0, index_js_1.report)(context, {
message: `Group all shorthand properties at ${positionMessage} of this object declaration.`,
loc: context.sourceCode.getFirstToken(node).loc,
}, secondaryLocations);
}
return {
ObjectExpression(node) {
const objectExpression = node;
const objectExpressionProperties = objectExpression.properties;
if (objectExpressionProperties.some(p => p.type !== 'Property')) {
return;
}
const isShorthandPropertyList = objectExpressionProperties.map(p => p.shorthand);
const shorthandPropertiesNumber = isShorthandPropertyList.filter(b => b).length;
const numberOfShorthandAtBeginning = getNumberOfTrueAtBeginning(isShorthandPropertyList);
const numberOfShorthandAtEnd = getNumberOfTrueAtBeginning([...isShorthandPropertyList].reverse());
const allAtBeginning = numberOfShorthandAtBeginning === shorthandPropertiesNumber;
const allAtEnd = numberOfShorthandAtEnd === shorthandPropertiesNumber;
const propertiesNumber = isShorthandPropertyList.length;
if (!allAtBeginning && numberOfShorthandAtBeginning > numberOfShorthandAtEnd) {
raiseIssue(objectExpression, numberOfShorthandAtBeginning, propertiesNumber, 'the beginning');
}
else if (!allAtEnd && numberOfShorthandAtEnd > numberOfShorthandAtBeginning) {
raiseIssue(objectExpression, 0, propertiesNumber - numberOfShorthandAtEnd, 'the end');
}
else if (!allAtBeginning && !allAtEnd) {
raiseIssue(objectExpression, 0, propertiesNumber, 'either the beginning or end');
}
},
};
},
};
function getNumberOfTrueAtBeginning(list) {
let numberOfTrueAtBeginning = 0;
for (const b of list) {
if (b) {
numberOfTrueAtBeginning++;
}
else {
break;
}
}
return numberOfTrueAtBeginning;
}