eslint-plugin-sonarjs
Version:
157 lines (156 loc) • 5.91 kB
JavaScript
;
/*
* SonarQube JavaScript Plugin
* Copyright (C) SonarSource Sàrl
* mailto:info AT sonarsource DOT com
*
* You can redistribute and/or modify this program under the terms of
* the Sonar Source-Available License Version 1, as published by SonarSource Sàrl.
*
* 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/S8927/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 semver_1 = require("semver");
const generate_meta_js_1 = require("../helpers/generate-meta.js");
const dependencies_js_1 = require("../helpers/dependency-manifests/dependencies.js");
const ast_js_1 = require("../helpers/ast.js");
const validate_version_js_1 = require("../helpers/validate-version.js");
const meta = __importStar(require("./generated-meta.js"));
const messages = {
useNamedImports: 'Use named imports from "{{library}}" instead of a default import.',
useMethodImports: 'Import {{library}} methods from subpaths such as "{{example}}" to avoid importing more code than needed.',
};
const LIBRARIES = {
lodash: {
minimumVersion: '4.0.0',
kind: 'method',
example: 'lodash/map',
},
'lodash-es': {
minimumVersion: '4.0.0',
kind: 'named',
},
rxjs: {
minimumVersion: '7.2.0',
kind: 'named',
},
rambda: {
minimumVersion: '0.8.8',
kind: 'named',
},
validator: {
minimumVersion: '12.1.0',
kind: 'method',
example: 'validator/es/lib/isEmail',
},
};
exports.rule = {
meta: (0, generate_meta_js_1.generateMeta)(meta, { messages }),
create(context) {
const dependencies = (0, dependencies_js_1.getDependenciesSanitizePaths)(context);
return {
ImportDeclaration(node) {
if ((0, ast_js_1.isTypeOnlyImport)(node) ||
!hasDefaultImport(node) ||
hasNamespaceImport(node) ||
typeof node.source.value !== 'string') {
return;
}
const library = node.source.value;
const recommendation = getRecommendation(library);
if (!recommendation) {
return;
}
const version = dependencies.get(library);
if (!supportsRecommendation(version, recommendation.minimumVersion)) {
return;
}
if (recommendation.kind === 'method') {
context.report({
node,
messageId: 'useMethodImports',
data: {
library,
example: recommendation.example,
},
});
}
else {
context.report({
node,
messageId: 'useNamedImports',
data: {
library,
},
});
}
},
};
},
};
function getRecommendation(library) {
return LIBRARIES[library];
}
function hasDefaultImport(node) {
return node.specifiers.some(specifier => specifier.type === 'ImportDefaultSpecifier');
}
function hasNamespaceImport(node) {
return node.specifiers.some(specifier => specifier.type === 'ImportNamespaceSpecifier');
}
function supportsRecommendation(versionRange, minimumVersion) {
if (versionRange === undefined) {
return false;
}
const normalizedVersionRange = versionRange.trim();
if (isUnboundedVersionRange(normalizedVersionRange)) {
return true;
}
const minimumSupportedVersion = (0, validate_version_js_1.getProjectMinVersion)(normalizedVersionRange);
return minimumSupportedVersion !== null && (0, semver_1.gte)(minimumSupportedVersion, minimumVersion);
}
function isUnboundedVersionRange(versionRange) {
return (versionRange === '' ||
versionRange === '*' ||
['latest', 'x'].includes(versionRange.toLowerCase()));
}