#no-restricted-exports

#Configuration

import { defineConfig, js } from '@rslint/core';

export default defineConfig([
  js.configs.recommended,
  {
    rules: {
      'no-restricted-exports': 'error',
    },
  },
]);

#Rule Details

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

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.
• "restrictedNamedExportsPattern" is a string representing a regular expression pattern. Named exports matching this pattern will be restricted. This option does not apply to default named exports.
• "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:

{ "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:

{ "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:

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

function foo() {}

export { foo as default };

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

export { default } from "some_module";

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

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

export default function foo() {}

#restrictedNamedExportsPattern

Example of incorrect code for the "restrictedNamedExportsPattern" option:

{ "no-restricted-exports": ["error", { "restrictedNamedExportsPattern": "bar$" }] }

export const foobar = 1;

Example of correct code for the "restrictedNamedExportsPattern" option:

{ "no-restricted-exports": ["error", { "restrictedNamedExportsPattern": "bar$" }] }

export const abc = 1;

Note that this option does not apply to export default or any default named exports. If you want to also restrict default exports, use the restrictDefaultExports option.

#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:

{ "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:

{ "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:

{ "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:

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

export { foo as default } from "foo";

#namespaceFrom

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

{ "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 -----
// { "restrictedNamedExports": ["foo"] }
export * from "some_module"; // allowed, although this declaration exports "foo" from my_module

This rule inspects named export declarations purely syntactically, matching ESLint's behavior: named exports of TypeScript-only declarations (interface, type, enum) are not checked, but export type { name } re-export specifiers are checked the same as value exports. A named export of a function declaration with no body is treated the same way, so overload signatures, export declare function, and the function declarations of a .d.ts are left to the implementation signature that carries the body.

export default interface Foo {} is a default export, and so is governed by restrictDefaultExports.direct rather than by restrictedNamedExports.

#Original Documentation

• ESLint: no-restricted-exports
• Source code