189 lines
19 KiB
JavaScript
189 lines
19 KiB
JavaScript
|
'use strict';
|
||
|
|
||
|
var _path = require('path');
|
||
|
|
||
|
var _path2 = _interopRequireDefault(_path);
|
||
|
|
||
|
var _resolve = require('eslint-module-utils/resolve');
|
||
|
|
||
|
var _resolve2 = _interopRequireDefault(_resolve);
|
||
|
|
||
|
var _importType = require('../core/importType');
|
||
|
|
||
|
var _docsUrl = require('../docsUrl');
|
||
|
|
||
|
var _docsUrl2 = _interopRequireDefault(_docsUrl);
|
||
|
|
||
|
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
||
|
|
||
|
const enumValues = { enum: ['always', 'ignorePackages', 'never'] };
|
||
|
const patternProperties = {
|
||
|
type: 'object',
|
||
|
patternProperties: { '.*': enumValues }
|
||
|
};
|
||
|
const properties = {
|
||
|
type: 'object',
|
||
|
properties: {
|
||
|
'pattern': patternProperties,
|
||
|
'ignorePackages': { type: 'boolean' }
|
||
|
}
|
||
|
};
|
||
|
|
||
|
function buildProperties(context) {
|
||
|
|
||
|
const result = {
|
||
|
defaultConfig: 'never',
|
||
|
pattern: {},
|
||
|
ignorePackages: false
|
||
|
};
|
||
|
|
||
|
context.options.forEach(obj => {
|
||
|
|
||
|
// If this is a string, set defaultConfig to its value
|
||
|
if (typeof obj === 'string') {
|
||
|
result.defaultConfig = obj;
|
||
|
return;
|
||
|
}
|
||
|
|
||
|
// If this is not the new structure, transfer all props to result.pattern
|
||
|
if (obj.pattern === undefined && obj.ignorePackages === undefined) {
|
||
|
Object.assign(result.pattern, obj);
|
||
|
return;
|
||
|
}
|
||
|
|
||
|
// If pattern is provided, transfer all props
|
||
|
if (obj.pattern !== undefined) {
|
||
|
Object.assign(result.pattern, obj.pattern);
|
||
|
}
|
||
|
|
||
|
// If ignorePackages is provided, transfer it to result
|
||
|
if (obj.ignorePackages !== undefined) {
|
||
|
result.ignorePackages = obj.ignorePackages;
|
||
|
}
|
||
|
});
|
||
|
|
||
|
if (result.defaultConfig === 'ignorePackages') {
|
||
|
result.defaultConfig = 'always';
|
||
|
result.ignorePackages = true;
|
||
|
}
|
||
|
|
||
|
return result;
|
||
|
}
|
||
|
|
||
|
module.exports = {
|
||
|
meta: {
|
||
|
type: 'suggestion',
|
||
|
docs: {
|
||
|
url: (0, _docsUrl2.default)('extensions')
|
||
|
},
|
||
|
|
||
|
schema: {
|
||
|
anyOf: [{
|
||
|
type: 'array',
|
||
|
items: [enumValues],
|
||
|
additionalItems: false
|
||
|
}, {
|
||
|
type: 'array',
|
||
|
items: [enumValues, properties],
|
||
|
additionalItems: false
|
||
|
}, {
|
||
|
type: 'array',
|
||
|
items: [properties],
|
||
|
additionalItems: false
|
||
|
}, {
|
||
|
type: 'array',
|
||
|
items: [patternProperties],
|
||
|
additionalItems: false
|
||
|
}, {
|
||
|
type: 'array',
|
||
|
items: [enumValues, patternProperties],
|
||
|
additionalItems: false
|
||
|
}]
|
||
|
}
|
||
|
},
|
||
|
|
||
|
create: function (context) {
|
||
|
|
||
|
const props = buildProperties(context);
|
||
|
|
||
|
function getModifier(extension) {
|
||
|
return props.pattern[extension] || props.defaultConfig;
|
||
|
}
|
||
|
|
||
|
function isUseOfExtensionRequired(extension, isPackage) {
|
||
|
return getModifier(extension) === 'always' && (!props.ignorePackages || !isPackage);
|
||
|
}
|
||
|
|
||
|
function isUseOfExtensionForbidden(extension) {
|
||
|
return getModifier(extension) === 'never';
|
||
|
}
|
||
|
|
||
|
function isResolvableWithoutExtension(file) {
|
||
|
const extension = _path2.default.extname(file);
|
||
|
const fileWithoutExtension = file.slice(0, -extension.length);
|
||
|
const resolvedFileWithoutExtension = (0, _resolve2.default)(fileWithoutExtension, context);
|
||
|
|
||
|
return resolvedFileWithoutExtension === (0, _resolve2.default)(file, context);
|
||
|
}
|
||
|
|
||
|
function isExternalRootModule(file) {
|
||
|
const slashCount = file.split('/').length - 1;
|
||
|
|
||
|
if ((0, _importType.isScopedModule)(file) && slashCount <= 1) return true;
|
||
|
if ((0, _importType.isExternalModule)(file, context, (0, _resolve2.default)(file, context)) && !slashCount) return true;
|
||
|
return false;
|
||
|
}
|
||
|
|
||
|
function checkFileExtension(node) {
|
||
|
const source = node.source;
|
||
|
|
||
|
// bail if the declaration doesn't have a source, e.g. "export { foo };"
|
||
|
|
||
|
if (!source) return;
|
||
|
|
||
|
const importPathWithQueryString = source.value;
|
||
|
|
||
|
// don't enforce anything on builtins
|
||
|
if ((0, _importType.isBuiltIn)(importPathWithQueryString, context.settings)) return;
|
||
|
|
||
|
const importPath = importPathWithQueryString.replace(/\?(.*)$/, '');
|
||
|
|
||
|
// don't enforce in root external packages as they may have names with `.js`.
|
||
|
// Like `import Decimal from decimal.js`)
|
||
|
if (isExternalRootModule(importPath)) return;
|
||
|
|
||
|
const resolvedPath = (0, _resolve2.default)(importPath, context);
|
||
|
|
||
|
// get extension from resolved path, if possible.
|
||
|
// for unresolved, use source value.
|
||
|
const extension = _path2.default.extname(resolvedPath || importPath).substring(1);
|
||
|
|
||
|
// determine if this is a module
|
||
|
const isPackage = (0, _importType.isExternalModule)(importPath, context.settings) || (0, _importType.isScoped)(importPath);
|
||
|
|
||
|
if (!extension || !importPath.endsWith(`.${extension}`)) {
|
||
|
const extensionRequired = isUseOfExtensionRequired(extension, isPackage);
|
||
|
const extensionForbidden = isUseOfExtensionForbidden(extension);
|
||
|
if (extensionRequired && !extensionForbidden) {
|
||
|
context.report({
|
||
|
node: source,
|
||
|
message: `Missing file extension ${extension ? `"${extension}" ` : ''}for "${importPathWithQueryString}"`
|
||
|
});
|
||
|
}
|
||
|
} else if (extension) {
|
||
|
if (isUseOfExtensionForbidden(extension) && isResolvableWithoutExtension(importPath)) {
|
||
|
context.report({
|
||
|
node: source,
|
||
|
message: `Unexpected use of file extension "${extension}" for "${importPathWithQueryString}"`
|
||
|
});
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
|
||
|
return {
|
||
|
ImportDeclaration: checkFileExtension,
|
||
|
ExportNamedDeclaration: checkFileExtension
|
||
|
};
|
||
|
}
|
||
|
};
|
||
|
//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9ydWxlcy9leHRlbnNpb25zLmpzIl0sIm5hbWVzIjpbImVudW1WYWx1ZXMiLCJlbnVtIiwicGF0dGVyblByb3BlcnRpZXMiLCJ0eXBlIiwicHJvcGVydGllcyIsImJ1aWxkUHJvcGVydGllcyIsImNvbnRleHQiLCJyZXN1bHQiLCJkZWZhdWx0Q29uZmlnIiwicGF0dGVybiIsImlnbm9yZVBhY2thZ2VzIiwib3B0aW9ucyIsImZvckVhY2giLCJvYmoiLCJ1bmRlZmluZWQiLCJPYmplY3QiLCJhc3NpZ24iLCJtb2R1bGUiLCJleHBvcnRzIiwibWV0YSIsImRvY3MiLCJ1cmwiLCJzY2hlbWEiLCJhbnlPZiIsIml0ZW1zIiwiYWRkaXRpb25hbEl0ZW1zIiwiY3JlYXRlIiwicHJvcHMiLCJnZXRNb2RpZmllciIsImV4dGVuc2lvbiIsImlzVXNlT2ZFeHRlbnNpb25SZXF1aXJlZCIsImlzUGFja2FnZSIsImlzVXNlT2ZFeHRlbnNpb25Gb3JiaWRkZW4iLCJpc1Jlc29sdmFibGVXaXRob3V0RXh0ZW5zaW9uIiwiZmlsZSIsInBhdGgiLCJleHRuYW1lIiwiZmlsZVdpdGhvdXRFeHRlbnNpb24iLCJzbGljZSIsImxlbmd0aCIsInJlc29sdmVkRmlsZVdpdGhvdXRFeHRlbnNpb24iLCJpc0V4dGVybmFsUm9vdE1vZHVsZSIsInNsYXNoQ291bnQiLCJzcGxpdCIsImNoZWNrRmlsZUV4dGVuc2lvbiIsIm5vZGUiLCJzb3VyY2UiLCJpbXBvcnRQYXRoV2l0aFF1ZXJ5U3RyaW5nIiwidmFsdWUiLCJzZXR0aW5ncyIsImltcG9ydFBhdGgiLCJyZXBsYWNlIiwicmVzb2x2ZWRQYXRoIiwic3Vic3RyaW5nIiwiZW5kc1dpdGgiLCJleHRlbnNpb25SZXF1aXJlZCIsImV4dGVuc2lvbkZvcmJpZGRlbiIsInJlcG9ydCIsIm1lc3NhZ2UiLCJJbXBvcnREZWNsYXJhdGlvbiIsIkV4cG9ydE5hbWVkRGVjbGFyYXRpb24iXSwibWFwcGluZ3MiOiI7O0FBQUE7Ozs7QUFFQTs7OztBQUNBOztBQUNBOzs7Ozs7QUFFQSxNQUFNQSxhQUFhLEVBQUVDLE1BQU0sQ0FBRSxRQUFGLEVBQVksZ0JBQVosRUFBOEIsT0FBOUIsQ0FBUixFQUFuQjtBQUNBLE1BQU1DLG9CQUFvQjtBQUN4QkMsUUFBTSxRQURrQjtBQUV4QkQscUJBQW1CLEVBQUUsTUFBTUYsVUFBUjtBQUZLLENBQTFCO0FBSUEsTUFBTUksYUFBYTtBQUNqQkQsUUFBTSxRQURXO0FBRWpCQyxjQUFZO0FBQ1YsZUFBV0YsaUJBREQ7QUFFVixzQkFBa0IsRUFBRUMsTUFBTSxTQUFSO0FBRlI7QUFGSyxDQUFuQjs7QUFRQSxTQUFTRSxlQUFULENBQXlCQyxPQUF6QixFQUFrQzs7QUFFOUIsUUFBTUMsU0FBUztBQUNiQyxtQkFBZSxPQURGO0FBRWJDLGFBQVMsRUFGSTtBQUdiQyxvQkFBZ0I7QUFISCxHQUFmOztBQU1BSixVQUFRSyxPQUFSLENBQWdCQyxPQUFoQixDQUF3QkMsT0FBTzs7QUFFN0I7QUFDQSxRQUFJLE9BQU9BLEdBQVAsS0FBZSxRQUFuQixFQUE2QjtBQUMzQk4sYUFBT0MsYUFBUCxHQUF1QkssR0FBdkI7QUFDQTtBQUNEOztBQUVEO0FBQ0EsUUFBSUEsSUFBSUosT0FBSixLQUFnQkssU0FBaEIsSUFBNkJELElBQUlILGNBQUosS0FBdUJJLFNBQXhELEVBQW1FO0FBQ2pFQyxhQUFPQyxNQUFQLENBQWNULE9BQU9FLE9BQXJCLEVBQThCSSxHQUE5QjtBQUNBO0FBQ0Q7O0FBRUQ7QUFDQSxRQUFJQSxJQUFJSixPQUFKLEtBQWdCSyxTQUFwQixFQUErQjtBQUM3QkMsYUFBT0MsTUFBUCxDQUFjVCxPQUFPRSxPQUFyQixFQUE4QkksSUFBSUosT0FBbEM7QUFDRDs7QUFFRDtBQUNBLFFBQUlJLElBQUlILGNBQUosS0FBdUJJLFNBQTNCLEVBQXNDO0FBQ3BDUCxhQUFPRyxjQUFQLEdBQXdCRyxJQUFJSCxjQUE1QjtBQUNEO0FBQ0YsR0F2QkQ7O0FBeUJBLE1BQUlILE9BQU9DLGFBQVAsS0FBeUIsZ0JBQTdCLEVBQStDO0FBQzdDRCxXQUFPQyxhQUFQLEdBQXVCLFFBQXZCO0FBQ0FELFdBQU9HLGNBQVAsR0FBd0IsSUFBeEI7QUFDRDs7QUFFRCxTQUFPSCxNQUFQO0FBQ0g7O0FBRURVLE9BQU9DLE9BQVAsR0FBaUI7QUFDZkMsUUFBTTtBQUNKaEIsVUFBTSxZQURGO0FBRUppQixVQUFNO0FBQ0pDLFdBQUssdUJBQVEsWUFBUjtBQURELEtBRkY7O0FBTUpDLFlBQVE7QUFDTkMsYUFBTyxDQUNMO0FBQ0VwQixjQUFNLE9BRFI7QUFFRXFCLGVBQU8sQ0FBQ3hCLFVBQUQsQ0FGVDtBQUdFeUIseUJBQWlCO0FBSG5CLE9BREssRUFNTDtBQUNFdEIsY0FBTSxPQURSO0FBRUVxQixlQUFPLENBQ0x4QixVQURLLEVBRUxJLFVBRkssQ0FGVDtBQU1FcUIseUJBQWlCO0FBTm5CLE9BTkssRUFjTDtBQUNFdEIsY0FBTSxPQURSO0FBRUVxQixlQUFPLENBQUNwQixVQUFELENBRlQ7QUFHRXFCLHlCQUFpQjtBQUhuQixPQWRLLEVBbUJMO0FBQ0V0QixjQUFNLE9BRFI7QUFFRXFCLGVBQU8sQ0FBQ3RCLGlCQUFELENBRlQ7QUFHRXVCLHlCQUFpQjtBQUhuQixPQW5CSyxFQXdCTDtBQUNFdEIsY0FBTSxPQURSO0FBRUVxQixlQUFPLENBQ0x4QixVQURLLEVBRUxFLGlCQUZLLENBRlQ7QUFNRXVCLHlCQUFpQjtBQU5uQixPQXhCSztBQUREO0FBTkosR0FEUzs7QUE0Q2ZDLFVBQVEsVUFBVXBCLE9BQVYsRUFBbUI7O0FBRXpCLFVBQU1xQixRQUFRdEIsZ0JBQWdCQyxPQUFoQixDQUFkOztBQUVBLGFBQVNzQixXQUFULENBQXFCQyxTQUFyQixFQUFnQztBQUM5QixhQUFPRixNQUFNbEIsT0FBTixDQUFjb0IsU0FBZCxLQUE0QkYsTUFBTW5CLGFBQXpDO0FBQ0Q7O0FBRUQsYUFBU3NCLHdCQUFULENBQWtDRCxTQUFsQyxFQUE2Q0UsU0FBN0MsRUFBd0Q7QUFDdEQsYUFBT0gsWUFBWUMsU0FBWixNQUEyQixRQUEzQixLQUF3QyxDQUFDRixNQUFNakIsY0FBUCxJQUF5QixDQUFDcUIsU0FBbEUsQ0FBUDtBQUNEOztBQUVELGFBQVNDLHlCQUFULENBQW1DSCxTQUFuQyxFQUE4QztBQUM1QyxhQUFPRCxZQUFZQyxTQUFaLE1BQTJCLE9BQWxDO0FBQ0Q7O0FBRUQsYUFBU0ksNEJBQVQsQ0FBc0NDLElBQXRDLEVBQTRDO0FBQzFDLFlBQU1MLFlBQVlNLGVBQUtDLE9BQUwsQ0FBYUYsSUFBYixDQUFsQjtBQUNBLFlBQU1HLHVCQUF1QkgsS0FBS0ksS0FBTCxDQUFXLENBQVgsRUFBYyxDQUFDVCxVQUFVVSxNQUF6QixDQUE3QjtBQUNBLFlBQU1DLCtCQUErQix1QkFBUUgsb0JBQVIsRUFBOEIvQixPQUE5QixDQUFyQzs7QUFFQSx
|