no-restricted-exports.md

title	rule_type
no-restricted-exports	suggestion

In a project, certain names may be disallowed from being used as exported names for various reasons.

Rule Details

This rule disallows specified names from being used as exported names.

Options

By default, this rule doesn't disallow any names. Only the names you specify in the configuration will be disallowed.

This rule has an object option:

• "restrictedNamedExports" is an array of strings, where each string is a name to be restricted.
• "restrictDefaultExports" is an object option with boolean properties to restrict certain default export declarations. The option works only if the restrictedNamedExports option does not contain the "default" value. The following properties are allowed:
  • direct: restricts export default declarations.
  • named: restricts export { foo as default }; declarations.
  • defaultFrom: restricts export { default } from 'foo'; declarations.
  • namedFrom: restricts export { foo as default } from 'foo'; declarations.
  • namespaceFrom: restricts export * as default from 'foo'; declarations.

restrictedNamedExports

Examples of incorrect code for the "restrictedNamedExports" option:

::: incorrect

/*eslint no-restricted-exports: ["error", {
    "restrictedNamedExports": ["foo", "bar", "Baz", "a", "b", "c", "d", "e", "👍"]
}]*/

export const foo = 1;

export function bar() {}

export class Baz {}

const a = {};
export { a };

function someFunction() {}
export { someFunction as b };

export { c } from "some_module";

export { "d" } from "some_module";

export { something as e } from "some_module";

export { "👍" } from "some_module";

:::

Examples of correct code for the "restrictedNamedExports" option:

::: correct

/*eslint no-restricted-exports: ["error", {
    "restrictedNamedExports": ["foo", "bar", "Baz", "a", "b", "c", "d", "e", "👍"]
}]*/

export const quux = 1;

export function myFunction() {}

export class MyClass {}

const a = {};
export { a as myObject };

function someFunction() {}
export { someFunction };

export { c as someName } from "some_module";

export { "d" as " d " } from "some_module";

export { something } from "some_module";

export { "👍" as thumbsUp } from "some_module";

:::

Default exports

By design, the "restrictedNamedExports" option doesn't disallow export default declarations. If you configure "default" as a restricted name, that restriction will apply only to named export declarations.

Examples of additional incorrect code for the "restrictedNamedExports": ["default"] option:

::: incorrect

/*eslint no-restricted-exports: ["error", { "restrictedNamedExports": ["default"] }]*/

function foo() {}

export { foo as default };

:::

::: incorrect

/*eslint no-restricted-exports: ["error", { "restrictedNamedExports": ["default"] }]*/

export { default } from "some_module";

:::

Examples of additional correct code for the "restrictedNamedExports": ["default"] option:

::: correct

/*eslint no-restricted-exports: ["error", { "restrictedNamedExports": ["default", "foo"] }]*/

export default function foo() {}

:::

restrictDefaultExports

This option allows you to restrict certain default declarations. The option works only if the restrictedNamedExports option does not contain the "default" value. This option accepts the following properties:

direct

Examples of incorrect code for the "restrictDefaultExports": { "direct": true } option:

::: incorrect

/*eslint no-restricted-exports: ["error", { "restrictDefaultExports": { "direct": true } }]*/

export default foo;
export default 42;
export default function foo() {}

:::

named

Examples of incorrect code for the "restrictDefaultExports": { "named": true } option:

::: incorrect

/*eslint no-restricted-exports: ["error", { "restrictDefaultExports": { "named": true } }]*/

const foo = 123;

export { foo as default };

:::

defaultFrom

Examples of incorrect code for the "restrictDefaultExports": { "defaultFrom": true } option:

::: incorrect

/*eslint no-restricted-exports: ["error", { "restrictDefaultExports": { "defaultFrom": true } }]*/

export { default } from 'foo';
export { default as default } from 'foo';

:::

namedFrom

Examples of incorrect code for the "restrictDefaultExports": { "namedFrom": true } option:

::: incorrect

/*eslint no-restricted-exports: ["error", { "restrictDefaultExports": { "namedFrom": true } }]*/

export { foo as default } from 'foo';

:::

namespaceFrom

Examples of incorrect code for the "restrictDefaultExports": { "namespaceFrom": true } option:

::: incorrect

/*eslint no-restricted-exports: ["error", { "restrictDefaultExports": { "namespaceFrom": true } }]*/

export * as default from 'foo';

:::

Known Limitations

This rule doesn't inspect the content of source modules in re-export declarations. In particular, if you are re-exporting everything from another module's export, that export may include a restricted name. This rule cannot detect such cases.

//----- some_module.js -----
export function foo() {}

//----- my_module.js -----
/*eslint no-restricted-exports: ["error", { "restrictedNamedExports": ["foo"] }]*/

export * from "some_module"; // allowed, although this declaration exports "foo" from my_module