@atlaskit/eslint-plugin-design-system 10.24.1 → 10.26.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +23 -0
- package/README.md +2 -1
- package/dist/cjs/ast-nodes/jsx-attribute.js +8 -0
- package/dist/cjs/presets/all-flat.codegen.js +2 -1
- package/dist/cjs/presets/all.codegen.js +2 -1
- package/dist/cjs/presets/recommended-flat.codegen.js +2 -1
- package/dist/cjs/presets/recommended.codegen.js +2 -1
- package/dist/cjs/rules/index.codegen.js +3 -1
- package/dist/cjs/rules/no-deprecated-imports/checks.js +201 -0
- package/dist/cjs/rules/no-deprecated-imports/constants.js +8 -0
- package/dist/cjs/rules/no-deprecated-imports/handlers/icon.js +204 -0
- package/dist/cjs/rules/no-deprecated-imports/index.js +25 -118
- package/dist/cjs/rules/use-datetime-picker-calendar-button/index.js +187 -0
- package/dist/cjs/rules/utils/get-deprecated-config.js +9 -1
- package/dist/es2019/ast-nodes/jsx-attribute.js +8 -0
- package/dist/es2019/presets/all-flat.codegen.js +2 -1
- package/dist/es2019/presets/all.codegen.js +2 -1
- package/dist/es2019/presets/recommended-flat.codegen.js +2 -1
- package/dist/es2019/presets/recommended.codegen.js +2 -1
- package/dist/es2019/rules/index.codegen.js +3 -1
- package/dist/es2019/rules/no-deprecated-imports/checks.js +175 -0
- package/dist/es2019/rules/no-deprecated-imports/constants.js +2 -0
- package/dist/es2019/rules/no-deprecated-imports/handlers/icon.js +153 -0
- package/dist/es2019/rules/no-deprecated-imports/index.js +23 -103
- package/dist/es2019/rules/use-datetime-picker-calendar-button/index.js +173 -0
- package/dist/es2019/rules/utils/get-deprecated-config.js +12 -1
- package/dist/esm/ast-nodes/jsx-attribute.js +8 -0
- package/dist/esm/presets/all-flat.codegen.js +2 -1
- package/dist/esm/presets/all.codegen.js +2 -1
- package/dist/esm/presets/recommended-flat.codegen.js +2 -1
- package/dist/esm/presets/recommended.codegen.js +2 -1
- package/dist/esm/rules/index.codegen.js +3 -1
- package/dist/esm/rules/no-deprecated-imports/checks.js +195 -0
- package/dist/esm/rules/no-deprecated-imports/constants.js +2 -0
- package/dist/esm/rules/no-deprecated-imports/handlers/icon.js +197 -0
- package/dist/esm/rules/no-deprecated-imports/index.js +23 -117
- package/dist/esm/rules/use-datetime-picker-calendar-button/index.js +181 -0
- package/dist/esm/rules/utils/get-deprecated-config.js +9 -1
- package/dist/types/ast-nodes/jsx-attribute.d.ts +3 -0
- package/dist/types/index.codegen.d.ts +14 -9
- package/dist/types/presets/all-flat.codegen.d.ts +2 -1
- package/dist/types/presets/all.codegen.d.ts +2 -1
- package/dist/types/presets/recommended-flat.codegen.d.ts +2 -1
- package/dist/types/presets/recommended.codegen.d.ts +2 -1
- package/dist/types/rules/index.codegen.d.ts +2 -3
- package/dist/types/rules/no-deprecated-imports/checks.d.ts +11 -0
- package/dist/types/rules/no-deprecated-imports/constants.d.ts +2 -0
- package/dist/types/rules/no-deprecated-imports/handlers/icon.d.ts +38 -0
- package/dist/types/rules/no-deprecated-imports/index.d.ts +1 -7
- package/dist/types/rules/use-datetime-picker-calendar-button/index.d.ts +7 -0
- package/dist/types/rules/utils/types.d.ts +1 -0
- package/dist/types-ts4.5/ast-nodes/jsx-attribute.d.ts +3 -0
- package/dist/types-ts4.5/index.codegen.d.ts +14 -15
- package/dist/types-ts4.5/presets/all-flat.codegen.d.ts +2 -1
- package/dist/types-ts4.5/presets/all.codegen.d.ts +2 -1
- package/dist/types-ts4.5/presets/recommended-flat.codegen.d.ts +2 -1
- package/dist/types-ts4.5/presets/recommended.codegen.d.ts +2 -1
- package/dist/types-ts4.5/rules/index.codegen.d.ts +2 -5
- package/dist/types-ts4.5/rules/no-deprecated-imports/checks.d.ts +11 -0
- package/dist/types-ts4.5/rules/no-deprecated-imports/constants.d.ts +2 -0
- package/dist/types-ts4.5/rules/no-deprecated-imports/handlers/icon.d.ts +38 -0
- package/dist/types-ts4.5/rules/no-deprecated-imports/index.d.ts +1 -9
- package/dist/types-ts4.5/rules/use-datetime-picker-calendar-button/index.d.ts +7 -0
- package/dist/types-ts4.5/rules/utils/types.d.ts +1 -0
- package/package.json +3 -2
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
|
|
2
|
+
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
|
|
3
|
+
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
|
|
4
|
+
import { isNodeOfType } from 'eslint-codemod-utils';
|
|
5
|
+
import { getConfig } from '../utils/get-deprecated-config';
|
|
6
|
+
import { isDeprecatedImportConfig } from '../utils/types';
|
|
7
|
+
import { importNameWithCustomMessageId, pathWithCustomMessageId } from './constants';
|
|
8
|
+
import { getDeprecationIconHandler } from './handlers/icon';
|
|
9
|
+
export var createChecks = function createChecks(context) {
|
|
10
|
+
var deprecatedIconHandler = getDeprecationIconHandler(context);
|
|
11
|
+
var throwErrors = function throwErrors() {
|
|
12
|
+
deprecatedIconHandler.throwErrors();
|
|
13
|
+
};
|
|
14
|
+
var getHandler = function getHandler(importSource) {
|
|
15
|
+
if (importSource.startsWith('@atlaskit/icon')) {
|
|
16
|
+
return deprecatedIconHandler;
|
|
17
|
+
}
|
|
18
|
+
};
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Report a restricted path.
|
|
22
|
+
* @param {string} importSource path of the import
|
|
23
|
+
* @param {string} type whether the node is an import or export
|
|
24
|
+
* @param {node} node representing the restricted path reference
|
|
25
|
+
* @param {Map<string,TSESTree.Node>} importNames Map of import names that are being imported
|
|
26
|
+
* @returns {void}
|
|
27
|
+
* @private
|
|
28
|
+
*/
|
|
29
|
+
function checkRestrictedPathAndReport(_ref) {
|
|
30
|
+
var _context$options$;
|
|
31
|
+
var importSource = _ref.importSource,
|
|
32
|
+
type = _ref.type,
|
|
33
|
+
node = _ref.node,
|
|
34
|
+
importNames = _ref.importNames;
|
|
35
|
+
var restrictedPathMessages = ((_context$options$ = context.options[0]) === null || _context$options$ === void 0 ? void 0 : _context$options$.deprecatedConfig) || getConfig('imports');
|
|
36
|
+
if (!isDeprecatedImportConfig(restrictedPathMessages)) {
|
|
37
|
+
throw new Error('Config is invalid for deprecated imports');
|
|
38
|
+
}
|
|
39
|
+
if (!Object.prototype.hasOwnProperty.call(restrictedPathMessages, importSource)) {
|
|
40
|
+
return;
|
|
41
|
+
}
|
|
42
|
+
var config = restrictedPathMessages[importSource];
|
|
43
|
+
var handler = getHandler(importSource);
|
|
44
|
+
if (handler) {
|
|
45
|
+
if (type === 'import') {
|
|
46
|
+
handler.createImportError({
|
|
47
|
+
node: node,
|
|
48
|
+
importSource: importSource,
|
|
49
|
+
config: config
|
|
50
|
+
});
|
|
51
|
+
} else {
|
|
52
|
+
handler.createExportError({
|
|
53
|
+
node: node,
|
|
54
|
+
importSource: importSource,
|
|
55
|
+
config: config
|
|
56
|
+
});
|
|
57
|
+
}
|
|
58
|
+
} else {
|
|
59
|
+
// Default behaviour
|
|
60
|
+
// The message will only exist if the import is completely banned,
|
|
61
|
+
// eg a deprecated package
|
|
62
|
+
if ('message' in config) {
|
|
63
|
+
context.report({
|
|
64
|
+
node: node,
|
|
65
|
+
messageId: pathWithCustomMessageId,
|
|
66
|
+
data: {
|
|
67
|
+
importSource: importSource,
|
|
68
|
+
customMessage: config.message
|
|
69
|
+
}
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
// if there are specific named exports that are banned,
|
|
74
|
+
// iterate through and check if they're being imported
|
|
75
|
+
if ('importSpecifiers' in config) {
|
|
76
|
+
var _config$importSpecifi;
|
|
77
|
+
(_config$importSpecifi = config.importSpecifiers) === null || _config$importSpecifi === void 0 || _config$importSpecifi.forEach(function (restrictedImport) {
|
|
78
|
+
if (importNames.has(restrictedImport.importName)) {
|
|
79
|
+
context.report({
|
|
80
|
+
node: importNames.get(restrictedImport.importName),
|
|
81
|
+
messageId: importNameWithCustomMessageId,
|
|
82
|
+
data: {
|
|
83
|
+
importName: restrictedImport.importName,
|
|
84
|
+
importSource: importSource,
|
|
85
|
+
customMessage: restrictedImport.message
|
|
86
|
+
}
|
|
87
|
+
});
|
|
88
|
+
}
|
|
89
|
+
});
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* Checks a node to see if any problems should be reported.
|
|
96
|
+
* @param {ASTNode} node The node to check.
|
|
97
|
+
* @returns {void}
|
|
98
|
+
* @private
|
|
99
|
+
*/
|
|
100
|
+
var checkImportNode = function checkImportNode(node) {
|
|
101
|
+
var importSource = node.source.value.trim();
|
|
102
|
+
var importNames = new Map();
|
|
103
|
+
if ('specifiers' in node) {
|
|
104
|
+
var _iterator = _createForOfIteratorHelper(node.specifiers),
|
|
105
|
+
_step;
|
|
106
|
+
try {
|
|
107
|
+
for (_iterator.s(); !(_step = _iterator.n()).done;) {
|
|
108
|
+
var specifier = _step.value;
|
|
109
|
+
var name = void 0;
|
|
110
|
+
if (specifier.type === 'ImportDefaultSpecifier') {
|
|
111
|
+
name = 'default';
|
|
112
|
+
} else if (specifier.type === 'ImportNamespaceSpecifier') {
|
|
113
|
+
name = '*';
|
|
114
|
+
} else if (specifier.type === 'ImportSpecifier') {
|
|
115
|
+
name = specifier.imported.name;
|
|
116
|
+
}
|
|
117
|
+
if (name) {
|
|
118
|
+
importNames.set(name, specifier);
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
} catch (err) {
|
|
122
|
+
_iterator.e(err);
|
|
123
|
+
} finally {
|
|
124
|
+
_iterator.f();
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
checkRestrictedPathAndReport({
|
|
128
|
+
importSource: importSource,
|
|
129
|
+
type: 'import',
|
|
130
|
+
node: node,
|
|
131
|
+
importNames: importNames
|
|
132
|
+
});
|
|
133
|
+
};
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* Checks a node to see if any problems should be reported.
|
|
137
|
+
* @param {ASTNode} node The node to check.
|
|
138
|
+
* @returns {void}
|
|
139
|
+
* @private
|
|
140
|
+
*/
|
|
141
|
+
var checkExportNode = function checkExportNode(node) {
|
|
142
|
+
if (!node.source || !node.source.value) {
|
|
143
|
+
return;
|
|
144
|
+
}
|
|
145
|
+
var importSource = node.source.value.trim();
|
|
146
|
+
var importNames = new Map();
|
|
147
|
+
if ('specifiers' in node) {
|
|
148
|
+
var _iterator2 = _createForOfIteratorHelper(node.specifiers),
|
|
149
|
+
_step2;
|
|
150
|
+
try {
|
|
151
|
+
for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
|
|
152
|
+
var specifier = _step2.value;
|
|
153
|
+
var name = void 0;
|
|
154
|
+
if (specifier.local) {
|
|
155
|
+
name = specifier.local.name;
|
|
156
|
+
}
|
|
157
|
+
if (name) {
|
|
158
|
+
importNames.set(name, specifier);
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
} catch (err) {
|
|
162
|
+
_iterator2.e(err);
|
|
163
|
+
} finally {
|
|
164
|
+
_iterator2.f();
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
checkRestrictedPathAndReport({
|
|
168
|
+
importSource: importSource,
|
|
169
|
+
type: 'export',
|
|
170
|
+
node: node,
|
|
171
|
+
importNames: importNames
|
|
172
|
+
});
|
|
173
|
+
};
|
|
174
|
+
|
|
175
|
+
/**
|
|
176
|
+
* Create a mapping of JSX elements by their name so they can be processed later.
|
|
177
|
+
* @param node The JSX node found by ESLint
|
|
178
|
+
*/
|
|
179
|
+
var checkJSXElement = function checkJSXElement(node) {
|
|
180
|
+
if (!('openingElement' in node) || !isNodeOfType(node.openingElement.name, 'JSXIdentifier')) {
|
|
181
|
+
return;
|
|
182
|
+
}
|
|
183
|
+
deprecatedIconHandler.checkJSXElement(node);
|
|
184
|
+
};
|
|
185
|
+
var checkIdentifier = function checkIdentifier(node) {
|
|
186
|
+
deprecatedIconHandler.checkIdentifier(node);
|
|
187
|
+
};
|
|
188
|
+
return {
|
|
189
|
+
checkImportNode: checkImportNode,
|
|
190
|
+
checkExportNode: checkExportNode,
|
|
191
|
+
checkJSXElement: checkJSXElement,
|
|
192
|
+
checkIdentifier: checkIdentifier,
|
|
193
|
+
throwErrors: throwErrors
|
|
194
|
+
};
|
|
195
|
+
};
|
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
|
|
2
|
+
function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
|
|
3
|
+
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
|
|
4
|
+
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
|
|
5
|
+
import { isNodeOfType, literal } from 'eslint-codemod-utils';
|
|
6
|
+
import coreIconLabMetadata from '@atlaskit/icon-lab/metadata';
|
|
7
|
+
import { coreIconMetadata, utilityIconMetadata } from '@atlaskit/icon/metadata';
|
|
8
|
+
import { pathWithCustomMessageId } from '../constants';
|
|
9
|
+
/**
|
|
10
|
+
* __Deprecation icon handler__
|
|
11
|
+
*
|
|
12
|
+
* A deprecation icon handler which is responsible for displaying an error for deprecated icons.
|
|
13
|
+
* It also includes a fixer to replace the deprecated icon with the new icon if a replacement exists.
|
|
14
|
+
*/
|
|
15
|
+
export var getDeprecationIconHandler = function getDeprecationIconHandler(context) {
|
|
16
|
+
var jsxElements = new Map();
|
|
17
|
+
var identifiers = new Map();
|
|
18
|
+
var importErrors = {};
|
|
19
|
+
var exportErrors = {};
|
|
20
|
+
var getIconComponentName = function getIconComponentName(name) {
|
|
21
|
+
return name.split(/\W/).map(function (part) {
|
|
22
|
+
return "".concat(part[0].toUpperCase()).concat(part.slice(1));
|
|
23
|
+
}).join('').concat('Icon');
|
|
24
|
+
};
|
|
25
|
+
var createImportError = function createImportError(_ref) {
|
|
26
|
+
var node = _ref.node,
|
|
27
|
+
importSource = _ref.importSource,
|
|
28
|
+
config = _ref.config;
|
|
29
|
+
if (config.message) {
|
|
30
|
+
var myError = {
|
|
31
|
+
node: node,
|
|
32
|
+
messageId: pathWithCustomMessageId,
|
|
33
|
+
data: {
|
|
34
|
+
importSource: importSource,
|
|
35
|
+
customMessage: config.message,
|
|
36
|
+
unfixable: config.unfixable ? 'true' : 'false'
|
|
37
|
+
}
|
|
38
|
+
};
|
|
39
|
+
importErrors[node.source.value] = myError;
|
|
40
|
+
}
|
|
41
|
+
};
|
|
42
|
+
var createExportError = function createExportError(_ref2) {
|
|
43
|
+
var node = _ref2.node,
|
|
44
|
+
importSource = _ref2.importSource,
|
|
45
|
+
config = _ref2.config;
|
|
46
|
+
if (config.message) {
|
|
47
|
+
var myError = {
|
|
48
|
+
node: node,
|
|
49
|
+
messageId: pathWithCustomMessageId,
|
|
50
|
+
data: {
|
|
51
|
+
importSource: importSource,
|
|
52
|
+
customMessage: config.message
|
|
53
|
+
}
|
|
54
|
+
};
|
|
55
|
+
exportErrors[importSource] = myError;
|
|
56
|
+
}
|
|
57
|
+
};
|
|
58
|
+
var throwErrors = function throwErrors() {
|
|
59
|
+
for (var _i = 0, _Object$entries = Object.entries(importErrors); _i < _Object$entries.length; _i++) {
|
|
60
|
+
var _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2),
|
|
61
|
+
importSource = _Object$entries$_i[0],
|
|
62
|
+
error = _Object$entries$_i[1];
|
|
63
|
+
if (importSource.includes('/migration/')) {
|
|
64
|
+
var _metadata$deprecatedI, _error$data;
|
|
65
|
+
var _importSource$split$s = importSource.split('/').slice(1),
|
|
66
|
+
_importSource$split$s2 = _slicedToArray(_importSource$split$s, 4),
|
|
67
|
+
_location = _importSource$split$s2[0],
|
|
68
|
+
type = _importSource$split$s2[1],
|
|
69
|
+
_migration = _importSource$split$s2[2],
|
|
70
|
+
name = _importSource$split$s2[3];
|
|
71
|
+
var metadata = type === 'core' ? coreIconMetadata : utilityIconMetadata;
|
|
72
|
+
var _name$split = name.split('--'),
|
|
73
|
+
_name$split2 = _slicedToArray(_name$split, 2),
|
|
74
|
+
deprecatedIconName = _name$split2[0],
|
|
75
|
+
legacyIconName = _name$split2[1];
|
|
76
|
+
var replacement = metadata === null || metadata === void 0 || (_metadata$deprecatedI = metadata[deprecatedIconName]) === null || _metadata$deprecatedI === void 0 ? void 0 : _metadata$deprecatedI.replacement;
|
|
77
|
+
if (replacement && ((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.unfixable) === 'false') {
|
|
78
|
+
var newIconName = getIconComponentName(replacement.name);
|
|
79
|
+
addAutoFix(error, importSource, "".concat(replacement.location, "/").concat(replacement.type, "/migration/").concat(replacement.name, "--").concat(legacyIconName), newIconName);
|
|
80
|
+
}
|
|
81
|
+
} else {
|
|
82
|
+
var _metadata2;
|
|
83
|
+
var _importSource$split$s3 = importSource.split('/').slice(1),
|
|
84
|
+
_importSource$split$s4 = _slicedToArray(_importSource$split$s3, 3),
|
|
85
|
+
location = _importSource$split$s4[0],
|
|
86
|
+
_type = _importSource$split$s4[1],
|
|
87
|
+
_name = _importSource$split$s4[2];
|
|
88
|
+
var _metadata = void 0;
|
|
89
|
+
if (location === 'icon') {
|
|
90
|
+
_metadata = _type === 'core' ? coreIconMetadata : utilityIconMetadata;
|
|
91
|
+
} else if (location === 'icon-lab') {
|
|
92
|
+
_metadata = coreIconLabMetadata;
|
|
93
|
+
}
|
|
94
|
+
var _replacement = (_metadata2 = _metadata) === null || _metadata2 === void 0 || (_metadata2 = _metadata2[_name]) === null || _metadata2 === void 0 ? void 0 : _metadata2.replacement;
|
|
95
|
+
if (_replacement) {
|
|
96
|
+
var _newIconName = getIconComponentName(_replacement.name);
|
|
97
|
+
addAutoFix(error, importSource, "".concat(_replacement.location, "/").concat(_replacement.type, "/").concat(_replacement.name), _newIconName);
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
context.report(error);
|
|
101
|
+
}
|
|
102
|
+
for (var _i2 = 0, _Object$values = Object.values(exportErrors); _i2 < _Object$values.length; _i2++) {
|
|
103
|
+
var _error = _Object$values[_i2];
|
|
104
|
+
context.report(_error);
|
|
105
|
+
}
|
|
106
|
+
};
|
|
107
|
+
var addAutoFix = function addAutoFix(error, importSource, newImportSource, newIconName) {
|
|
108
|
+
error.fix = function (fixer) {
|
|
109
|
+
var fixes = [];
|
|
110
|
+
|
|
111
|
+
//Find and update all usages of this icon in JSX with the replacement icon
|
|
112
|
+
var jsxUsageNodes = jsxElements.get(importSource);
|
|
113
|
+
if (jsxUsageNodes) {
|
|
114
|
+
var _iterator = _createForOfIteratorHelper(jsxUsageNodes),
|
|
115
|
+
_step;
|
|
116
|
+
try {
|
|
117
|
+
for (_iterator.s(); !(_step = _iterator.n()).done;) {
|
|
118
|
+
var usageNode = _step.value;
|
|
119
|
+
fixes.push(fixer.replaceText(usageNode.openingElement.name, newIconName));
|
|
120
|
+
}
|
|
121
|
+
} catch (err) {
|
|
122
|
+
_iterator.e(err);
|
|
123
|
+
} finally {
|
|
124
|
+
_iterator.f();
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
//Find and update all usages of this icon in identifiers with the replacement icon
|
|
129
|
+
var usageNodes = identifiers.get(importSource);
|
|
130
|
+
if (usageNodes) {
|
|
131
|
+
var _iterator2 = _createForOfIteratorHelper(usageNodes),
|
|
132
|
+
_step2;
|
|
133
|
+
try {
|
|
134
|
+
for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
|
|
135
|
+
var _usageNode = _step2.value;
|
|
136
|
+
fixes.push(fixer.replaceText(_usageNode.parent, "{".concat(newIconName, "}")));
|
|
137
|
+
}
|
|
138
|
+
} catch (err) {
|
|
139
|
+
_iterator2.e(err);
|
|
140
|
+
} finally {
|
|
141
|
+
_iterator2.f();
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
fixes.push(fixer.replaceText(error.node, "".concat(literal("import ".concat(newIconName, " from '").concat(newImportSource, "'")), ";")));
|
|
145
|
+
return fixes;
|
|
146
|
+
};
|
|
147
|
+
};
|
|
148
|
+
var checkJSXElement = function checkJSXElement(node) {
|
|
149
|
+
if (!('openingElement' in node) || !isNodeOfType(node.openingElement.name, 'JSXIdentifier')) {
|
|
150
|
+
return;
|
|
151
|
+
}
|
|
152
|
+
for (var _i3 = 0, _Object$entries2 = Object.entries(importErrors); _i3 < _Object$entries2.length; _i3++) {
|
|
153
|
+
var _Object$entries2$_i = _slicedToArray(_Object$entries2[_i3], 2),
|
|
154
|
+
importSource = _Object$entries2$_i[0],
|
|
155
|
+
error = _Object$entries2$_i[1];
|
|
156
|
+
var importIconName = error.node.specifiers[0].local.name;
|
|
157
|
+
var iconName = node.openingElement.name.name;
|
|
158
|
+
if (iconName === importIconName) {
|
|
159
|
+
if (jsxElements.has(importSource)) {
|
|
160
|
+
var _jsxElements$get;
|
|
161
|
+
(_jsxElements$get = jsxElements.get(importSource)) === null || _jsxElements$get === void 0 || _jsxElements$get.push(node);
|
|
162
|
+
} else {
|
|
163
|
+
jsxElements.set(importSource, [node]);
|
|
164
|
+
}
|
|
165
|
+
break;
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
};
|
|
169
|
+
var checkIdentifier = function checkIdentifier(node) {
|
|
170
|
+
if (node.type !== 'Identifier' || node.parent.type !== 'JSXExpressionContainer') {
|
|
171
|
+
return;
|
|
172
|
+
}
|
|
173
|
+
for (var _i4 = 0, _Object$entries3 = Object.entries(importErrors); _i4 < _Object$entries3.length; _i4++) {
|
|
174
|
+
var _Object$entries3$_i = _slicedToArray(_Object$entries3[_i4], 2),
|
|
175
|
+
importSource = _Object$entries3$_i[0],
|
|
176
|
+
error = _Object$entries3$_i[1];
|
|
177
|
+
var importIconName = error.node.specifiers[0].local.name;
|
|
178
|
+
var iconName = node.name;
|
|
179
|
+
if (iconName === importIconName) {
|
|
180
|
+
if (identifiers.has(importSource)) {
|
|
181
|
+
var _identifiers$get;
|
|
182
|
+
(_identifiers$get = identifiers.get(importSource)) === null || _identifiers$get === void 0 || _identifiers$get.push(node);
|
|
183
|
+
} else {
|
|
184
|
+
identifiers.set(importSource, [node]);
|
|
185
|
+
}
|
|
186
|
+
break;
|
|
187
|
+
}
|
|
188
|
+
}
|
|
189
|
+
};
|
|
190
|
+
return {
|
|
191
|
+
createImportError: createImportError,
|
|
192
|
+
createExportError: createExportError,
|
|
193
|
+
checkJSXElement: checkJSXElement,
|
|
194
|
+
checkIdentifier: checkIdentifier,
|
|
195
|
+
throwErrors: throwErrors
|
|
196
|
+
};
|
|
197
|
+
};
|
|
@@ -1,7 +1,3 @@
|
|
|
1
|
-
import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
|
|
2
|
-
function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
|
|
3
|
-
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
|
|
4
|
-
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
|
|
5
1
|
/**
|
|
6
2
|
* Forked from original `no-restricted-imports` although the source has been substantially changed.
|
|
7
3
|
*
|
|
@@ -29,22 +25,20 @@ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length)
|
|
|
29
25
|
* THE SOFTWARE.
|
|
30
26
|
*/
|
|
31
27
|
|
|
32
|
-
import {
|
|
33
|
-
import {
|
|
34
|
-
import {
|
|
28
|
+
import { createLintRule } from '../utils/create-rule';
|
|
29
|
+
import { errorBoundary } from '../utils/error-boundary';
|
|
30
|
+
import { createChecks } from './checks';
|
|
35
31
|
export var name = 'no-deprecated-imports';
|
|
36
|
-
|
|
37
|
-
export var pathWithCustomMessageId = 'pathWithCustomMessage';
|
|
38
|
-
var rule = createRule({
|
|
39
|
-
name: name,
|
|
40
|
-
defaultOptions: [{
|
|
41
|
-
deprecatedConfig: getConfig('imports')
|
|
42
|
-
}],
|
|
32
|
+
var rule = createLintRule({
|
|
43
33
|
meta: {
|
|
34
|
+
name: name,
|
|
35
|
+
fixable: 'code',
|
|
36
|
+
hasSuggestions: true,
|
|
44
37
|
type: 'suggestion',
|
|
45
38
|
docs: {
|
|
46
39
|
description: 'Disallow importing deprecated modules.',
|
|
47
|
-
recommended:
|
|
40
|
+
recommended: true,
|
|
41
|
+
severity: 'error'
|
|
48
42
|
},
|
|
49
43
|
messages: {
|
|
50
44
|
pathWithCustomMessage: "'{{importSource}}' import is restricted from being used. {{customMessage}}",
|
|
@@ -84,108 +78,20 @@ var rule = createRule({
|
|
|
84
78
|
}
|
|
85
79
|
}]
|
|
86
80
|
},
|
|
87
|
-
create: function create(context
|
|
88
|
-
var
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
* @param {Map<string,TSESTree.Node>} importNames Map of import names that are being imported
|
|
102
|
-
* @returns {void}
|
|
103
|
-
* @private
|
|
104
|
-
*/
|
|
105
|
-
function checkRestrictedPathAndReport(importSource, node, importNames) {
|
|
106
|
-
if (!Object.prototype.hasOwnProperty.call(restrictedPathMessages, importSource)) {
|
|
107
|
-
return;
|
|
108
|
-
}
|
|
109
|
-
var config = restrictedPathMessages[importSource];
|
|
110
|
-
|
|
111
|
-
// The message will only exist if the import is completely banned,
|
|
112
|
-
// eg a deprecated package
|
|
113
|
-
if ('message' in config) {
|
|
114
|
-
context.report({
|
|
115
|
-
node: node,
|
|
116
|
-
messageId: pathWithCustomMessageId,
|
|
117
|
-
data: {
|
|
118
|
-
importSource: importSource,
|
|
119
|
-
customMessage: config.message
|
|
120
|
-
}
|
|
121
|
-
});
|
|
122
|
-
}
|
|
123
|
-
|
|
124
|
-
// if there are specific named exports that are banned,
|
|
125
|
-
// iterate through and check if they're being imported
|
|
126
|
-
if ('importSpecifiers' in config) {
|
|
127
|
-
var _config$importSpecifi;
|
|
128
|
-
(_config$importSpecifi = config.importSpecifiers) === null || _config$importSpecifi === void 0 || _config$importSpecifi.forEach(function (restrictedImport) {
|
|
129
|
-
if (importNames.has(restrictedImport.importName)) {
|
|
130
|
-
context.report({
|
|
131
|
-
node: importNames.get(restrictedImport.importName),
|
|
132
|
-
messageId: importNameWithCustomMessageId,
|
|
133
|
-
data: {
|
|
134
|
-
importName: restrictedImport.importName,
|
|
135
|
-
importSource: importSource,
|
|
136
|
-
customMessage: restrictedImport.message
|
|
137
|
-
}
|
|
138
|
-
});
|
|
139
|
-
}
|
|
140
|
-
});
|
|
141
|
-
}
|
|
142
|
-
}
|
|
143
|
-
|
|
144
|
-
/**
|
|
145
|
-
* Checks a node to see if any problems should be reported.
|
|
146
|
-
* @param {ASTNode} node The node to check.
|
|
147
|
-
* @returns {void}
|
|
148
|
-
* @private
|
|
149
|
-
*/
|
|
150
|
-
var checkNode = function checkNode(node) {
|
|
151
|
-
var importSource = node.source.value.trim();
|
|
152
|
-
var importNames = new Map();
|
|
153
|
-
if ('specifiers' in node) {
|
|
154
|
-
var _iterator = _createForOfIteratorHelper(node.specifiers),
|
|
155
|
-
_step;
|
|
156
|
-
try {
|
|
157
|
-
for (_iterator.s(); !(_step = _iterator.n()).done;) {
|
|
158
|
-
var specifier = _step.value;
|
|
159
|
-
var _name = void 0;
|
|
160
|
-
if (specifier.type === 'ImportDefaultSpecifier') {
|
|
161
|
-
_name = 'default';
|
|
162
|
-
} else if (specifier.type === 'ImportNamespaceSpecifier') {
|
|
163
|
-
_name = '*';
|
|
164
|
-
} else if (specifier.type === 'ImportSpecifier') {
|
|
165
|
-
_name = specifier.imported.name;
|
|
166
|
-
} else if (specifier.local) {
|
|
167
|
-
_name = specifier.local.name;
|
|
168
|
-
}
|
|
169
|
-
if (_name) {
|
|
170
|
-
importNames.set(_name, specifier);
|
|
171
|
-
}
|
|
172
|
-
}
|
|
173
|
-
} catch (err) {
|
|
174
|
-
_iterator.e(err);
|
|
175
|
-
} finally {
|
|
176
|
-
_iterator.f();
|
|
177
|
-
}
|
|
178
|
-
}
|
|
179
|
-
checkRestrictedPathAndReport(importSource, node, importNames);
|
|
180
|
-
};
|
|
181
|
-
return {
|
|
182
|
-
ImportDeclaration: checkNode,
|
|
183
|
-
ExportNamedDeclaration: function ExportNamedDeclaration(node) {
|
|
184
|
-
if (node.source) {
|
|
185
|
-
checkNode(node);
|
|
186
|
-
}
|
|
187
|
-
}
|
|
188
|
-
};
|
|
81
|
+
create: function create(context) {
|
|
82
|
+
var _createChecks = createChecks(context),
|
|
83
|
+
checkImportNode = _createChecks.checkImportNode,
|
|
84
|
+
checkExportNode = _createChecks.checkExportNode,
|
|
85
|
+
checkJSXElement = _createChecks.checkJSXElement,
|
|
86
|
+
checkIdentifier = _createChecks.checkIdentifier,
|
|
87
|
+
throwErrors = _createChecks.throwErrors;
|
|
88
|
+
return errorBoundary({
|
|
89
|
+
ImportDeclaration: checkImportNode,
|
|
90
|
+
ExportNamedDeclaration: checkExportNode,
|
|
91
|
+
JSXElement: checkJSXElement,
|
|
92
|
+
Identifier: checkIdentifier,
|
|
93
|
+
'Program:exit': throwErrors
|
|
94
|
+
});
|
|
189
95
|
}
|
|
190
96
|
});
|
|
191
97
|
export default rule;
|