eslint-plugin-export-default-identifier
v0.3.0
Published
eslint plugin to ensure that export default must export an identifier.
Downloads
1,563
Readme
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() {}