planning

node_modules/mdast-util-gfm-task-list-item/from-markdown.js

@@ -0,0 +1,50 @@
+exports.exit = {
+  taskListCheckValueChecked: exitCheck,
+  taskListCheckValueUnchecked: exitCheck,
+  paragraph: exitParagraphWithTaskListItem
+}
+
+function exitCheck(token) {
+  // We’re always in a paragraph, in a list item.
+  this.stack[this.stack.length - 2].checked =
+    token.type === 'taskListCheckValueChecked'
+}
+
+function exitParagraphWithTaskListItem(token) {
+  var parent = this.stack[this.stack.length - 2]
+  var node = this.stack[this.stack.length - 1]
+  var siblings = parent.children
+  var head = node.children[0]
+  var index = -1
+  var firstParaghraph
+
+  if (
+    parent &&
+    parent.type === 'listItem' &&
+    typeof parent.checked === 'boolean' &&
+    head &&
+    head.type === 'text'
+  ) {
+    while (++index < siblings.length) {
+      if (siblings[index].type === 'paragraph') {
+        firstParaghraph = siblings[index]
+        break
+      }
+    }
+
+    if (firstParaghraph === node) {
+      // Must start with a space or a tab.
+      head.value = head.value.slice(1)
+
+      if (head.value.length === 0) {
+        node.children.shift()
+      } else {
+        head.position.start.column++
+        head.position.start.offset++
+        node.position.start = Object.assign({}, head.position.start)
+      }
+    }
+  }
+
+  this.exit(token)
+}

node_modules/mdast-util-gfm-task-list-item/index.js

@@ -0,0 +1,2 @@
+exports.fromMarkdown = require('./from-markdown')
+exports.toMarkdown = require('./to-markdown')

node_modules/mdast-util-gfm-task-list-item/license

@@ -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.

node_modules/mdast-util-gfm-task-list-item/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "mdast-util-gfm-task-list-item",
+  "version": "0.1.6",
+  "description": "mdast extension to parse and serialize GFM task list items",
+  "license": "MIT",
+  "keywords": [
+    "unist",
+    "mdast",
+    "mdast-util",
+    "util",
+    "utility",
+    "markdown",
+    "markup",
+    "task",
+    "list",
+    "item",
+    "check",
+    "checkbox",
+    "todo",
+    "gfm"
+  ],
+  "repository": "syntax-tree/mdast-util-gfm-task-list-item",
+  "bugs": "https://github.com/syntax-tree/mdast-util-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)"
+  ],
+  "files": [
+    "from-markdown.js",
+    "index.js",
+    "to-markdown.js"
+  ],
+  "dependencies": {
+    "mdast-util-to-markdown": "~0.6.0"
+  },
+  "devDependencies": {
+    "mdast-util-from-markdown": "^0.8.0",
+    "micromark-extension-gfm-task-list-item": "^0.3.0",
+    "nyc": "^15.0.0",
+    "prettier": "^2.0.0",
+    "remark-cli": "^9.0.0-alpha.1",
+    "remark-preset-wooorm": "^8.0.0",
+    "tape": "^5.0.0",
+    "unist-util-remove-position": "^3.0.0",
+    "xo": "^0.36.0"
+  },
+  "scripts": {
+    "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
+    "test-api": "node test",
+    "test-coverage": "nyc --reporter lcov tape test.js",
+    "test": "npm run format && npm run test-coverage"
+  },
+  "nyc": {
+    "check-coverage": true,
+    "lines": 100,
+    "functions": 100,
+    "branches": 100
+  },
+  "prettier": {
+    "tabWidth": 2,
+    "useTabs": false,
+    "singleQuote": true,
+    "bracketSpacing": false,
+    "semi": false,
+    "trailingComma": "none"
+  },
+  "xo": {
+    "prettier": true,
+    "esnext": false,
+    "rules": {
+      "unicorn/prefer-includes": "off"
+    }
+  },
+  "remarkConfig": {
+    "plugins": [
+      "preset-wooorm"
+    ]
+  }
+}

node_modules/mdast-util-gfm-task-list-item/readme.md

@@ -0,0 +1,226 @@
+# mdast-util-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]
+
+Extension for [`mdast-util-from-markdown`][from-markdown] and/or
+[`mdast-util-to-markdown`][to-markdown] to support GitHub flavored markdown
+task list items in **[mdast][]**.
+When parsing (`from-markdown`), must be combined with
+[`micromark-extension-gfm-task-list-item`][extension].
+
+You probably shouldn’t use this package directly, but instead use
+[`remark-gfm`][remark-gfm] with **[remark][]**.
+
+## Install
+
+[npm][]:
+
+```sh
+npm install mdast-util-gfm-task-list-item
+```
+
+## Use
+
+Say we have the following file, `example.md`:
+
+```markdown
+* [ ] To do
+* [x] Done
+
+1. Mixed…
+2. [x] …messages
+```
+
+And our script, `example.js`, looks as follows:
+
+```js
+var fs = require('fs')
+var fromMarkdown = require('mdast-util-from-markdown')
+var toMarkdown = require('mdast-util-to-markdown')
+var syntax = require('micromark-extension-gfm-task-list-item')
+var taskListItem = require('mdast-util-gfm-task-list-item')
+
+var doc = fs.readFileSync('example.md')
+
+var tree = fromMarkdown(doc, {
+  extensions: [syntax],
+  mdastExtensions: [taskListItem.fromMarkdown]
+})
+
+console.log(tree)
+
+var out = toMarkdown(tree, {extensions: [taskListItem.toMarkdown]})
+
+console.log(out)
+```
+
+Now, running `node example` yields (positional info removed for the sake of
+brevity):
+
+```js
+{
+ type: 'root',
+ children: [
+   {
+     type: 'list',
+     ordered: false,
+     start: null,
+     spread: false,
+     children: [
+       {
+         type: 'listItem',
+         spread: false,
+         checked: false,
+         children: [
+           {type: 'paragraph', children: [{type: 'text', value: 'To do'}]}
+         ]
+       },
+       {
+         type: 'listItem',
+         spread: false,
+         checked: true,
+         children: [
+           {type: 'paragraph', children: [{type: 'text', value: 'Done'}]}
+         ]
+       }
+     ]
+   },
+   {
+     type: 'list',
+     ordered: true,
+     start: 1,
+     spread: false,
+     children: [
+       {
+         type: 'listItem',
+         spread: false,
+         checked: null,
+         children: [
+           {type: 'paragraph', children: [{type: 'text', value: 'Mixed…'}]}
+         ]
+       },
+       {
+         type: 'listItem',
+         spread: false,
+         checked: true,
+         children: [
+           {type: 'paragraph', children: [{type: 'text', value: '…messages'}]}
+         ]
+       }
+     ]
+   }
+ ]
+}
+```
+
+```markdown
+*   [ ] To do
+*   [x] Done
+
+1.  Mixed…
+2.  [x] …messages
+```
+
+## API
+
+### `taskListItem.fromMarkdown`
+
+### `taskListItem.toMarkdown`
+
+> Note: the separate extensions are also available at
+> `mdast-util-gfm-task-list-item/from-markdown` and
+> `mdast-util-gfm-task-list-item/to-markdown`.
+
+Support task list items.
+The exports are extensions, respectively
+for [`mdast-util-from-markdown`][from-markdown] and
+[`mdast-util-to-markdown`][to-markdown].
+
+## Related
+
+*   [`remarkjs/remark`][remark]
+    — markdown processor powered by plugins
+*   [`remarkjs/remark-gfm`][remark-gfm]
+    — remark plugin to support GFM
+*   [`micromark/micromark`][micromark]
+    — the smallest commonmark-compliant markdown parser that exists
+*   [`micromark/micromark-extension-gfm-task-list-item`][extension]
+    — micromark extension to parse GFM task list items
+*   [`syntax-tree/mdast-util-from-markdown`][from-markdown]
+    — mdast parser using `micromark` to create mdast from markdown
+*   [`syntax-tree/mdast-util-to-markdown`][to-markdown]
+    — mdast serializer to create markdown from mdast
+
+## Contribute
+
+See [`contributing.md` in `syntax-tree/.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/syntax-tree/mdast-util-gfm-task-list-item/workflows/main/badge.svg
+
+[build]: https://github.com/syntax-tree/mdast-util-gfm-task-list-item/actions
+
+[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/mdast-util-gfm-task-list-item.svg
+
+[coverage]: https://codecov.io/github/syntax-tree/mdast-util-gfm-task-list-item
+
+[downloads-badge]: https://img.shields.io/npm/dm/mdast-util-gfm-task-list-item.svg
+
+[downloads]: https://www.npmjs.com/package/mdast-util-gfm-task-list-item
+
+[size-badge]: https://img.shields.io/bundlephobia/minzip/mdast-util-gfm-task-list-item.svg
+
+[size]: https://bundlephobia.com/result?p=mdast-util-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/syntax-tree/unist/discussions
+
+[npm]: https://docs.npmjs.com/cli/install
+
+[license]: license
+
+[author]: https://wooorm.com
+
+[contributing]: https://github.com/syntax-tree/.github/blob/HEAD/contributing.md
+
+[support]: https://github.com/syntax-tree/.github/blob/HEAD/support.md
+
+[coc]: https://github.com/syntax-tree/.github/blob/HEAD/code-of-conduct.md
+
+[mdast]: https://github.com/syntax-tree/mdast
+
+[remark]: https://github.com/remarkjs/remark
+
+[remark-gfm]: https://github.com/remarkjs/remark-gfm
+
+[from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown
+
+[to-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown
+
+[micromark]: https://github.com/micromark/micromark
+
+[extension]: https://github.com/micromark/micromark-extension-gfm-task-list-item

node_modules/mdast-util-gfm-task-list-item/to-markdown.js

@@ -0,0 +1,22 @@
+var defaultListItem = require('mdast-util-to-markdown/lib/handle/list-item')
+
+exports.unsafe = [{atBreak: true, character: '-', after: '[:|-]'}]
+
+exports.handlers = {
+  listItem: listItemWithTaskListItem
+}
+
+function listItemWithTaskListItem(node, parent, context) {
+  var value = defaultListItem(node, parent, context)
+  var head = node.children[0]
+
+  if (typeof node.checked === 'boolean' && head && head.type === 'paragraph') {
+    value = value.replace(/^(?:[*+-]|\d+\.)([\r\n]| {1,3})/, check)
+  }
+
+  return value
+
+  function check($0) {
+    return $0 + '[' + (node.checked ? 'x' : ' ') + '] '
+  }
+}