Skip to content

Commit

Permalink
feat: export type for config file
Browse files Browse the repository at this point in the history
  • Loading branch information
bmish committed Nov 22, 2022
1 parent c699064 commit 14d930c
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -158,10 +158,10 @@ There are a few ways to create a config file:

Config files support all the [CLI options](#configuration-options) but in camelCase. CLI options take precedence over config file options.

Example:
Example `.eslint-doc-generatorrc.js`:

```js
// .eslint-doc-generatorrc.js
/** @type {import('eslint-doc-generator').GenerateOptions} */
module.exports = {
ignoreConfig: ['all'],
};
Expand Down
3 changes: 3 additions & 0 deletions lib/index.ts
@@ -0,0 +1,3 @@
// Exported as part of this package's Node API.

export type { GenerateOptions } from './types.js';
1 change: 1 addition & 0 deletions package.json
Expand Up @@ -21,6 +21,7 @@
"license": "ISC",
"author": "Bryan Mishkin",
"type": "module",
"types": "./dist/lib/index.js",
"bin": {
"eslint-doc-generator": "./dist/bin/eslint-doc-generator.js"
},
Expand Down

0 comments on commit 14d930c

Please sign in to comment.