Skip to content

Commit 60a6ea7

Browse files
committed
feat: export Ignore symbol
1 parent 9a92f16 commit 60a6ea7

File tree

3 files changed

+13
-1
lines changed

3 files changed

+13
-1
lines changed

index.js

+1
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,6 @@
1313

1414
// it’s mostly private, but useful for tools like `eslint-mdx`.
1515
export {Configuration} from './lib/configuration.js'
16+
export {Ignore} from './lib/ignore.js'
1617

1718
export {engine} from './lib/index.js'

readme.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
* [API](#api)
2020
* [`engine(options, callback)`](#engineoptions-callback)
2121
* [`Configuration`](#configuration)
22+
* [`Ignore`](#ignore)
2223
* [`Completer`](#completer)
2324
* [`Callback`](#callback)
2425
* [`ConfigResult`](#configresult)
@@ -150,7 +151,7 @@ function done(error, code) {
150151

151152
## API
152153

153-
This package exports the identifiers [`Configuration`][api-configuration] and
154+
This package exports the identifiers [`Configuration`][api-configuration], [`Ignore`][api-ignore] and
154155
[`engine`][api-engine].
155156
There is no default export.
156157

@@ -175,6 +176,13 @@ Internal class to load configuration files.
175176

176177
Exposed to build more complex integrations.
177178

179+
### `Ignore`
180+
181+
Internal class to load ignore file for checking
182+
whether this file should be ignored.
183+
184+
Exposed to build more complex integrations.
185+
178186
###### Parameters
179187

180188
* `options` (subset of [`Options`][api-options], required)
@@ -1595,6 +1603,8 @@ abide by its terms.
15951603
15961604
[api-file-set]: #fileset
15971605
1606+
[api-ignore]: #ignore
1607+
15981608
[api-options]: #options
15991609
16001610
[api-preset]: #preset

test/core.js

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ test('engine', async function (t) {
1010
await t.test('should expose the public api', async function () {
1111
assert.deepEqual(Object.keys(await import('unified-engine')).sort(), [
1212
'Configuration',
13+
'Ignore',
1314
'engine'
1415
])
1516
})

0 commit comments

Comments
 (0)