Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add restrictedNamedExportsPattern to no-restricted-exports #18431

Merged
merged 9 commits into from
May 14, 2024
Merged

feat: add restrictedNamedExportsPattern to no-restricted-exports #18431

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
965754e
fix: allow glob patterns for `restrictedNamedExports` in `no-restrict…
akulsr0 May 8, 2024
aa547b9
chore: update option name
akulsr0 May 8, 2024
0e66cc8
chore: use regex instead of glob patterns
akulsr0 May 8, 2024
2c4163f
chore: add docs and use set for given regex strings
akulsr0 May 8, 2024
c881975
chore: review changes
akulsr0 May 9, 2024
ac7356f
chore: add correct/incorrect example doc
akulsr0 May 11, 2024
43f0a46
chore: review changes
akulsr0 May 12, 2024
2984afd
chore: review changes
akulsr0 May 13, 2024
9e06882
chore: add default test cases
akulsr0 May 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 28 additions & 1 deletion lib/rules/no-restricted-exports.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,26 @@ module.exports = {
},
additionalProperties: false
},
{
type: "object",
properties: {
restrictedNamedExports: {
type: "array",
items: {
type: "string"
},
uniqueItems: true
},
restrictedNamedExportsPattern: {
type: "array",
items: {
type: "string"
},
uniqueItems: true
}
},
additionalProperties: false
},
mdjermanovic marked this conversation as resolved.
Show resolved Hide resolved
{
type: "object",
properties: {
Expand Down Expand Up @@ -98,6 +118,7 @@ module.exports = {
create(context) {

const restrictedNames = new Set(context.options[0] && context.options[0].restrictedNamedExports);
const restrictedNamePatterns = context.options[0] && context.options[0].restrictedNamedExportsPattern || [];
kecrily marked this conversation as resolved.
Show resolved Hide resolved
const restrictDefaultExports = context.options[0] && context.options[0].restrictDefaultExports;
const sourceCode = context.sourceCode;

Expand All @@ -109,7 +130,13 @@ module.exports = {
function checkExportedName(node) {
const name = astUtils.getModuleExportName(node);

if (restrictedNames.has(name)) {
const hasRestrictedNamePattern = restrictedNamePatterns.some(pattern => {
const patternRegex = new RegExp(pattern, "u");

return name && patternRegex.test(name);
});

if (hasRestrictedNamePattern || restrictedNames.has(name)) {
context.report({
node,
messageId: "restrictedNamed",
Expand Down
35 changes: 35 additions & 0 deletions tests/lib/rules/no-restricted-exports.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ ruleTester.run("no-restricted-exports", rule, {
{ code: "import a from 'foo';", options: [{ restrictedNamedExports: ["a"] }] },
{ code: "import { a } from 'foo';", options: [{ restrictedNamedExports: ["a"] }] },
{ code: "import { b as a } from 'foo';", options: [{ restrictedNamedExports: ["a"] }] },
{
code: "var setSomething; export { setSomething };",
options: [{ restrictedNamedExportsPattern: ["^get"] }]
},
mdjermanovic marked this conversation as resolved.
Show resolved Hide resolved

// does not check re-export all declarations
{ code: "export * from 'foo';", options: [{ restrictedNamedExports: ["a"] }] },
Expand Down Expand Up @@ -533,6 +537,37 @@ ruleTester.run("no-restricted-exports", rule, {
]
},

// restrictedNamedExportsPattern
{
code: "var getSomething; export { getSomething };",
options: [{ restrictedNamedExportsPattern: ["get*"] }],
errors: [
{ messageId: "restrictedNamed", data: { name: "getSomething" }, type: "Identifier" }
]
},
{
code: "var getSomethingFromUser; export { getSomethingFromUser };",
options: [{ restrictedNamedExportsPattern: ["User$"] }],
errors: [
{ messageId: "restrictedNamed", data: { name: "getSomethingFromUser" }, type: "Identifier" }
]
},
{
code: "var foo, ab, xy; export { foo, ab, xy };",
options: [{ restrictedNamedExportsPattern: ["(b|y)$"] }],
errors: [
{ messageId: "restrictedNamed", data: { name: "ab" }, type: "Identifier" },
{ messageId: "restrictedNamed", data: { name: "xy" }, type: "Identifier" }
]
},
{
code: "var foo; export { foo as ab };",
options: [{ restrictedNamedExportsPattern: ["(b|y)$"] }],
errors: [
{ messageId: "restrictedNamed", data: { name: "ab" }, type: "Identifier" }
]
},

// reports "default" in named export declarations (when configured)
{
code: "var a; export { a as default };",
Expand Down