🎉 initiate project *astro_rewrite*
This commit is contained in:
parent
ffd4d5e86c
commit
2ba37bfbe3
8658 changed files with 2268794 additions and 2538 deletions
12
node_modules/micromark-extension-gfm-task-list-item/dev/index.d.ts
generated
vendored
Normal file
12
node_modules/micromark-extension-gfm-task-list-item/dev/index.d.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
export {gfmTaskListItemHtml} from './lib/html.js'
|
||||
export {gfmTaskListItem} from './lib/syntax.js'
|
||||
|
||||
declare module 'micromark-util-types' {
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
|
||||
interface TokenTypeMap {
|
||||
taskListCheck: 'taskListCheck'
|
||||
taskListCheckMarker: 'taskListCheckMarker'
|
||||
taskListCheckValueChecked: 'taskListCheckValueChecked'
|
||||
taskListCheckValueUnchecked: 'taskListCheckValueUnchecked'
|
||||
}
|
||||
}
|
||||
2
node_modules/micromark-extension-gfm-task-list-item/dev/index.js
generated
vendored
Normal file
2
node_modules/micromark-extension-gfm-task-list-item/dev/index.js
generated
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
export {gfmTaskListItemHtml} from './lib/html.js'
|
||||
export {gfmTaskListItem} from './lib/syntax.js'
|
||||
11
node_modules/micromark-extension-gfm-task-list-item/dev/lib/html.d.ts
generated
vendored
Normal file
11
node_modules/micromark-extension-gfm-task-list-item/dev/lib/html.d.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
/**
|
||||
* @typedef {import('micromark-util-types').HtmlExtension} HtmlExtension
|
||||
*/
|
||||
/**
|
||||
* Extension for `micromark` that can be passed in `htmlExtensions` to
|
||||
* support GFM task list items when serializing to HTML.
|
||||
*
|
||||
* @type {HtmlExtension}
|
||||
*/
|
||||
export const gfmTaskListItemHtml: HtmlExtension
|
||||
export type HtmlExtension = import('micromark-util-types').HtmlExtension
|
||||
27
node_modules/micromark-extension-gfm-task-list-item/dev/lib/html.js
generated
vendored
Normal file
27
node_modules/micromark-extension-gfm-task-list-item/dev/lib/html.js
generated
vendored
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
/**
|
||||
* @typedef {import('micromark-util-types').HtmlExtension} HtmlExtension
|
||||
*/
|
||||
|
||||
// To do: next major: expose function to make extension.
|
||||
|
||||
/**
|
||||
* Extension for `micromark` that can be passed in `htmlExtensions` to
|
||||
* support GFM task list items when serializing to HTML.
|
||||
*
|
||||
* @type {HtmlExtension}
|
||||
*/
|
||||
export const gfmTaskListItemHtml = {
|
||||
enter: {
|
||||
taskListCheck() {
|
||||
this.tag('<input type="checkbox" disabled="" ')
|
||||
}
|
||||
},
|
||||
exit: {
|
||||
taskListCheck() {
|
||||
this.tag('/>')
|
||||
},
|
||||
taskListCheckValueChecked() {
|
||||
this.tag('checked="" ')
|
||||
}
|
||||
}
|
||||
}
|
||||
11
node_modules/micromark-extension-gfm-task-list-item/dev/lib/syntax.d.ts
generated
vendored
Normal file
11
node_modules/micromark-extension-gfm-task-list-item/dev/lib/syntax.d.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
/**
|
||||
* Extension for `micromark` that can be passed in `extensions`, to
|
||||
* enable GFM task list items syntax.
|
||||
*
|
||||
* @type {Extension}
|
||||
*/
|
||||
export const gfmTaskListItem: Extension
|
||||
export type Extension = import('micromark-util-types').Extension
|
||||
export type State = import('micromark-util-types').State
|
||||
export type TokenizeContext = import('micromark-util-types').TokenizeContext
|
||||
export type Tokenizer = import('micromark-util-types').Tokenizer
|
||||
168
node_modules/micromark-extension-gfm-task-list-item/dev/lib/syntax.js
generated
vendored
Normal file
168
node_modules/micromark-extension-gfm-task-list-item/dev/lib/syntax.js
generated
vendored
Normal file
|
|
@ -0,0 +1,168 @@
|
|||
/**
|
||||
* @typedef {import('micromark-util-types').Extension} Extension
|
||||
* @typedef {import('micromark-util-types').State} State
|
||||
* @typedef {import('micromark-util-types').TokenizeContext} TokenizeContext
|
||||
* @typedef {import('micromark-util-types').Tokenizer} Tokenizer
|
||||
*/
|
||||
|
||||
import {ok as assert} from 'uvu/assert'
|
||||
import {factorySpace} from 'micromark-factory-space'
|
||||
import {
|
||||
markdownLineEndingOrSpace,
|
||||
markdownLineEnding,
|
||||
markdownSpace
|
||||
} from 'micromark-util-character'
|
||||
import {codes} from 'micromark-util-symbol/codes.js'
|
||||
import {types} from 'micromark-util-symbol/types.js'
|
||||
|
||||
const tasklistCheck = {tokenize: tokenizeTasklistCheck}
|
||||
|
||||
// To do: next major: expose function to make extension.
|
||||
|
||||
/**
|
||||
* Extension for `micromark` that can be passed in `extensions`, to
|
||||
* enable GFM task list items syntax.
|
||||
*
|
||||
* @type {Extension}
|
||||
*/
|
||||
export const gfmTaskListItem = {
|
||||
text: {[codes.leftSquareBracket]: tasklistCheck}
|
||||
}
|
||||
|
||||
/**
|
||||
* @this {TokenizeContext}
|
||||
* @type {Tokenizer}
|
||||
*/
|
||||
function tokenizeTasklistCheck(effects, ok, nok) {
|
||||
const self = this
|
||||
|
||||
return open
|
||||
|
||||
/**
|
||||
* At start of task list item check.
|
||||
*
|
||||
* ```markdown
|
||||
* > | * [x] y.
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function open(code) {
|
||||
assert(code === codes.leftSquareBracket, 'expected `[`')
|
||||
|
||||
if (
|
||||
// Exit if there’s stuff before.
|
||||
self.previous !== codes.eof ||
|
||||
// Exit if not in the first content that is the first child of a list
|
||||
// item.
|
||||
!self._gfmTasklistFirstContentOfListItem
|
||||
) {
|
||||
return nok(code)
|
||||
}
|
||||
|
||||
effects.enter('taskListCheck')
|
||||
effects.enter('taskListCheckMarker')
|
||||
effects.consume(code)
|
||||
effects.exit('taskListCheckMarker')
|
||||
return inside
|
||||
}
|
||||
|
||||
/**
|
||||
* In task list item check.
|
||||
*
|
||||
* ```markdown
|
||||
* > | * [x] y.
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function inside(code) {
|
||||
// Currently we match how GH works in files.
|
||||
// To match how GH works in comments, use `markdownSpace` (`[\t ]`) instead
|
||||
// of `markdownLineEndingOrSpace` (`[\t\n\r ]`).
|
||||
if (markdownLineEndingOrSpace(code)) {
|
||||
effects.enter('taskListCheckValueUnchecked')
|
||||
effects.consume(code)
|
||||
effects.exit('taskListCheckValueUnchecked')
|
||||
return close
|
||||
}
|
||||
|
||||
if (code === codes.uppercaseX || code === codes.lowercaseX) {
|
||||
effects.enter('taskListCheckValueChecked')
|
||||
effects.consume(code)
|
||||
effects.exit('taskListCheckValueChecked')
|
||||
return close
|
||||
}
|
||||
|
||||
return nok(code)
|
||||
}
|
||||
|
||||
/**
|
||||
* At close of task list item check.
|
||||
*
|
||||
* ```markdown
|
||||
* > | * [x] y.
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function close(code) {
|
||||
if (code === codes.rightSquareBracket) {
|
||||
effects.enter('taskListCheckMarker')
|
||||
effects.consume(code)
|
||||
effects.exit('taskListCheckMarker')
|
||||
effects.exit('taskListCheck')
|
||||
return after
|
||||
}
|
||||
|
||||
return nok(code)
|
||||
}
|
||||
|
||||
/**
|
||||
* @type {State}
|
||||
*/
|
||||
function after(code) {
|
||||
// EOL in paragraph means there must be something else after it.
|
||||
if (markdownLineEnding(code)) {
|
||||
return ok(code)
|
||||
}
|
||||
|
||||
// Space or tab?
|
||||
// Check what comes after.
|
||||
if (markdownSpace(code)) {
|
||||
return effects.check({tokenize: spaceThenNonSpace}, ok, nok)(code)
|
||||
}
|
||||
|
||||
// EOF, or non-whitespace, both wrong.
|
||||
return nok(code)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @this {TokenizeContext}
|
||||
* @type {Tokenizer}
|
||||
*/
|
||||
function spaceThenNonSpace(effects, ok, nok) {
|
||||
return factorySpace(effects, after, types.whitespace)
|
||||
|
||||
/**
|
||||
* After whitespace, after task list item check.
|
||||
*
|
||||
* ```markdown
|
||||
* > | * [x] y.
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function after(code) {
|
||||
// EOF means there was nothing, so bad.
|
||||
// EOL means there’s content after it, so good.
|
||||
// Impossible to have more spaces.
|
||||
// Anything else is good.
|
||||
return code === codes.eof ? nok(code) : ok(code)
|
||||
}
|
||||
}
|
||||
12
node_modules/micromark-extension-gfm-task-list-item/index.d.ts
generated
vendored
Normal file
12
node_modules/micromark-extension-gfm-task-list-item/index.d.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
export {gfmTaskListItemHtml} from './lib/html.js'
|
||||
export {gfmTaskListItem} from './lib/syntax.js'
|
||||
|
||||
declare module 'micromark-util-types' {
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
|
||||
interface TokenTypeMap {
|
||||
taskListCheck: 'taskListCheck'
|
||||
taskListCheckMarker: 'taskListCheckMarker'
|
||||
taskListCheckValueChecked: 'taskListCheckValueChecked'
|
||||
taskListCheckValueUnchecked: 'taskListCheckValueUnchecked'
|
||||
}
|
||||
}
|
||||
2
node_modules/micromark-extension-gfm-task-list-item/index.js
generated
vendored
Normal file
2
node_modules/micromark-extension-gfm-task-list-item/index.js
generated
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
export {gfmTaskListItemHtml} from './lib/html.js'
|
||||
export {gfmTaskListItem} from './lib/syntax.js'
|
||||
11
node_modules/micromark-extension-gfm-task-list-item/lib/html.d.ts
generated
vendored
Normal file
11
node_modules/micromark-extension-gfm-task-list-item/lib/html.d.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
/**
|
||||
* @typedef {import('micromark-util-types').HtmlExtension} HtmlExtension
|
||||
*/
|
||||
/**
|
||||
* Extension for `micromark` that can be passed in `htmlExtensions` to
|
||||
* support GFM task list items when serializing to HTML.
|
||||
*
|
||||
* @type {HtmlExtension}
|
||||
*/
|
||||
export const gfmTaskListItemHtml: HtmlExtension
|
||||
export type HtmlExtension = import('micromark-util-types').HtmlExtension
|
||||
27
node_modules/micromark-extension-gfm-task-list-item/lib/html.js
generated
vendored
Normal file
27
node_modules/micromark-extension-gfm-task-list-item/lib/html.js
generated
vendored
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
/**
|
||||
* @typedef {import('micromark-util-types').HtmlExtension} HtmlExtension
|
||||
*/
|
||||
|
||||
// To do: next major: expose function to make extension.
|
||||
|
||||
/**
|
||||
* Extension for `micromark` that can be passed in `htmlExtensions` to
|
||||
* support GFM task list items when serializing to HTML.
|
||||
*
|
||||
* @type {HtmlExtension}
|
||||
*/
|
||||
export const gfmTaskListItemHtml = {
|
||||
enter: {
|
||||
taskListCheck() {
|
||||
this.tag('<input type="checkbox" disabled="" ')
|
||||
}
|
||||
},
|
||||
exit: {
|
||||
taskListCheck() {
|
||||
this.tag('/>')
|
||||
},
|
||||
taskListCheckValueChecked() {
|
||||
this.tag('checked="" ')
|
||||
}
|
||||
}
|
||||
}
|
||||
11
node_modules/micromark-extension-gfm-task-list-item/lib/syntax.d.ts
generated
vendored
Normal file
11
node_modules/micromark-extension-gfm-task-list-item/lib/syntax.d.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
/**
|
||||
* Extension for `micromark` that can be passed in `extensions`, to
|
||||
* enable GFM task list items syntax.
|
||||
*
|
||||
* @type {Extension}
|
||||
*/
|
||||
export const gfmTaskListItem: Extension
|
||||
export type Extension = import('micromark-util-types').Extension
|
||||
export type State = import('micromark-util-types').State
|
||||
export type TokenizeContext = import('micromark-util-types').TokenizeContext
|
||||
export type Tokenizer = import('micromark-util-types').Tokenizer
|
||||
167
node_modules/micromark-extension-gfm-task-list-item/lib/syntax.js
generated
vendored
Normal file
167
node_modules/micromark-extension-gfm-task-list-item/lib/syntax.js
generated
vendored
Normal file
|
|
@ -0,0 +1,167 @@
|
|||
/**
|
||||
* @typedef {import('micromark-util-types').Extension} Extension
|
||||
* @typedef {import('micromark-util-types').State} State
|
||||
* @typedef {import('micromark-util-types').TokenizeContext} TokenizeContext
|
||||
* @typedef {import('micromark-util-types').Tokenizer} Tokenizer
|
||||
*/
|
||||
|
||||
import {factorySpace} from 'micromark-factory-space'
|
||||
import {
|
||||
markdownLineEndingOrSpace,
|
||||
markdownLineEnding,
|
||||
markdownSpace
|
||||
} from 'micromark-util-character'
|
||||
const tasklistCheck = {
|
||||
tokenize: tokenizeTasklistCheck
|
||||
}
|
||||
|
||||
// To do: next major: expose function to make extension.
|
||||
|
||||
/**
|
||||
* Extension for `micromark` that can be passed in `extensions`, to
|
||||
* enable GFM task list items syntax.
|
||||
*
|
||||
* @type {Extension}
|
||||
*/
|
||||
export const gfmTaskListItem = {
|
||||
text: {
|
||||
[91]: tasklistCheck
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @this {TokenizeContext}
|
||||
* @type {Tokenizer}
|
||||
*/
|
||||
function tokenizeTasklistCheck(effects, ok, nok) {
|
||||
const self = this
|
||||
return open
|
||||
|
||||
/**
|
||||
* At start of task list item check.
|
||||
*
|
||||
* ```markdown
|
||||
* > | * [x] y.
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function open(code) {
|
||||
if (
|
||||
// Exit if there’s stuff before.
|
||||
self.previous !== null ||
|
||||
// Exit if not in the first content that is the first child of a list
|
||||
// item.
|
||||
!self._gfmTasklistFirstContentOfListItem
|
||||
) {
|
||||
return nok(code)
|
||||
}
|
||||
effects.enter('taskListCheck')
|
||||
effects.enter('taskListCheckMarker')
|
||||
effects.consume(code)
|
||||
effects.exit('taskListCheckMarker')
|
||||
return inside
|
||||
}
|
||||
|
||||
/**
|
||||
* In task list item check.
|
||||
*
|
||||
* ```markdown
|
||||
* > | * [x] y.
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function inside(code) {
|
||||
// Currently we match how GH works in files.
|
||||
// To match how GH works in comments, use `markdownSpace` (`[\t ]`) instead
|
||||
// of `markdownLineEndingOrSpace` (`[\t\n\r ]`).
|
||||
if (markdownLineEndingOrSpace(code)) {
|
||||
effects.enter('taskListCheckValueUnchecked')
|
||||
effects.consume(code)
|
||||
effects.exit('taskListCheckValueUnchecked')
|
||||
return close
|
||||
}
|
||||
if (code === 88 || code === 120) {
|
||||
effects.enter('taskListCheckValueChecked')
|
||||
effects.consume(code)
|
||||
effects.exit('taskListCheckValueChecked')
|
||||
return close
|
||||
}
|
||||
return nok(code)
|
||||
}
|
||||
|
||||
/**
|
||||
* At close of task list item check.
|
||||
*
|
||||
* ```markdown
|
||||
* > | * [x] y.
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function close(code) {
|
||||
if (code === 93) {
|
||||
effects.enter('taskListCheckMarker')
|
||||
effects.consume(code)
|
||||
effects.exit('taskListCheckMarker')
|
||||
effects.exit('taskListCheck')
|
||||
return after
|
||||
}
|
||||
return nok(code)
|
||||
}
|
||||
|
||||
/**
|
||||
* @type {State}
|
||||
*/
|
||||
function after(code) {
|
||||
// EOL in paragraph means there must be something else after it.
|
||||
if (markdownLineEnding(code)) {
|
||||
return ok(code)
|
||||
}
|
||||
|
||||
// Space or tab?
|
||||
// Check what comes after.
|
||||
if (markdownSpace(code)) {
|
||||
return effects.check(
|
||||
{
|
||||
tokenize: spaceThenNonSpace
|
||||
},
|
||||
ok,
|
||||
nok
|
||||
)(code)
|
||||
}
|
||||
|
||||
// EOF, or non-whitespace, both wrong.
|
||||
return nok(code)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @this {TokenizeContext}
|
||||
* @type {Tokenizer}
|
||||
*/
|
||||
function spaceThenNonSpace(effects, ok, nok) {
|
||||
return factorySpace(effects, after, 'whitespace')
|
||||
|
||||
/**
|
||||
* After whitespace, after task list item check.
|
||||
*
|
||||
* ```markdown
|
||||
* > | * [x] y.
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function after(code) {
|
||||
// EOF means there was nothing, so bad.
|
||||
// EOL means there’s content after it, so good.
|
||||
// Impossible to have more spaces.
|
||||
// Anything else is good.
|
||||
return code === null ? nok(code) : ok(code)
|
||||
}
|
||||
}
|
||||
22
node_modules/micromark-extension-gfm-task-list-item/license
generated
vendored
Normal file
22
node_modules/micromark-extension-gfm-task-list-item/license
generated
vendored
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
(The MIT License)
|
||||
|
||||
Copyright (c) 2020 Titus Wormer <tituswormer@gmail.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
'Software'), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
1
node_modules/micromark-extension-gfm-task-list-item/node_modules/.bin/uvu
generated
vendored
Symbolic link
1
node_modules/micromark-extension-gfm-task-list-item/node_modules/.bin/uvu
generated
vendored
Symbolic link
|
|
@ -0,0 +1 @@
|
|||
../../../uvu/bin.js
|
||||
110
node_modules/micromark-extension-gfm-task-list-item/package.json
generated
vendored
Normal file
110
node_modules/micromark-extension-gfm-task-list-item/package.json
generated
vendored
Normal file
|
|
@ -0,0 +1,110 @@
|
|||
{
|
||||
"name": "micromark-extension-gfm-task-list-item",
|
||||
"version": "1.0.5",
|
||||
"description": "micromark extension to support GFM task list items",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"micromark",
|
||||
"micromark-extension",
|
||||
"task",
|
||||
"list",
|
||||
"item",
|
||||
"check",
|
||||
"checkbox",
|
||||
"todo",
|
||||
"gfm",
|
||||
"markdown",
|
||||
"unified"
|
||||
],
|
||||
"repository": "micromark/micromark-extension-gfm-task-list-item",
|
||||
"bugs": "https://github.com/micromark/micromark-extension-gfm-task-list-item/issues",
|
||||
"funding": {
|
||||
"type": "opencollective",
|
||||
"url": "https://opencollective.com/unified"
|
||||
},
|
||||
"author": "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
|
||||
"contributors": [
|
||||
"Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
|
||||
],
|
||||
"sideEffects": false,
|
||||
"type": "module",
|
||||
"main": "index.js",
|
||||
"types": "index.d.ts",
|
||||
"files": [
|
||||
"dev/",
|
||||
"lib/",
|
||||
"index.d.ts",
|
||||
"index.js"
|
||||
],
|
||||
"exports": {
|
||||
"development": "./dev/index.js",
|
||||
"default": "./index.js"
|
||||
},
|
||||
"dependencies": {
|
||||
"micromark-factory-space": "^1.0.0",
|
||||
"micromark-util-character": "^1.0.0",
|
||||
"micromark-util-symbol": "^1.0.0",
|
||||
"micromark-util-types": "^1.0.0",
|
||||
"uvu": "^0.5.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^20.0.0",
|
||||
"c8": "^7.0.0",
|
||||
"control-pictures": "^2.0.0",
|
||||
"create-gfm-fixtures": "^1.0.0",
|
||||
"micromark": "^3.0.0",
|
||||
"micromark-build": "^1.0.0",
|
||||
"prettier": "^2.0.0",
|
||||
"remark-cli": "^11.0.0",
|
||||
"remark-preset-wooorm": "^9.0.0",
|
||||
"type-coverage": "^2.0.0",
|
||||
"typescript": "^5.0.0",
|
||||
"xo": "^0.54.0"
|
||||
},
|
||||
"scripts": {
|
||||
"prepack": "npm run build && npm run format",
|
||||
"build": "tsc --build --clean && tsc --build && type-coverage && micromark-build",
|
||||
"format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
|
||||
"test-api-prod": "node --conditions production test/index.js",
|
||||
"test-api-dev": "node --conditions development test/index.js",
|
||||
"test-api": "npm run test-api-dev && npm run test-api-prod",
|
||||
"test-coverage": "c8 --100 --reporter lcov npm run test-api",
|
||||
"test": "npm run build && npm run format && npm run test-coverage"
|
||||
},
|
||||
"prettier": {
|
||||
"tabWidth": 2,
|
||||
"useTabs": false,
|
||||
"singleQuote": true,
|
||||
"bracketSpacing": false,
|
||||
"semi": false,
|
||||
"trailingComma": "none"
|
||||
},
|
||||
"xo": {
|
||||
"prettier": true,
|
||||
"rules": {
|
||||
"n/file-extension-in-import": "off",
|
||||
"unicorn/no-this-assignment": "off"
|
||||
},
|
||||
"overrides": [
|
||||
{
|
||||
"files": [
|
||||
"test/**/*.js"
|
||||
],
|
||||
"rules": {
|
||||
"no-await-in-loop": 0
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"remarkConfig": {
|
||||
"plugins": [
|
||||
"remark-preset-wooorm"
|
||||
]
|
||||
},
|
||||
"typeCoverage": {
|
||||
"atLeast": 100,
|
||||
"detail": true,
|
||||
"strict": true,
|
||||
"ignoreCatch": true
|
||||
}
|
||||
}
|
||||
292
node_modules/micromark-extension-gfm-task-list-item/readme.md
generated
vendored
Normal file
292
node_modules/micromark-extension-gfm-task-list-item/readme.md
generated
vendored
Normal file
|
|
@ -0,0 +1,292 @@
|
|||
# micromark-extension-gfm-task-list-item
|
||||
|
||||
[![Build][build-badge]][build]
|
||||
[![Coverage][coverage-badge]][coverage]
|
||||
[![Downloads][downloads-badge]][downloads]
|
||||
[![Size][size-badge]][size]
|
||||
[![Sponsors][sponsors-badge]][collective]
|
||||
[![Backers][backers-badge]][collective]
|
||||
[![Chat][chat-badge]][chat]
|
||||
|
||||
[micromark][] extensions to support GFM [task list items][].
|
||||
|
||||
## Contents
|
||||
|
||||
* [What is this?](#what-is-this)
|
||||
* [When to use this](#when-to-use-this)
|
||||
* [Install](#install)
|
||||
* [Use](#use)
|
||||
* [API](#api)
|
||||
* [`gfmTaskListItem`](#gfmtasklistitem)
|
||||
* [`gfmTaskListItemHtml`](#gfmtasklistitemhtml)
|
||||
* [Authoring](#authoring)
|
||||
* [HTML](#html)
|
||||
* [CSS](#css)
|
||||
* [Syntax](#syntax)
|
||||
* [Types](#types)
|
||||
* [Compatibility](#compatibility)
|
||||
* [Security](#security)
|
||||
* [Related](#related)
|
||||
* [Contribute](#contribute)
|
||||
* [License](#license)
|
||||
|
||||
## What is this?
|
||||
|
||||
This package contains extensions that add support for task lists as enabled by
|
||||
GFM to [`micromark`][micromark].
|
||||
It matches how task list items work on `github.com`.
|
||||
|
||||
## When to use this
|
||||
|
||||
This project is useful when you want to support task lists in markdown.
|
||||
|
||||
You can use these extensions when you are working with [`micromark`][micromark].
|
||||
To support all GFM features, use
|
||||
[`micromark-extension-gfm`][micromark-extension-gfm].
|
||||
|
||||
When you need a syntax tree, you can combine this package with
|
||||
[`mdast-util-gfm-task-list-item`][mdast-util-gfm-task-list-item].
|
||||
|
||||
All these packages are used [`remark-gfm`][remark-gfm], which focusses on making
|
||||
it easier to transform content by abstracting these internals away.
|
||||
|
||||
## Install
|
||||
|
||||
This package is [ESM only][esm].
|
||||
In Node.js (version 14.14+), install with [npm][]:
|
||||
|
||||
```sh
|
||||
npm install micromark-extension-gfm-task-list-item
|
||||
```
|
||||
|
||||
In Deno with [`esm.sh`][esmsh]:
|
||||
|
||||
```js
|
||||
import {gfmTaskListItem, gfmTaskListItemHtml} from 'https://esm.sh/micromark-extension-gfm-task-list-item@1'
|
||||
```
|
||||
|
||||
In browsers with [`esm.sh`][esmsh]:
|
||||
|
||||
```html
|
||||
<script type="module">
|
||||
import {gfmTaskListItem, gfmTaskListItemHtml} from 'https://esm.sh/micromark-extension-gfm-task-list-item@1?bundle'
|
||||
</script>
|
||||
```
|
||||
|
||||
## Use
|
||||
|
||||
```js
|
||||
import {micromark} from 'micromark'
|
||||
import {
|
||||
gfmTaskListItem,
|
||||
gfmTaskListItemHtml
|
||||
} from 'micromark-extension-gfm-task-list-item'
|
||||
|
||||
const output = micromark('* [x] a\n* [ ] b', {
|
||||
extensions: [gfmTaskListItem],
|
||||
htmlExtensions: [gfmTaskListItemHtml]
|
||||
})
|
||||
|
||||
console.log(output)
|
||||
```
|
||||
|
||||
Yields:
|
||||
|
||||
```html
|
||||
<ul>
|
||||
<li><input checked="" disabled="" type="checkbox"> a</li>
|
||||
<li><input disabled="" type="checkbox"> b</li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
This package exports the identifiers [`gfmTaskListItem`][api-gfm-task-list-item]
|
||||
and [`gfmTaskListItemHtml`][api-gfm-task-list-item-html].
|
||||
There is no default export.
|
||||
|
||||
The export map supports the [`development` condition][development].
|
||||
Run `node --conditions development module.js` to get instrumented dev code.
|
||||
Without this condition, production code is loaded.
|
||||
|
||||
### `gfmTaskListItem`
|
||||
|
||||
Extension for `micromark` that can be passed in `extensions`, to enable GFM
|
||||
task list items syntax ([`Extension`][micromark-extension]).
|
||||
|
||||
### `gfmTaskListItemHtml`
|
||||
|
||||
Extension for `micromark` that can be passed in `htmlExtensions` to support GFM
|
||||
task list items when serializing to HTML
|
||||
([`HtmlExtension`][micromark-html-extension]).
|
||||
|
||||
## Authoring
|
||||
|
||||
It is recommended to use lowercase `x` (instead of uppercase `X`), because in
|
||||
markdown, it is more common to use lowercase in places where casing does not
|
||||
matter.
|
||||
It is also recommended to use a space (instead of a tab), as there is no benefit
|
||||
of using tabs in this case.
|
||||
|
||||
## HTML
|
||||
|
||||
Checks relate to the `<input>` element, in the checkbox state (`type=checkbox`),
|
||||
in HTML.
|
||||
See [*§ 4.10.5.1.15 Checkbox state (`type=checkbox`)*][html-input-checkbox]
|
||||
in the HTML spec for more info.
|
||||
|
||||
```html
|
||||
<!--…-->
|
||||
<li><input type="checkbox" disabled="" /> foo</li>
|
||||
<li><input type="checkbox" disabled="" checked="" /> bar</li>
|
||||
<!--…-->
|
||||
```
|
||||
|
||||
## CSS
|
||||
|
||||
GitHub itself uses slightly different markup for task list items than they
|
||||
define in their spec.
|
||||
When following the spec, as this extension does, only inputs are added.
|
||||
They can be styled with the following CSS:
|
||||
|
||||
```css
|
||||
input[type="checkbox"] {
|
||||
margin: 0 .2em .25em -1.6em;
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
input[type="checkbox"]:dir(rtl) {
|
||||
margin: 0 -1.6em .25em .2em;
|
||||
}
|
||||
```
|
||||
|
||||
For the complete actual CSS see
|
||||
[`sindresorhus/github-markdown-css`][github-markdown-css].
|
||||
|
||||
## Syntax
|
||||
|
||||
Checks form with the following BNF:
|
||||
|
||||
```bnf
|
||||
gfm_task_list_item_check ::= '[' (0x09 | ' ' | 'X' | 'x') ']'
|
||||
```
|
||||
|
||||
The check is only allowed at the start of the first paragraph, optionally
|
||||
following zero or more definitions or a blank line, in a list item.
|
||||
The check must be followed by whitespace (`[\t\n\r ]*`), which is in turn
|
||||
followed by non-whitespace.
|
||||
|
||||
## Types
|
||||
|
||||
This package is fully typed with [TypeScript][].
|
||||
It exports no additional types.
|
||||
|
||||
## Compatibility
|
||||
|
||||
Projects maintained by the unified collective are compatible with all maintained
|
||||
versions of Node.js.
|
||||
As of now, that is Node.js 14.14+.
|
||||
Our projects sometimes work with older versions, but this is not guaranteed.
|
||||
|
||||
These extensions work with `micromark` version 3+.
|
||||
|
||||
## Security
|
||||
|
||||
This package is safe.
|
||||
|
||||
## Related
|
||||
|
||||
* [`micromark-extension-gfm`][micromark-extension-gfm]
|
||||
— support all of GFM
|
||||
* [`mdast-util-gfm-task-list-item`][mdast-util-gfm-task-list-item]
|
||||
— support all of GFM in mdast
|
||||
* [`mdast-util-gfm`][mdast-util-gfm]
|
||||
— support all of GFM in mdast
|
||||
* [`remark-gfm`][remark-gfm]
|
||||
— support all of GFM in remark
|
||||
|
||||
## Contribute
|
||||
|
||||
See [`contributing.md` in `micromark/.github`][contributing] for ways to get
|
||||
started.
|
||||
See [`support.md`][support] for ways to get help.
|
||||
|
||||
This project has a [code of conduct][coc].
|
||||
By interacting with this repository, organization, or community you agree to
|
||||
abide by its terms.
|
||||
|
||||
## License
|
||||
|
||||
[MIT][license] © [Titus Wormer][author]
|
||||
|
||||
<!-- Definitions -->
|
||||
|
||||
[build-badge]: https://github.com/micromark/micromark-extension-gfm-task-list-item/workflows/main/badge.svg
|
||||
|
||||
[build]: https://github.com/micromark/micromark-extension-gfm-task-list-item/actions
|
||||
|
||||
[coverage-badge]: https://img.shields.io/codecov/c/github/micromark/micromark-extension-gfm-task-list-item.svg
|
||||
|
||||
[coverage]: https://codecov.io/github/micromark/micromark-extension-gfm-task-list-item
|
||||
|
||||
[downloads-badge]: https://img.shields.io/npm/dm/micromark-extension-gfm-task-list-item.svg
|
||||
|
||||
[downloads]: https://www.npmjs.com/package/micromark-extension-gfm-task-list-item
|
||||
|
||||
[size-badge]: https://img.shields.io/bundlephobia/minzip/micromark-extension-gfm-task-list-item.svg
|
||||
|
||||
[size]: https://bundlephobia.com/result?p=micromark-extension-gfm-task-list-item
|
||||
|
||||
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
|
||||
|
||||
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
|
||||
|
||||
[collective]: https://opencollective.com/unified
|
||||
|
||||
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
|
||||
|
||||
[chat]: https://github.com/micromark/micromark/discussions
|
||||
|
||||
[npm]: https://docs.npmjs.com/cli/install
|
||||
|
||||
[esmsh]: https://esm.sh
|
||||
|
||||
[license]: license
|
||||
|
||||
[author]: https://wooorm.com
|
||||
|
||||
[contributing]: https://github.com/micromark/.github/blob/HEAD/contributing.md
|
||||
|
||||
[support]: https://github.com/micromark/.github/blob/HEAD/support.md
|
||||
|
||||
[coc]: https://github.com/micromark/.github/blob/HEAD/code-of-conduct.md
|
||||
|
||||
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
|
||||
|
||||
[typescript]: https://www.typescriptlang.org
|
||||
|
||||
[development]: https://nodejs.org/api/packages.html#packages_resolving_user_conditions
|
||||
|
||||
[micromark]: https://github.com/micromark/micromark
|
||||
|
||||
[micromark-html-extension]: https://github.com/micromark/micromark#htmlextension
|
||||
|
||||
[micromark-extension]: https://github.com/micromark/micromark#syntaxextension
|
||||
|
||||
[micromark-extension-gfm]: https://github.com/micromark/micromark-extension-gfm
|
||||
|
||||
[mdast-util-gfm-task-list-item]: https://github.com/syntax-tree/mdast-util-gfm-task-list-item
|
||||
|
||||
[mdast-util-gfm]: https://github.com/syntax-tree/mdast-util-gfm
|
||||
|
||||
[remark-gfm]: https://github.com/remarkjs/remark-gfm
|
||||
|
||||
[task list items]: https://github.github.com/gfm/#task-list-items-extension-
|
||||
|
||||
[github-markdown-css]: https://github.com/sindresorhus/github-markdown-css
|
||||
|
||||
[html-input-checkbox]: https://html.spec.whatwg.org/multipage/input.html#checkbox-state-\(type=checkbox\)
|
||||
|
||||
[api-gfm-task-list-item]: #gfmtasklistitem
|
||||
|
||||
[api-gfm-task-list-item-html]: #gfmtasklistitemhtml
|
||||
Loading…
Add table
Add a link
Reference in a new issue