Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-22 05:40:48 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Update markdownlint-micromark to version 0.1.12 (exports labelEnd, additional types, and adds custom TokenTypes).

Browse source
This commit is contained in:
David Anson 2024-10-21 20:19:42 -07:00
parent fea5d886b7
commit 36aaebbf44
4 changed files with 22 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
micromark/exports.mjs
View file

@ -10,3 +10,5 @@ export { math } from "micromark-extension-math";
export { parse } from "micromark"; export { parse } from "micromark";
export { postprocess } from "micromark"; export { postprocess } from "micromark";
export { preprocess } from "micromark"; export { preprocess } from "micromark";
// micromark-core-commonmark is not a dev/dependency because this instance must match what's used by micromark
export { labelEnd } from "micromark-core-commonmark";

15
micromark/micromark.d.cts
View file

@ -333,7 +333,7 @@ declare type CompileOptions_2 = CompileOptions
/** /**
* An object describing how to parse a markdown construct. * An object describing how to parse a markdown construct.
*/ */
declare type Construct = { export declare type Construct = {
/** /**
* Set up a state machine to handle character codes streaming in. * Set up a state machine to handle character codes streaming in.
*/ */
@ -1200,7 +1200,7 @@ context: TokenizeContext
* @returns * @returns
* Next state. * Next state.
*/ */
declare type State = (code: Code) => State | undefined export declare type State = (code: Code) => State | undefined
/** /**
* A token: a span of chunks. * A token: a span of chunks.
@ -1490,7 +1490,7 @@ declare interface TokenizeContext {
* @returns * @returns
* First state. * First state.
*/ */
declare type Tokenizer = ( export declare type Tokenizer = (
this: TokenizeContext, this: TokenizeContext,
effects: Effects, effects: Effects,
ok: State, ok: State,
@ -1747,3 +1747,12 @@ export declare interface TokenTypeMap {
mathTextPadding: 'mathTextPadding' mathTextPadding: 'mathTextPadding'
mathTextSequence: 'mathTextSequence' mathTextSequence: 'mathTextSequence'
} }
// Source: Custom types generated by markdownlint in getEvents
export declare interface TokenTypeMap {
undefinedReference: 'undefinedReference'
undefinedReferenceCollapsed: 'undefinedReferenceCollapsed'
undefinedReferenceFull: 'undefinedReferenceFull'
undefinedReferenceShortcut: 'undefinedReferenceShortcut'
}

2
micromark/package.json
View file

@ -1,6 +1,6 @@
{ {
"name": "markdownlint-micromark", "name": "markdownlint-micromark",
"version": "0.1.11", "version": "0.1.12",
"description": "A trivial package that re-exports some micromark functionality as a CommonJS module", "description": "A trivial package that re-exports some micromark functionality as a CommonJS module",
"type": "commonjs", "type": "commonjs",
"exports": "./micromark.cjs", "exports": "./micromark.cjs",

8
micromark/types.d.ts vendored
View file

@ -14,6 +14,12 @@
// - micromark/node_modules/micromark-extension-gfm-footnote/index.d.ts // - micromark/node_modules/micromark-extension-gfm-footnote/index.d.ts
// - micromark/node_modules/micromark-extension-gfm-table/index.d.ts // - micromark/node_modules/micromark-extension-gfm-table/index.d.ts
// - micromark/node_modules/micromark-extension-math/index.d.ts // - micromark/node_modules/micromark-extension-math/index.d.ts
// - export declare interface TokenTypeMap {
// undefinedReference: 'undefinedReference'
// undefinedReferenceCollapsed: 'undefinedReferenceCollapsed'
// undefinedReferenceFull: 'undefinedReferenceFull'
// undefinedReferenceShortcut: 'undefinedReferenceShortcut'
// }
// 7. Update version number in package.json and stage changes // 7. Update version number in package.json and stage changes
// 8. Test: npm run build, npm pack, npm install ./micromark/markdownlint-micromark-0.1.11.tgz, npm run ci, verify types like gfmFootnote* in getReferenceLinkImageData(...) // 8. Test: npm run build, npm pack, npm install ./micromark/markdownlint-micromark-0.1.11.tgz, npm run ci, verify types like gfmFootnote* in getReferenceLinkImageData(...)
// 9. Publish: git clean -dfx, npm install, npm run build, npm publish ., git push // 9. Publish: git clean -dfx, npm install, npm run build, npm publish ., git push
@ -25,4 +31,4 @@ export type { gfmTable, gfmTableHtml } from "micromark-extension-gfm-table";
export type { math, mathHtml } from "micromark-extension-math"; export type { math, mathHtml } from "micromark-extension-math";
export type { compile, parse, postprocess, preprocess } from "micromark"; export type { compile, parse, postprocess, preprocess } from "micromark";
export type { CompileData, Event, ParseOptions, Token, TokenType, TokenTypeMap } from "micromark-util-types"; export type { CompileData, Construct, Event, ParseOptions, State, Token, TokenType, TokenTypeMap, Tokenizer } from "micromark-util-types";