types: add support for boolean plugin options

Reviewed-by: Christian Murphy <christian.murphy.42@gmail.com> Closes GH-145.
unifiedjs · Jul 4, 2021 · 4bfd6c8 · 4bfd6c8
1 parent 45eb72e
commit 4bfd6c8
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 6 deletions.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -17,7 +17,7 @@ export interface Processor<P = Settings> extends FrozenProcessor<P> {
    * @typeParam S Plugin settings
    * @returns The processor on which use is called
    */
-  use<S extends any[] = [Settings?]>(
+  use<S extends any[] = [(Settings | boolean)?]>(
     plugin: Plugin<S, P>,
     ...settings: S
   ): Processor<P>
@@ -221,7 +221,10 @@ export interface FrozenProcessor<P = Settings> {
  * @typeParam P Processor settings
  * @returns Optional Transformer.
  */
-export type Plugin<S extends any[] = [Settings?], P = Settings> = Attacher<S, P>
+export type Plugin<
+  S extends any[] = [(Settings | boolean)?],
+  P = Settings
+> = Attacher<S, P>
 
 /**
  * Configuration passed to a Plugin or Processor
@@ -256,10 +259,10 @@ export interface ProcessorSettings<P = Settings> {
  * @typeParam S Plugin settings
  * @typeParam P Processor settings
  */
-export type PluginTuple<S extends any[] = [Settings?], P = Settings> = [
-  Plugin<S, P>,
-  ...S
-]
+export type PluginTuple<
+  S extends any[] = [(Settings | boolean)?],
+  P = Settings
+> = [Plugin<S, P>, ...S]
 
 /**
  * A union of the different ways to add plugins to unified

diff --git a/types/unified-tests.ts b/types/unified-tests.ts
@@ -77,6 +77,12 @@ processor.use([
   [plugin, settings],
   [plugin, settings]
 ])
+processor.use(plugin, true)
+processor.use(plugin, false)
+processor.use([
+  [plugin, true],
+  [plugin, false]
+])
 
 processor.use(parserPlugin)
 processor.use(parserPlugin).use(parserPlugin)