mdast-util-to-nlcst - npm Package Compare versions

Comparing version 3.2.2 to 3.2.3

package.json

 {
   "name": "mdast-util-to-nlcst",
-  "version": "3.2.2",
+  "version": "3.2.3",
   "description": "Transform MDAST to NLCST",
@@ -32,20 +32,20 @@ "license": "MIT",
     "browserify": "^16.0.0",
-    "is-hidden": "^1.0.1",
+    "is-hidden": "^1.0.0",
     "negate": "^1.0.0",
-    "nyc": "^13.0.0",
+    "nyc": "^14.0.0",
     "parse-dutch": "^4.0.0",
     "parse-english": "^4.0.0",
     "parse-latin": "^4.0.0",
-    "prettier": "^1.14.3",
+    "prettier": "^1.0.0",
     "remark": "^10.0.0",
     "remark-cli": "^6.0.0",
     "remark-frontmatter": "^1.0.0",
-    "remark-preset-wooorm": "^4.0.0",
+    "remark-preset-wooorm": "^5.0.0",
     "tape": "^4.0.0",
-    "tinyify": "^2.4.3",
-    "vfile": "^3.0.0",
-    "xo": "^0.23.0"
+    "tinyify": "^2.0.0",
+    "vfile": "^4.0.0",
+    "xo": "^0.24.0"
   },
   "scripts": {
-    "format": "remark *.md -qfo && prettier --write '**/*.js' && xo --fix",
+    "format": "remark *.md -qfo && prettier --write \"**/*.js\" && xo --fix",
     "build-bundle": "browserify . -s mdastUtilToNLCST > mdast-util-to-nlcst.js",
@@ -75,5 +75,2 @@ "build-mangle": "browserify . -s mdastUtilToNLCST -p tinyify > mdast-util-to-nlcst.min.js",
     "esnext": false,
-    "rules": {
-      "max-params": "off"
-    },
     "ignores": [
@@ -80,0 +77,0 @@ "mdast-util-to-nlcst.js"

readme.md

@@ -1,12 +0,20 @@
-# mdast-util-to-nlcst [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]
+# mdast-util-to-nlcst
 
-Transform [MDAST][] to [NLCST][].
+[![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]
 
+[**mdast**][mdast] utility to transform to [**nlcst**][nlcst].
+
 > **Note**: You probably want to use [`remark-retext`][remark-retext].
 
-## Installation
+## Install
 
 [npm][]:
 
-```bash
+```sh
 npm install mdast-util-to-nlcst
@@ -17,3 +25,3 @@ ```
 
-```javascript
+```js
 var toNLCST = require('mdast-util-to-nlcst')
@@ -50,6 +58,6 @@ var inspect = require('unist-util-inspect')
 
-### `toNLCST(node, file, Parser[, options])`
+### `toNlcst(tree, file, Parser[, options])`
 
-Transform an [MDAST][] syntax tree and corresponding [virtual file][vfile]
-into an [NLCST][] tree.
+Transform a [tree][] in [mdast][], with a corresponding [virtual file][vfile],
+into [nlcst][].
 
@@ -60,3 +68,3 @@ ##### Parameters
 
-Syntax tree, with positional information ([`MDASTNode`][mdast]).
+Tree in [mdast][] with positional information ([`MdastNode`][mdastnode]).
 
@@ -69,4 +77,4 @@ ###### `file`
 
-Constructor of an NLCST parser (`Function`).  For example,
-[`parse-english`][english], [`parse-dutch`][dutch], or
+[nlcst][] parser (`Function`).
+For example, [`parse-english`][english], [`parse-dutch`][dutch], or
 [`parse-latin`][latin].
@@ -76,3 +84,3 @@
 
-List of node [types][type] to ignore (`Array.<string>`).
+List of [types][type] to ignore (`Array.<string>`).
 
@@ -83,3 +91,3 @@ `'table'`, `'tableRow'`, and `'tableCell'` are always ignored.
 
-List of node [types][type] to mark as [source][] (`Array.<string>`).
+List of [types][type] to mark as [source][] (`Array.<string>`).
 
@@ -90,3 +98,3 @@ `'inlineCode'` is always marked as source.
 
-[`NLCSTNode`][nlcst].
+[`NlcstNode`][nlcstnode].
 
@@ -99,3 +107,3 @@ ##### Examples
 
-```markdown
+```md
 A paragraph.
@@ -125,3 +133,3 @@
 
-```markdown
+```md
 A paragraph.
@@ -155,15 +163,17 @@
 *   [`hast-util-to-nlcst`](https://github.com/syntax-tree/hast-util-to-nlcst)
-    — Transform HAST to NLCST
+    — Transform [hast][] to [nlcst][]
 *   [`hast-util-to-mdast`](https://github.com/syntax-tree/hast-util-to-mdast)
-    — Transform HAST to MDAST
+    — Transform [hast][] to [mdast][]
 *   [`mdast-util-to-hast`](https://github.com/syntax-tree/mdast-util-to-hast)
-    — Transform MDAST to HAST
+    — Transform [mdast][] to [hast][]
 
 ## Contribute
 
-See [`contributing.md` in `syntax-tree/mdast`][contributing] for ways to get
+See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
 started.
+See [`support.md`][support] for ways to get help.
 
-This organisation has a [Code of Conduct][coc].  By interacting with this
-repository, organisation, or community you agree to abide by its terms.
+This project has a [Code of Conduct][coc].
+By interacting with this repository, organisation, or community you agree to
+abide by its terms.
 
@@ -176,10 +186,28 @@ ## License
 
-[travis-badge]: https://img.shields.io/travis/syntax-tree/mdast-util-to-nlcst.svg
+[build-badge]: https://img.shields.io/travis/syntax-tree/mdast-util-to-nlcst.svg
 
-[travis]: https://travis-ci.org/syntax-tree/mdast-util-to-nlcst
+[build]: https://travis-ci.org/syntax-tree/mdast-util-to-nlcst
 
-[codecov-badge]: https://img.shields.io/codecov/c/github/syntax-tree/mdast-util-to-nlcst.svg
+[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/mdast-util-to-nlcst.svg
 
-[codecov]: https://codecov.io/github/syntax-tree/mdast-util-to-nlcst
+[coverage]: https://codecov.io/github/syntax-tree/mdast-util-to-nlcst
 
+[downloads-badge]: https://img.shields.io/npm/dm/mdast-util-to-nlcst.svg
+
+[downloads]: https://www.npmjs.com/package/mdast-util-to-nlcst
+
+[size-badge]: https://img.shields.io/bundlephobia/minzip/mdast-util-to-nlcst.svg
+
+[size]: https://bundlephobia.com/result?p=mdast-util-to-nlcst
+
+[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/join%20the%20community-on%20spectrum-7b16ff.svg
+
+[chat]: https://spectrum.chat/unified/syntax-tree
+
 [npm]: https://docs.npmjs.com/cli/install
@@ -191,2 +219,8 @@
 
+[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md
+
+[support]: https://github.com/syntax-tree/.github/blob/master/support.md
+
+[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
+
 [mdast]: https://github.com/syntax-tree/mdast
@@ -196,2 +230,4 @@
 
+[hast]: https://github.com/syntax-tree/hast
+
 [remark-retext]: https://github.com/remarkjs/remark-retext
@@ -211,4 +247,6 @@
 
-[contributing]: https://github.com/syntax-tree/mdast/blob/master/contributing.md
+[tree]: https://github.com/syntax-tree/unist#tree
 
-[coc]: https://github.com/syntax-tree/mdast/blob/master/code-of-conduct.md
+[mdastnode]: https://github.com/syntax-tree/mdast#nodes
+
+[nlcstnode]: https://github.com/syntax-tree/nlcst#nodes

No alert changes

Improved metrics

Total package byte prevSize

13352

increased by8.84%

Number of lines in readme file

239

increased by18.91%

No dependency changes