eslint-plugin-export-scope

Disallows importing scoped exports outside their scope.

⚠️ VSCode ESLint Server may need to be restarted when accessibility declarations are updated.

Usage Example

// 👇 default file delaration.
// All exports in this file without a local declaration
// 👇 will only be availabe within this dir and subdirs by default
/** @scope default . */

// 👇 Available everywhere. Only useful in Strict Mode
/** @scope * */
export const helper1 = "";

// 👇 infers availability from the default scope above
export const helper2 = "";

// 👇 this export will be available starting from 2 dirs up and in all subdirs
/** @scope ../.. */
export default "";

Any type of comment / JSDoc can be used. Only JSDoc offers syntax highlighting in VSCode.

// @scope .
/* @scope . */
/** @scope . */
export default "";

Installation

Install ESLint and the ESLint plugin:

npm i -D eslint eslint-plugin-export-scope

Add export-scope to the plugins section of your .eslintrc or .eslintrc.js configuration file.

⚠ parserOptions.project is required for this plugin. If linting doesn't work, try adding "include": ["**/*"] to tscofig.json and .eslintrc* to .eslintignore

{
  "parser": "@typescript-eslint/parser",
  "parserOptions": { "project": "./tsconfig.json" },
  "plugins": ["export-scope"],
  "rules": {
    "export-scope/no-imports-outside-export-scope": ["error", { "strictMode": false }]
  }
}

Add TypeScript plugin to your tsconfig.json. This will hide inaccessible exports from VSCode autocomplete suggestions.

⚠ You need to tell VSCode to Use Workspace Version of TypeScript. Otherwise this plugin won't work.

"compilerOptions": {
  "plugins": [
    { "name": "eslint-plugin-export-scope", "strictMode": false }
  ],
}

Strict Mode

You can set strictMode to true in both tsconfig.json and .eslintrc to activate the Strict Mode.

Strict Mode restricts all exports to the export directory (and subdirectories) by default. index files are accessible one level above the export directory. Default behaviour can be overriden with @scope properties.

Path Tags

Default export scope can also be declared by adding @ to folder/file names: