Skip to content

eslint plugin that ensures that export default always exports an identifier.

Notifications You must be signed in to change notification settings

cybersemics/eslint-plugin-export-default-identifier

Repository files navigation

export-default-identifier

An eslint plugin that only allows export default to export specific types of expressions.

By default, only allows Identifier expressions, i.e. named variables. Excludes all anonymous classes, functions, and objects. This was originally created for use with TypeDoc, which does not generate proper JSDOC documentation for anonymous export defaults.

NOTE: Equivalent to import/no-anonymous-default-export:

"import/no-anonymous-default-export": ["error", {
  "allowArray": false,
  "allowArrowFunction": false,
  "allowAnonymousClass": false,
  "allowAnonymousFunction": false,
  "allowCallExpression": false,
  "allowLiteral": false,
  "allowObject": false
}]

Install

npm install --save-dev export-default-identifier

Usage

Add to your .eslintrc.json:

{
  "plugins": [
    "export-default-identifier",
  ],
  ...
  "rules": {
    "export-default-identifier/export-default-identifier": "error"
  }
}

Specify exactly which types can be exported as default:

"export-default-identifier/export-default-identifier": ["error", {
  "types": ["Identifier"]
}]

Rule details

❌ Examples of incorrect code:

export default {}
export default function test() {}

✔️ Examples of correct code:

const myExport = {}
export default myExport

❌ Examples of incorrect code with [{"types":["Identifier","FunctionDeclaration"]}] options:

export default {}

✔️ Examples of correct code with [{"types":["Identifier","FunctionDeclaration"]}] options:

const myExport = {}
export default myExport

export default function test() {}

Resources

About

eslint plugin that ensures that export default always exports an identifier.

Topics

Resources

Stars

Watchers

Forks