193 lines
20 KiB
JavaScript
193 lines
20 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 _moduleVisitor = require('eslint-module-utils/moduleVisitor');var _moduleVisitor2 = _interopRequireDefault(_moduleVisitor);
|
||
|
var _docsUrl = require('../docsUrl');var _docsUrl2 = _interopRequireDefault(_docsUrl);function _interopRequireDefault(obj) {return obj && obj.__esModule ? obj : { 'default': obj };}
|
||
|
|
||
|
var enumValues = { 'enum': ['always', 'ignorePackages', 'never'] };
|
||
|
var patternProperties = {
|
||
|
type: 'object',
|
||
|
patternProperties: { '.*': enumValues } };
|
||
|
|
||
|
var properties = {
|
||
|
type: 'object',
|
||
|
properties: {
|
||
|
pattern: patternProperties,
|
||
|
ignorePackages: { type: 'boolean' } } };
|
||
|
|
||
|
|
||
|
|
||
|
function buildProperties(context) {
|
||
|
|
||
|
var result = {
|
||
|
defaultConfig: 'never',
|
||
|
pattern: {},
|
||
|
ignorePackages: false };
|
||
|
|
||
|
|
||
|
context.options.forEach(function (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: {
|
||
|
category: 'Style guide',
|
||
|
description: 'Ensure consistent use of file extension within the import path.',
|
||
|
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 () {function create(context) {
|
||
|
|
||
|
var 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) {
|
||
|
var extension = _path2['default'].extname(file);
|
||
|
var fileWithoutExtension = file.slice(0, -extension.length);
|
||
|
var resolvedFileWithoutExtension = (0, _resolve2['default'])(fileWithoutExtension, context);
|
||
|
|
||
|
return resolvedFileWithoutExtension === (0, _resolve2['default'])(file, context);
|
||
|
}
|
||
|
|
||
|
function isExternalRootModule(file) {
|
||
|
if (file === '.' || file === '..') {return false;}
|
||
|
var slashCount = file.split('/').length - 1;
|
||
|
|
||
|
if (slashCount === 0) {return true;}
|
||
|
if ((0, _importType.isScoped)(file) && slashCount <= 1) {return true;}
|
||
|
return false;
|
||
|
}
|
||
|
|
||
|
function checkFileExtension(source, node) {
|
||
|
// bail if the declaration doesn't have a source, e.g. "export { foo };", or if it's only partially typed like in an editor
|
||
|
if (!source || !source.value) {return;}
|
||
|
|
||
|
var importPathWithQueryString = source.value;
|
||
|
|
||
|
// don't enforce anything on builtins
|
||
|
if ((0, _importType.isBuiltIn)(importPathWithQueryString, context.settings)) {return;}
|
||
|
|
||
|
var 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;}
|
||
|
|
||
|
var resolvedPath = (0, _resolve2['default'])(importPath, context);
|
||
|
|
||
|
// get extension from resolved path, if possible.
|
||
|
// for unresolved, use source value.
|
||
|
var extension = _path2['default'].extname(resolvedPath || importPath).substring(1);
|
||
|
|
||
|
// determine if this is a module
|
||
|
var isPackage = (0, _importType.isExternalModule)(
|
||
|
importPath,
|
||
|
(0, _resolve2['default'])(importPath, context),
|
||
|
context) ||
|
||
|
(0, _importType.isScoped)(importPath);
|
||
|
|
||
|
if (!extension || !importPath.endsWith('.' + String(extension))) {
|
||
|
// ignore type-only imports and exports
|
||
|
if (node.importKind === 'type' || node.exportKind === 'type') {return;}
|
||
|
var extensionRequired = isUseOfExtensionRequired(extension, isPackage);
|
||
|
var extensionForbidden = isUseOfExtensionForbidden(extension);
|
||
|
if (extensionRequired && !extensionForbidden) {
|
||
|
context.report({
|
||
|
node: source,
|
||
|
message: 'Missing file extension ' + (
|
||
|
extension ? '"' + String(extension) + '" ' : '') + 'for "' + String(importPathWithQueryString) + '"' });
|
||
|
|
||
|
}
|
||
|
} else if (extension) {
|
||
|
if (isUseOfExtensionForbidden(extension) && isResolvableWithoutExtension(importPath)) {
|
||
|
context.report({
|
||
|
node: source,
|
||
|
message: 'Unexpected use of file extension "' + String(extension) + '" for "' + String(importPathWithQueryString) + '"' });
|
||
|
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
|
||
|
return (0, _moduleVisitor2['default'])(checkFileExtension, { commonjs: true });
|
||
|
}return create;}() };
|
||
|
//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9ydWxlcy9leHRlbnNpb25zLmpzIl0sIm5hbWVzIjpbImVudW1WYWx1ZXMiLCJwYXR0ZXJuUHJvcGVydGllcyIsInR5cGUiLCJwcm9wZXJ0aWVzIiwicGF0dGVybiIsImlnbm9yZVBhY2thZ2VzIiwiYnVpbGRQcm9wZXJ0aWVzIiwiY29udGV4dCIsInJlc3VsdCIsImRlZmF1bHRDb25maWciLCJvcHRpb25zIiwiZm9yRWFjaCIsIm9iaiIsInVuZGVmaW5lZCIsIk9iamVjdCIsImFzc2lnbiIsIm1vZHVsZSIsImV4cG9ydHMiLCJtZXRhIiwiZG9jcyIsImNhdGVnb3J5IiwiZGVzY3JpcHRpb24iLCJ1cmwiLCJzY2hlbWEiLCJhbnlPZiIsIml0ZW1zIiwiYWRkaXRpb25hbEl0ZW1zIiwiY3JlYXRlIiwicHJvcHMiLCJnZXRNb2RpZmllciIsImV4dGVuc2lvbiIsImlzVXNlT2ZFeHRlbnNpb25SZXF1aXJlZCIsImlzUGFja2FnZSIsImlzVXNlT2ZFeHRlbnNpb25Gb3JiaWRkZW4iLCJpc1Jlc29sdmFibGVXaXRob3V0RXh0ZW5zaW9uIiwiZmlsZSIsInBhdGgiLCJleHRuYW1lIiwiZmlsZVdpdGhvdXRFeHRlbnNpb24iLCJzbGljZSIsImxlbmd0aCIsInJlc29sdmVkRmlsZVdpdGhvdXRFeHRlbnNpb24iLCJpc0V4dGVybmFsUm9vdE1vZHVsZSIsInNsYXNoQ291bnQiLCJzcGxpdCIsImNoZWNrRmlsZUV4dGVuc2lvbiIsInNvdXJjZSIsIm5vZGUiLCJ2YWx1ZSIsImltcG9ydFBhdGhXaXRoUXVlcnlTdHJpbmciLCJzZXR0aW5ncyIsImltcG9ydFBhdGgiLCJyZXBsYWNlIiwicmVzb2x2ZWRQYXRoIiwic3Vic3RyaW5nIiwiZW5kc1dpdGgiLCJpbXBvcnRLaW5kIiwiZXhwb3J0S2luZCIsImV4dGVuc2lvblJlcXVpcmVkIiwiZXh0ZW5zaW9uRm9yYmlkZGVuIiwicmVwb3J0IiwibWVzc2FnZSIsImNvbW1vbmpzIl0sIm1hcHBpbmdzIjoiYUFBQSw0Qjs7QUFFQSxzRDtBQUNBO0FBQ0Esa0U7QUFDQSxxQzs7QUFFQSxJQUFNQSxhQUFhLEVBQUUsUUFBTSxDQUFDLFFBQUQsRUFBVyxnQkFBWCxFQUE2QixPQUE3QixDQUFSLEVBQW5CO0FBQ0EsSUFBTUMsb0JBQW9CO0FBQ3hCQyxRQUFNLFFBRGtCO0FBRXhCRCxxQkFBbUIsRUFBRSxNQUFNRCxVQUFSLEVBRkssRUFBMUI7O0FBSUEsSUFBTUcsYUFBYTtBQUNqQkQsUUFBTSxRQURXO0FBRWpCQyxjQUFZO0FBQ1ZDLGFBQVNILGlCQURDO0FBRVZJLG9CQUFnQixFQUFFSCxNQUFNLFNBQVIsRUFGTixFQUZLLEVBQW5COzs7O0FBUUEsU0FBU0ksZUFBVCxDQUF5QkMsT0FBekIsRUFBa0M7O0FBRWhDLE1BQU1DLFNBQVM7QUFDYkMsbUJBQWUsT0FERjtBQUViTCxhQUFTLEVBRkk7QUFHYkMsb0JBQWdCLEtBSEgsRUFBZjs7O0FBTUFFLFVBQVFHLE9BQVIsQ0FBZ0JDLE9BQWhCLENBQXdCLFVBQUNDLEdBQUQsRUFBUzs7QUFFL0I7QUFDQSxRQUFJLE9BQU9BLEdBQVAsS0FBZSxRQUFuQixFQUE2QjtBQUMzQkosYUFBT0MsYUFBUCxHQUF1QkcsR0FBdkI7QUFDQTtBQUNEOztBQUVEO0FBQ0EsUUFBSUEsSUFBSVIsT0FBSixLQUFnQlMsU0FBaEIsSUFBNkJELElBQUlQLGNBQUosS0FBdUJRLFNBQXhELEVBQW1FO0FBQ2pFQyxhQUFPQyxNQUFQLENBQWNQLE9BQU9KLE9BQXJCLEVBQThCUSxHQUE5QjtBQUNBO0FBQ0Q7O0FBRUQ7QUFDQSxRQUFJQSxJQUFJUixPQUFKLEtBQWdCUyxTQUFwQixFQUErQjtBQUM3QkMsYUFBT0MsTUFBUCxDQUFjUCxPQUFPSixPQUFyQixFQUE4QlEsSUFBSVIsT0FBbEM7QUFDRDs7QUFFRDtBQUNBLFFBQUlRLElBQUlQLGNBQUosS0FBdUJRLFNBQTNCLEVBQXNDO0FBQ3BDTCxhQUFPSCxjQUFQLEdBQXdCTyxJQUFJUCxjQUE1QjtBQUNEO0FBQ0YsR0F2QkQ7O0FBeUJBLE1BQUlHLE9BQU9DLGFBQVAsS0FBeUIsZ0JBQTdCLEVBQStDO0FBQzdDRCxXQUFPQyxhQUFQLEdBQXVCLFFBQXZCO0FBQ0FELFdBQU9ILGNBQVAsR0FBd0IsSUFBeEI7QUFDRDs7QUFFRCxTQUFPRyxNQUFQO0FBQ0Q7O0FBRURRLE9BQU9DLE9BQVAsR0FBaUI7QUFDZkMsUUFBTTtBQUNKaEIsVUFBTSxZQURGO0FBRUppQixVQUFNO0FBQ0pDLGdCQUFVLGFBRE47QUFFSkMsbUJBQWEsaUVBRlQ7QUFHSkMsV0FBSywwQkFBUSxZQUFSLENBSEQsRUFGRjs7O0FBUUpDLFlBQVE7QUFDTkMsYUFBTztBQUNMO0FBQ0V0QixjQUFNLE9BRFI7QUFFRXVCLGVBQU8sQ0FBQ3pCLFVBQUQsQ0FGVDtBQUdFMEIseUJBQWlCLEtBSG5CLEVBREs7O0FBTUw7QUFDRXhCLGNBQU0sT0FEUjtBQUVFdUIsZUFBTztBQUNMekIsa0JBREs7QUFFTEcsa0JBRkssQ0FGVDs7QUFNRXVCLHlCQUFpQixLQU5uQixFQU5LOztBQWNMO0FBQ0V4QixjQUFNLE9BRFI7QUFFRXVCLGVBQU8sQ0FBQ3RCLFVBQUQsQ0FGVDtBQUdFdUIseUJBQWlCLEtBSG5CLEVBZEs7O0FBbUJMO0FBQ0V4QixjQUFNLE9BRFI7QUFFRXVCLGVBQU8sQ0FBQ3hCLGlCQUFELENBRlQ7QUFHRXlCLHlCQUFpQixLQUhuQixFQW5CSzs7QUF3Qkw7QUFDRXhCLGNBQU0sT0FEUjtBQUVFdUIsZUFBTztBQUNMekIsa0JBREs7QUFFTEMseUJBRkssQ0FGVDs7QUFNRXlCLHlCQUFpQixLQU5uQixFQXhCSyxDQURELEVBUkosRUFEUzs7Ozs7O0FBOENmQyxRQTlDZSwrQkE4Q1JwQixPQTlDUSxFQThDQzs7QUFFZCxVQUFNcUIsUUFBUXRCLGdCQUFnQkMsT0FBaEIsQ0FBZDs7QUFFQSxlQUFTc0IsV0FBVCxDQUFxQkMsU0FBckIsRUFBZ0M7QUFDOUIsZUFBT0YsTUFBTXhCLE9BQU4sQ0FBYzBCLFNBQWQsS0FBNEJGLE1BQU1uQixhQUF6QztBQUNEOztBQUVELGVBQVNzQix3QkFBVCxDQUFrQ0QsU0FBbEMsRUFBNkNFLFNBQTdDLEVBQXdEO0FBQ3RELGVBQU9ILFlBQVlDLFNBQVosTUFBMkIsUUFBM0IsS0FBd0MsQ0FBQ0YsTUFBTXZCLGNBQVAsSUFBeUIsQ0FBQzJCLFNBQWxFLENBQVA7QUFDRDs7QUFFRCxlQUFTQyx5QkFBVCxDQUFtQ0gsU0FBbkMsRUFBOEM7QUFDNUMsZUFBT0QsWUFBWUMsU0FBWixNQUEyQixPQUFsQztBQUNEOztBQUVELGVBQVNJLDRCQUFULENBQXNDQyxJQUF0QyxFQUE0QztBQUMxQyxZQUFNTCxZQUFZTSxrQkFBS0MsT0FBTCxDQUFhRixJQUFiLENBQWxCO0FBQ0EsWUFBTUcsdUJBQXVCSCxLQUFLSSxLQUFMLENBQVcsQ0FBWCxFQUF
|