mdast-util-from-markdown - npm Package Compare versions

Comparing version 1.2.1 to 1.3.0

dev/index.d.ts

@@ -1,15 +0,78 @@
-export {fromMarkdown} from './lib/index.js'
-export type CompileContext = import('./lib/index.js').CompileContext
-export type Encoding = import('./lib/index.js').Encoding
-export type Extension = import('./lib/index.js').Extension
-export type Handle = import('./lib/index.js').Handle
-export type OnEnterError = import('./lib/index.js').OnEnterError
-export type OnExitError = import('./lib/index.js').OnExitError
-export type Options = import('./lib/index.js').Options
-export type Token = import('./lib/index.js').Token
-export type Transform = import('./lib/index.js').Transform
-export type Value = import('./lib/index.js').Value
+import type {OnEnterError} from './lib/index.js'
+
+export type {
+  CompileContext,
+  Encoding,
+  Extension,
+  Handle,
+  OnEnterError,
+  OnExitError,
+  Options,
+  Token,
+  Transform,
+  Value
+} from './lib/index.js'
+
 /**
- * To do: next major: remove.
+ * Deprecated: use `OnEnterError`.
  */
-export type OnError = import('./lib/index.js').OnEnterError
+// To do: next major: remove.
+export type OnError = OnEnterError
+
+/**
+ * Interface of tracked data.
+ *
+ * When working on extensions that use more data, extend the corresponding
+ * interface to register their types:
+ *
+ * ```ts
+ * declare module 'mdast-util-from-markdown' {
+ *   interface CompileData {
+ *     // Register a new field.
+ *     mathFlowInside?: boolean | undefined
+ *   }
+ * }
+ * ```
+ */
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+export interface CompileData {
+  /**
+   * Whether we’re inside a hard break.
+   */
+  atHardBreak?: boolean | undefined
+
+  /**
+   * Current character reference type.
+   */
+  characterReferenceType?:
+    | 'characterReferenceMarkerHexadecimal'
+    | 'characterReferenceMarkerNumeric'
+    | undefined
+
+  /**
+   * Whether a first list item value (`1` in `1. a`) is expected.
+   */
+  expectingFirstListItemValue?: boolean | undefined
+
+  /**
+   * Whether we’re in flow code.
+   */
+  flowCodeInside?: boolean | undefined
+
+  /**
+   * Whether we’re in a reference.
+   */
+  inReference?: boolean | undefined
+
+  /**
+   * Whether we’re expecting a line ending from a setext heading, which can be slurped.
+   */
+  setextHeadingSlurpLineEnding?: boolean | undefined
+
+  /**
+   * Current reference.
+   */
+  referenceType?: 'collapsed' | 'full' | undefined
+}
+
+export {fromMarkdown} from './lib/index.js'

dev/index.js

@@ -1,19 +0,2 @@
-/**
- * @typedef {import('./lib/index.js').CompileContext} CompileContext
- * @typedef {import('./lib/index.js').Encoding} Encoding
- * @typedef {import('./lib/index.js').Extension} Extension
- * @typedef {import('./lib/index.js').Handle} Handle
- * @typedef {import('./lib/index.js').OnEnterError} OnEnterError
- * @typedef {import('./lib/index.js').OnExitError} OnExitError
- * @typedef {import('./lib/index.js').Options} Options
- * @typedef {import('./lib/index.js').Token} Token
- * @typedef {import('./lib/index.js').Transform} Transform
- * @typedef {import('./lib/index.js').Value} Value
- */
-
-/**
- * @typedef {import('./lib/index.js').OnEnterError} OnError
- *   To do: next major: remove.
- */
-
+// Note: types exported from `index.d.ts`.
 export {fromMarkdown} from './lib/index.js'

dev/lib/index.d.ts

@@ -48,2 +48,3 @@ /**
 export type ReferenceType = import('mdast').ReferenceType
+export type CompileData = import('../index.js').CompileData
 export type Node = Root | Content
@@ -56,38 +57,2 @@ export type Parent = Extract<Node, UnistParent>
 /**
- * State.
- */
-export type CompileData = {
-  /**
-   * Whether we’re inside a hard break.
-   */
-  atHardBreak?: boolean | undefined
-  /**
-   * Current character reference type.
-   */
-  characterReferenceType?:
-    | 'characterReferenceMarkerHexadecimal'
-    | 'characterReferenceMarkerNumeric'
-    | undefined
-  /**
-   * Whether a first list item value (`1` in `1. a`) is expected.
-   */
-  expectingFirstListItemValue?: boolean | undefined
-  /**
-   * Whether we’re in flow code.
-   */
-  flowCodeInside?: boolean | undefined
-  /**
-   * Whether we’re in a reference.
-   */
-  inReference?: boolean | undefined
-  /**
-   * Whether we’re expecting a line ending from a setext heading, which can be slurped.
-   */
-  setextHeadingSlurpLineEnding?: boolean | undefined
-  /**
-   * Current reference.
-   */
-  referenceType?: 'collapsed' | 'full' | undefined
-}
-/**
  * Extra transform, to change the AST afterwards.
@@ -169,9 +134,11 @@ */
    */
-  getData: <Key extends keyof CompileData>(key: Key) => CompileData[Key]
+  getData: <Key extends keyof import('../index.js').CompileData>(
+    key: Key
+  ) => import('../index.js').CompileData[Key]
   /**
    *   Set data into the key/value store.
    */
-  setData: <Key_1 extends keyof CompileData>(
+  setData: <Key_1 extends keyof import('../index.js').CompileData>(
     key: Key_1,
-    value?: CompileData[Key_1] | undefined
+    value?: import('../index.js').CompileData[Key_1] | undefined
   ) => void
@@ -178,0 +145,0 @@ /**

dev/lib/index.js

@@ -35,2 +35,3 @@ /**
  * @typedef {import('mdast').ReferenceType} ReferenceType
+ * @typedef {import('../index.js').CompileData} CompileData
  */
@@ -46,19 +47,2 @@
 /**
- * @typedef CompileData
- *   State.
- * @property {boolean | undefined} [atHardBreak]
- *   Whether we’re inside a hard break.
- * @property {'characterReferenceMarkerHexadecimal' | 'characterReferenceMarkerNumeric' | undefined} [characterReferenceType]
- *   Current character reference type.
- * @property {boolean | undefined} [expectingFirstListItemValue]
- *   Whether a first list item value (`1` in `1. a`) is expected.
- * @property {boolean | undefined} [flowCodeInside]
- *   Whether we’re in flow code.
- * @property {boolean | undefined} [inReference]
- *   Whether we’re in a reference.
- * @property {boolean | undefined} [setextHeadingSlurpLineEnding]
- *   Whether we’re expecting a line ending from a setext heading, which can be slurped.
- * @property {'collapsed' | 'full' | undefined} [referenceType]
- *   Current reference.
- *
  * @callback Transform
@@ -65,0 +49,0 @@ *   Extra transform, to change the AST afterwards.

index.d.ts

@@ -1,15 +0,78 @@
-export {fromMarkdown} from './lib/index.js'
-export type CompileContext = import('./lib/index.js').CompileContext
-export type Encoding = import('./lib/index.js').Encoding
-export type Extension = import('./lib/index.js').Extension
-export type Handle = import('./lib/index.js').Handle
-export type OnEnterError = import('./lib/index.js').OnEnterError
-export type OnExitError = import('./lib/index.js').OnExitError
-export type Options = import('./lib/index.js').Options
-export type Token = import('./lib/index.js').Token
-export type Transform = import('./lib/index.js').Transform
-export type Value = import('./lib/index.js').Value
+import type {OnEnterError} from './lib/index.js'
+
+export type {
+  CompileContext,
+  Encoding,
+  Extension,
+  Handle,
+  OnEnterError,
+  OnExitError,
+  Options,
+  Token,
+  Transform,
+  Value
+} from './lib/index.js'
+
 /**
- * To do: next major: remove.
+ * Deprecated: use `OnEnterError`.
  */
-export type OnError = import('./lib/index.js').OnEnterError
+// To do: next major: remove.
+export type OnError = OnEnterError
+
+/**
+ * Interface of tracked data.
+ *
+ * When working on extensions that use more data, extend the corresponding
+ * interface to register their types:
+ *
+ * ```ts
+ * declare module 'mdast-util-from-markdown' {
+ *   interface CompileData {
+ *     // Register a new field.
+ *     mathFlowInside?: boolean | undefined
+ *   }
+ * }
+ * ```
+ */
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+export interface CompileData {
+  /**
+   * Whether we’re inside a hard break.
+   */
+  atHardBreak?: boolean | undefined
+
+  /**
+   * Current character reference type.
+   */
+  characterReferenceType?:
+    | 'characterReferenceMarkerHexadecimal'
+    | 'characterReferenceMarkerNumeric'
+    | undefined
+
+  /**
+   * Whether a first list item value (`1` in `1. a`) is expected.
+   */
+  expectingFirstListItemValue?: boolean | undefined
+
+  /**
+   * Whether we’re in flow code.
+   */
+  flowCodeInside?: boolean | undefined
+
+  /**
+   * Whether we’re in a reference.
+   */
+  inReference?: boolean | undefined
+
+  /**
+   * Whether we’re expecting a line ending from a setext heading, which can be slurped.
+   */
+  setextHeadingSlurpLineEnding?: boolean | undefined
+
+  /**
+   * Current reference.
+   */
+  referenceType?: 'collapsed' | 'full' | undefined
+}
+
+export {fromMarkdown} from './lib/index.js'

index.js

@@ -1,19 +0,2 @@
-/**
- * @typedef {import('./lib/index.js').CompileContext} CompileContext
- * @typedef {import('./lib/index.js').Encoding} Encoding
- * @typedef {import('./lib/index.js').Extension} Extension
- * @typedef {import('./lib/index.js').Handle} Handle
- * @typedef {import('./lib/index.js').OnEnterError} OnEnterError
- * @typedef {import('./lib/index.js').OnExitError} OnExitError
- * @typedef {import('./lib/index.js').Options} Options
- * @typedef {import('./lib/index.js').Token} Token
- * @typedef {import('./lib/index.js').Transform} Transform
- * @typedef {import('./lib/index.js').Value} Value
- */
-
-/**
- * @typedef {import('./lib/index.js').OnEnterError} OnError
- *   To do: next major: remove.
- */
-
+// Note: types exported from `index.d.ts`.
 export {fromMarkdown} from './lib/index.js'

lib/index.d.ts

@@ -48,2 +48,3 @@ /**
 export type ReferenceType = import('mdast').ReferenceType
+export type CompileData = import('../index.js').CompileData
 export type Node = Root | Content
@@ -56,38 +57,2 @@ export type Parent = Extract<Node, UnistParent>
 /**
- * State.
- */
-export type CompileData = {
-  /**
-   * Whether we’re inside a hard break.
-   */
-  atHardBreak?: boolean | undefined
-  /**
-   * Current character reference type.
-   */
-  characterReferenceType?:
-    | 'characterReferenceMarkerHexadecimal'
-    | 'characterReferenceMarkerNumeric'
-    | undefined
-  /**
-   * Whether a first list item value (`1` in `1. a`) is expected.
-   */
-  expectingFirstListItemValue?: boolean | undefined
-  /**
-   * Whether we’re in flow code.
-   */
-  flowCodeInside?: boolean | undefined
-  /**
-   * Whether we’re in a reference.
-   */
-  inReference?: boolean | undefined
-  /**
-   * Whether we’re expecting a line ending from a setext heading, which can be slurped.
-   */
-  setextHeadingSlurpLineEnding?: boolean | undefined
-  /**
-   * Current reference.
-   */
-  referenceType?: 'collapsed' | 'full' | undefined
-}
-/**
  * Extra transform, to change the AST afterwards.
@@ -169,9 +134,11 @@ */
    */
-  getData: <Key extends keyof CompileData>(key: Key) => CompileData[Key]
+  getData: <Key extends keyof import('../index.js').CompileData>(
+    key: Key
+  ) => import('../index.js').CompileData[Key]
   /**
    *   Set data into the key/value store.
    */
-  setData: <Key_1 extends keyof CompileData>(
+  setData: <Key_1 extends keyof import('../index.js').CompileData>(
     key: Key_1,
-    value?: CompileData[Key_1] | undefined
+    value?: import('../index.js').CompileData[Key_1] | undefined
   ) => void
@@ -178,0 +145,0 @@ /**

lib/index.js

@@ -35,2 +35,3 @@ /**
  * @typedef {import('mdast').ReferenceType} ReferenceType
+ * @typedef {import('../index.js').CompileData} CompileData
  */
@@ -46,19 +47,2 @@
 /**
- * @typedef CompileData
- *   State.
- * @property {boolean | undefined} [atHardBreak]
- *   Whether we’re inside a hard break.
- * @property {'characterReferenceMarkerHexadecimal' | 'characterReferenceMarkerNumeric' | undefined} [characterReferenceType]
- *   Current character reference type.
- * @property {boolean | undefined} [expectingFirstListItemValue]
- *   Whether a first list item value (`1` in `1. a`) is expected.
- * @property {boolean | undefined} [flowCodeInside]
- *   Whether we’re in flow code.
- * @property {boolean | undefined} [inReference]
- *   Whether we’re in a reference.
- * @property {boolean | undefined} [setextHeadingSlurpLineEnding]
- *   Whether we’re expecting a line ending from a setext heading, which can be slurped.
- * @property {'collapsed' | 'full' | undefined} [referenceType]
- *   Current reference.
- *
  * @callback Transform
@@ -65,0 +49,0 @@ *   Extra transform, to change the AST afterwards.

package.json

 {
   "name": "mdast-util-from-markdown",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "mdast utility to parse markdown",
@@ -5,0 +5,0 @@ "license": "MIT",

readme.md

@@ -22,2 +22,3 @@ # mdast-util-from-markdown
     *   [`CompileContext`](#compilecontext)
+    *   [`CompileData`](#compiledata)
     *   [`Encoding`](#encoding)
@@ -173,5 +174,5 @@ *   [`Extension`](#extension)
 *   `getData` (`(key: string) => unknown`)
-    — get data from the key/value store
+    — get data from the key/value store (see [`CompileData`][api-compiledata])
 *   `setData` (`(key: string, value?: unknown) => void`)
-    — set data into the key/value store
+    — set data into the key/value store (see [`CompileData`][api-compiledata])
 *   `buffer` (`() => void`)
@@ -190,2 +191,24 @@ — capture some of the output data
 
+### `CompileData`
+
+Interface of tracked data (TypeScript type).
+
+###### Type
+
+```ts
+interface CompileData { /* see code */ }
+```
+
+When working on extensions that use more data, extend the corresponding
+interface to register their types:
+
+```ts
+declare module 'mdast-util-from-markdown' {
+  interface CompileData {
+    // Register a new field.
+    mathFlowInside?: boolean | undefined
+  }
+}
+```
+
 ### `Encoding`
@@ -369,2 +392,3 @@
 It exports the additional types [`CompileContext`][api-compilecontext],
+[`CompileData`][api-compiledata],
 [`Encoding`][api-encoding],
@@ -506,2 +530,4 @@ [`Extension`][api-extension],
 
+[api-compiledata]: #compiledata
+
 [api-encoding]: #encoding
@@ -508,0 +534,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

545

increased by5.01%

Worsened metrics

Total package byte prevSize

107687

decreased by-1.72%

Lines of code

3106

decreased by-0.7%

No dependency changes