155 lines
16 KiB
JavaScript
155 lines
16 KiB
JavaScript
|
'use strict';var _docsUrl = require('../docsUrl');var _docsUrl2 = _interopRequireDefault(_docsUrl);
|
||
|
|
var _object = require('object.values');var _object2 = _interopRequireDefault(_object);
|
||
|
|
var _arrayPrototype = require('array.prototype.flat');var _arrayPrototype2 = _interopRequireDefault(_arrayPrototype);function _interopRequireDefault(obj) {return obj && obj.__esModule ? obj : { 'default': obj };}
|
||
|
|
|
||
|
|
var meta = {
|
||
|
|
type: 'suggestion',
|
||
|
|
docs: {
|
||
|
|
category: 'Style guide',
|
||
|
|
description: 'Prefer named exports to be grouped together in a single export declaration',
|
||
|
|
url: (0, _docsUrl2['default'])('group-exports') } };
|
||
|
|
|
||
|
|
|
||
|
|
/* eslint-disable max-len */
|
||
|
|
var errors = {
|
||
|
|
ExportNamedDeclaration: 'Multiple named export declarations; consolidate all named exports into a single export declaration',
|
||
|
|
AssignmentExpression: 'Multiple CommonJS exports; consolidate all exports into a single assignment to `module.exports`' };
|
||
|
|
|
||
|
|
/* eslint-enable max-len */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns an array with names of the properties in the accessor chain for MemberExpression nodes
|
||
|
|
*
|
||
|
|
* Example:
|
||
|
|
*
|
||
|
|
* `module.exports = {}` => ['module', 'exports']
|
||
|
|
* `module.exports.property = true` => ['module', 'exports', 'property']
|
||
|
|
*
|
||
|
|
* @param {Node} node AST Node (MemberExpression)
|
||
|
|
* @return {Array} Array with the property names in the chain
|
||
|
|
* @private
|
||
|
|
*/
|
||
|
|
function accessorChain(node) {
|
||
|
|
var chain = [];
|
||
|
|
|
||
|
|
do {
|
||
|
|
chain.unshift(node.property.name);
|
||
|
|
|
||
|
|
if (node.object.type === 'Identifier') {
|
||
|
|
chain.unshift(node.object.name);
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
node = node.object;
|
||
|
|
} while (node.type === 'MemberExpression');
|
||
|
|
|
||
|
|
return chain;
|
||
|
|
}
|
||
|
|
|
||
|
|
function create(context) {
|
||
|
|
var nodes = {
|
||
|
|
modules: {
|
||
|
|
set: new Set(),
|
||
|
|
sources: {} },
|
||
|
|
|
||
|
|
types: {
|
||
|
|
set: new Set(),
|
||
|
|
sources: {} },
|
||
|
|
|
||
|
|
commonjs: {
|
||
|
|
set: new Set() } };
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
return {
|
||
|
|
ExportNamedDeclaration: function () {function ExportNamedDeclaration(node) {
|
||
|
|
var target = node.exportKind === 'type' ? nodes.types : nodes.modules;
|
||
|
|
if (!node.source) {
|
||
|
|
target.set.add(node);
|
||
|
|
} else if (Array.isArray(target.sources[node.source.value])) {
|
||
|
|
target.sources[node.source.value].push(node);
|
||
|
|
} else {
|
||
|
|
target.sources[node.source.value] = [node];
|
||
|
|
}
|
||
|
|
}return ExportNamedDeclaration;}(),
|
||
|
|
|
||
|
|
AssignmentExpression: function () {function AssignmentExpression(node) {
|
||
|
|
if (node.left.type !== 'MemberExpression') {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
var chain = accessorChain(node.left);
|
||
|
|
|
||
|
|
// Assignments to module.exports
|
||
|
|
// Deeper assignments are ignored since they just modify what's already being exported
|
||
|
|
// (ie. module.exports.exported.prop = true is ignored)
|
||
|
|
if (chain[0] === 'module' && chain[1] === 'exports' && chain.length <= 3) {
|
||
|
|
nodes.commonjs.set.add(node);
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Assignments to exports (exports.* = *)
|
||
|
|
if (chain[0] === 'exports' && chain.length === 2) {
|
||
|
|
nodes.commonjs.set.add(node);
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
}return AssignmentExpression;}(),
|
||
|
|
|
||
|
|
'Program:exit': function () {function onExit() {
|
||
|
|
// Report multiple `export` declarations (ES2015 modules)
|
||
|
|
if (nodes.modules.set.size > 1) {
|
||
|
|
nodes.modules.set.forEach(function (node) {
|
||
|
|
context.report({
|
||
|
|
node: node,
|
||
|
|
message: errors[node.type] });
|
||
|
|
|
||
|
|
});
|
||
|
|
}
|
||
|
|
|
||
|
|
// Report multiple `aggregated exports` from the same module (ES2015 modules)
|
||
|
|
(0, _arrayPrototype2['default'])((0, _object2['default'])(nodes.modules.sources).
|
||
|
|
filter(function (nodesWithSource) {return Array.isArray(nodesWithSource) && nodesWithSource.length > 1;})).
|
||
|
|
forEach(function (node) {
|
||
|
|
context.report({
|
||
|
|
node: node,
|
||
|
|
message: errors[node.type] });
|
||
|
|
|
||
|
|
});
|
||
|
|
|
||
|
|
// Report multiple `export type` declarations (FLOW ES2015 modules)
|
||
|
|
if (nodes.types.set.size > 1) {
|
||
|
|
nodes.types.set.forEach(function (node) {
|
||
|
|
context.report({
|
||
|
|
node: node,
|
||
|
|
message: errors[node.type] });
|
||
|
|
|
||
|
|
});
|
||
|
|
}
|
||
|
|
|
||
|
|
// Report multiple `aggregated type exports` from the same module (FLOW ES2015 modules)
|
||
|
|
(0, _arrayPrototype2['default'])((0, _object2['default'])(nodes.types.sources).
|
||
|
|
filter(function (nodesWithSource) {return Array.isArray(nodesWithSource) && nodesWithSource.length > 1;})).
|
||
|
|
forEach(function (node) {
|
||
|
|
context.report({
|
||
|
|
node: node,
|
||
|
|
message: errors[node.type] });
|
||
|
|
|
||
|
|
});
|
||
|
|
|
||
|
|
// Report multiple `module.exports` assignments (CommonJS)
|
||
|
|
if (nodes.commonjs.set.size > 1) {
|
||
|
|
nodes.commonjs.set.forEach(function (node) {
|
||
|
|
context.report({
|
||
|
|
node: node,
|
||
|
|
message: errors[node.type] });
|
||
|
|
|
||
|
|
});
|
||
|
|
}
|
||
|
|
}return onExit;}() };
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
module.exports = {
|
||
|
|
meta: meta,
|
||
|
|
create: create };
|
||
|
|
//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9ydWxlcy9ncm91cC1leHBvcnRzLmpzIl0sIm5hbWVzIjpbIm1ldGEiLCJ0eXBlIiwiZG9jcyIsImNhdGVnb3J5IiwiZGVzY3JpcHRpb24iLCJ1cmwiLCJlcnJvcnMiLCJFeHBvcnROYW1lZERlY2xhcmF0aW9uIiwiQXNzaWdubWVudEV4cHJlc3Npb24iLCJhY2Nlc3NvckNoYWluIiwibm9kZSIsImNoYWluIiwidW5zaGlmdCIsInByb3BlcnR5IiwibmFtZSIsIm9iamVjdCIsImNyZWF0ZSIsImNvbnRleHQiLCJub2RlcyIsIm1vZHVsZXMiLCJzZXQiLCJTZXQiLCJzb3VyY2VzIiwidHlwZXMiLCJjb21tb25qcyIsInRhcmdldCIsImV4cG9ydEtpbmQiLCJzb3VyY2UiLCJhZGQiLCJBcnJheSIsImlzQXJyYXkiLCJ2YWx1ZSIsInB1c2giLCJsZWZ0IiwibGVuZ3RoIiwib25FeGl0Iiwic2l6ZSIsImZvckVhY2giLCJyZXBvcnQiLCJtZXNzYWdlIiwiZmlsdGVyIiwibm9kZXNXaXRoU291cmNlIiwibW9kdWxlIiwiZXhwb3J0cyJdLCJtYXBwaW5ncyI6ImFBQUEscUM7QUFDQSx1QztBQUNBLHNEOztBQUVBLElBQU1BLE9BQU87QUFDWEMsUUFBTSxZQURLO0FBRVhDLFFBQU07QUFDSkMsY0FBVSxhQUROO0FBRUpDLGlCQUFhLDRFQUZUO0FBR0pDLFNBQUssMEJBQVEsZUFBUixDQUhELEVBRkssRUFBYjs7O0FBUUE7QUFDQSxJQUFNQyxTQUFTO0FBQ2JDLDBCQUF3QixvR0FEWDtBQUViQyx3QkFBc0IsaUdBRlQsRUFBZjs7QUFJQTs7QUFFQTs7Ozs7Ozs7Ozs7O0FBWUEsU0FBU0MsYUFBVCxDQUF1QkMsSUFBdkIsRUFBNkI7QUFDM0IsTUFBTUMsUUFBUSxFQUFkOztBQUVBLEtBQUc7QUFDREEsVUFBTUMsT0FBTixDQUFjRixLQUFLRyxRQUFMLENBQWNDLElBQTVCOztBQUVBLFFBQUlKLEtBQUtLLE1BQUwsQ0FBWWQsSUFBWixLQUFxQixZQUF6QixFQUF1QztBQUNyQ1UsWUFBTUMsT0FBTixDQUFjRixLQUFLSyxNQUFMLENBQVlELElBQTFCO0FBQ0E7QUFDRDs7QUFFREosV0FBT0EsS0FBS0ssTUFBWjtBQUNELEdBVEQsUUFTU0wsS0FBS1QsSUFBTCxLQUFjLGtCQVR2Qjs7QUFXQSxTQUFPVSxLQUFQO0FBQ0Q7O0FBRUQsU0FBU0ssTUFBVCxDQUFnQkMsT0FBaEIsRUFBeUI7QUFDdkIsTUFBTUMsUUFBUTtBQUNaQyxhQUFTO0FBQ1BDLFdBQUssSUFBSUMsR0FBSixFQURFO0FBRVBDLGVBQVMsRUFGRixFQURHOztBQUtaQyxXQUFPO0FBQ0xILFdBQUssSUFBSUMsR0FBSixFQURBO0FBRUxDLGVBQVMsRUFGSixFQUxLOztBQVNaRSxjQUFVO0FBQ1JKLFdBQUssSUFBSUMsR0FBSixFQURHLEVBVEUsRUFBZDs7OztBQWNBLFNBQU87QUFDTGQsMEJBREssK0NBQ2tCRyxJQURsQixFQUN3QjtBQUMzQixZQUFNZSxTQUFTZixLQUFLZ0IsVUFBTCxLQUFvQixNQUFwQixHQUE2QlIsTUFBTUssS0FBbkMsR0FBMkNMLE1BQU1DLE9BQWhFO0FBQ0EsWUFBSSxDQUFDVCxLQUFLaUIsTUFBVixFQUFrQjtBQUNoQkYsaUJBQU9MLEdBQVAsQ0FBV1EsR0FBWCxDQUFlbEIsSUFBZjtBQUNELFNBRkQsTUFFTyxJQUFJbUIsTUFBTUMsT0FBTixDQUFjTCxPQUFPSCxPQUFQLENBQWVaLEtBQUtpQixNQUFMLENBQVlJLEtBQTNCLENBQWQsQ0FBSixFQUFzRDtBQUMzRE4saUJBQU9ILE9BQVAsQ0FBZVosS0FBS2lCLE1BQUwsQ0FBWUksS0FBM0IsRUFBa0NDLElBQWxDLENBQXVDdEIsSUFBdkM7QUFDRCxTQUZNLE1BRUE7QUFDTGUsaUJBQU9ILE9BQVAsQ0FBZVosS0FBS2lCLE1BQUwsQ0FBWUksS0FBM0IsSUFBb0MsQ0FBQ3JCLElBQUQsQ0FBcEM7QUFDRDtBQUNGLE9BVkk7O0FBWUxGLHdCQVpLLDZDQVlnQkUsSUFaaEIsRUFZc0I7QUFDekIsWUFBSUEsS0FBS3VCLElBQUwsQ0FBVWhDLElBQVYsS0FBbUIsa0JBQXZCLEVBQTJDO0FBQ3pDO0FBQ0Q7O0FBRUQsWUFBTVUsUUFBUUYsY0FBY0MsS0FBS3VCLElBQW5CLENBQWQ7O0FBRUE7QUFDQTtBQUNBO0FBQ0EsWUFBSXRCLE1BQU0sQ0FBTixNQUFhLFFBQWIsSUFBeUJBLE1BQU0sQ0FBTixNQUFhLFNBQXRDLElBQW1EQSxNQUFNdUIsTUFBTixJQUFnQixDQUF2RSxFQUEwRTtBQUN4RWhCLGdCQUFNTSxRQUFOLENBQWVKLEdBQWYsQ0FBbUJRLEdBQW5CLENBQXVCbEIsSUFBdkI7QUFDQTtBQUNEOztBQUVEO0FBQ0EsWUFBSUMsTUFBTSxDQUFOLE1BQWEsU0FBYixJQUEwQkEsTUFBTXVCLE1BQU4sS0FBaUIsQ0FBL0MsRUFBa0Q7QUFDaERoQixnQkFBTU0sUUFBTixDQUFlSixHQUFmLENBQW1CUSxHQUFuQixDQUF1QmxCLElBQXZCO0FBQ0E7QUFDRDtBQUNGLE9BaENJOztBQWtDTCxpQ0FBZ0IsU0FBU3lCLE1BQVQsR0FBa0I7QUFDaEM7QUFDQSxZQUFJakIsTUFBTUMsT0FBTixDQUFjQyxHQUFkLENBQWtCZ0IsSUFBbEIsR0FBeUIsQ0FBN0IsRUFBZ0M7QUFDOUJsQixnQkFBTUMsT0FBTixDQUFjQyxHQUFkLENBQWtCaUIsT0FBbEIsQ0FBMEIsVUFBQzNCLElBQUQsRUFBVTtBQUNsQ08sb0JBQVFxQixNQUFSLENBQWU7QUFDYjVCLHdCQURhO0FBRWI2Qix1QkFBU2pDLE9BQU9JLEtBQUtULElBQVosQ0FGSSxFQUFmOztBQUlELFdBTEQ7QUFNRDs7QUFFRDtBQUNBLHlDQUFLLHlCQUFPaUIsTUFBTUMsT0FBTixDQUFjRyxPQUFyQjtBQUNGa0IsY0FERSxDQUNLLFVBQUNDLGVBQUQsVUFBcUJaLE1BQU1DLE9BQU4sQ0FBY1csZUFBZCxLQUFrQ0EsZ0JBQWdCUCxNQUFoQixHQUF5QixDQUFoRixFQURMLENBQUw7QUFFR0csZUFGSCxDQUVXLFVBQUMzQixJQUFELEVBQVU7QUFDakJPLGtCQUFRcUIsTUFBUixDQUFlO0FBQ2I1QixzQkFEYTtBQUViNkIscUJBQVNqQyxPQUFPSSxLQUFLVCxJQUFaLENBRkksRUFBZjs7QUFJRCxTQVBIOztBQVNBO0FBQ0EsWUFBSWlCLE1BQU1LLEtBQU4sQ0FBWUgsR0FBWixDQUFnQmdCLElBQWhCLEdBQXVCLENBQTNCLEVBQThCO0FBQzVCbEIsZ0JBQU1LLEtBQU4sQ0FBWUgsR0FBWixDQUFnQmlCLE9BQWhCLENBQXdCLFVBQUMzQixJQUFELEVBQVU7QUFDaENPLG9CQUFRcUIsTUFBUixDQUFlO0FBQ2I1Qix3QkFEYTtBQUViNkIsdUJBQVNqQyxPQUFPSSxLQUFLVCxJQUFaLENBRkksRUFBZjs7QUFJRCxXQUxEO0FBTUQ7O0FBRUQ7QUFDQSx5Q0FBSyx5QkFBT2lCLE1
|