Skip to content
This repository was archived by the owner on May 12, 2025. It is now read-only.

Commit 7043ab7

Browse files
committed
Update README.md
1 parent 741a55b commit 7043ab7

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,24 +49,24 @@ app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(spec));
4949
```
5050

5151
### Configuration options
52-
There are a few configuring options. For example, including and excluding certain
53-
files and paths:
52+
There are several configuration options for parsing. For example, including and
53+
excluding certain files and paths:
5454
```js
5555
const spec = openapi({
5656
exclude: ['**/some/path/**']
5757
});
5858
```
5959

6060
#### Options
61-
| Option name | Default |
62-
| ----------- | ------- |
63-
| `root` | The directory where `commentParser` was called |
64-
| `extension` | `['.js', '.cjs', '.mjs', '.ts', '.tsx', '.jsx', '.yaml', '.yml']` |
65-
| `include` | `['**']`|
66-
| `exclude` | A large list that covers tests, coverage, and various development configs |
61+
| Option name | Default |
62+
| -------------------- | ------- |
63+
| `cwd` | The directory where `commentParser` was called |
64+
| `extension` | `['.js', '.cjs', '.mjs', '.ts', '.tsx', '.jsx', '.yaml', '.yml']` |
65+
| `include` | `['**']`|
66+
| `exclude` | A large list that covers tests, coverage, and various development configs |
6767
| `excludeNodeModules` | `true` |
68-
| `verbose` | `true` |
69-
| `throwLevel` | `off` |
68+
| `verbose` | `true` |
69+
| `throwLevel` | `off` |
7070

7171

7272
## Eslint plugin

0 commit comments

Comments
 (0)