mdast-util-gfm - npm Package Compare versions

Comparing version 0.1.2 to 1.0.0

index.js

@@ -1,2 +0,45 @@
-exports.fromMarkdown = require('./from-markdown')
-exports.toMarkdown = require('./to-markdown')
+/**
+ * @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
+ * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
+ *
+ * @typedef {import('mdast-util-gfm-table').Options} Options
+ */
+
+import {
+  gfmAutolinkLiteralFromMarkdown,
+  gfmAutolinkLiteralToMarkdown
+} from 'mdast-util-gfm-autolink-literal'
+import {
+  gfmStrikethroughFromMarkdown,
+  gfmStrikethroughToMarkdown
+} from 'mdast-util-gfm-strikethrough'
+import {gfmTableFromMarkdown, gfmTableToMarkdown} from 'mdast-util-gfm-table'
+import {
+  gfmTaskListItemFromMarkdown,
+  gfmTaskListItemToMarkdown
+} from 'mdast-util-gfm-task-list-item'
+
+/**
+ * @type {Array.<FromMarkdownExtension>}
+ */
+export const gfmFromMarkdown = [
+  gfmAutolinkLiteralFromMarkdown,
+  gfmStrikethroughFromMarkdown,
+  gfmTableFromMarkdown,
+  gfmTaskListItemFromMarkdown
+]
+
+/**
+ * @param {Options} [options]
+ * @returns {ToMarkdownExtension}
+ */
+export function gfmToMarkdown(options) {
+  return {
+    extensions: [
+      gfmAutolinkLiteralToMarkdown,
+      gfmStrikethroughToMarkdown,
+      gfmTableToMarkdown(options),
+      gfmTaskListItemToMarkdown
+    ]
+  }
+}

package.json

 {
   "name": "mdast-util-gfm",
-  "version": "0.1.2",
+  "version": "1.0.0",
   "description": "mdast extension to parse and serialize GFM (GitHub Flavored Markdown)",
@@ -33,41 +33,43 @@ "license": "MIT",
   ],
+  "sideEffects": false,
+  "type": "module",
+  "main": "index.js",
+  "types": "index.d.ts",
   "files": [
-    "from-markdown.js",
-    "index.js",
-    "to-markdown.js"
+    "index.d.ts",
+    "index.js"
   ],
   "dependencies": {
-    "mdast-util-gfm-autolink-literal": "^0.1.0",
-    "mdast-util-gfm-strikethrough": "^0.2.0",
-    "mdast-util-gfm-table": "^0.1.0",
-    "mdast-util-gfm-task-list-item": "^0.1.0",
-    "mdast-util-to-markdown": "^0.6.1"
+    "mdast-util-gfm-autolink-literal": "^1.0.0",
+    "mdast-util-gfm-strikethrough": "^1.0.0",
+    "mdast-util-gfm-table": "^1.0.0",
+    "mdast-util-gfm-task-list-item": "^1.0.0"
   },
   "devDependencies": {
+    "@types/tape": "^4.0.0",
+    "c8": "^7.0.0",
     "github-slugger": "^1.0.0",
-    "hast-util-to-html": "^7.0.0",
-    "mdast-util-from-markdown": "^0.8.0",
-    "mdast-util-to-hast": "^10.0.0",
-    "micromark-extension-gfm": "^0.3.0",
+    "hast-util-to-html": "^8.0.0",
+    "mdast-util-from-markdown": "^1.0.0",
+    "mdast-util-to-hast": "^11.0.0",
+    "mdast-util-to-markdown": "^1.0.0",
+    "micromark-extension-gfm": "^1.0.0",
     "node-fetch": "^2.0.0",
-    "nyc": "^15.0.0",
     "prettier": "^2.0.0",
     "remark-cli": "^9.0.0",
     "remark-preset-wooorm": "^8.0.0",
+    "rimraf": "^3.0.0",
     "tape": "^5.0.0",
-    "xo": "^0.37.0"
+    "type-coverage": "^2.0.0",
+    "typescript": "^4.0.0",
+    "xo": "^0.39.0"
   },
   "scripts": {
+    "build": "rimraf \"*.d.ts\" && tsc && type-coverage",
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
     "crawl": "node script/crawl-tests",
-    "test-api": "node test",
-    "test-coverage": "nyc --reporter lcov tape test/index.js",
-    "test": "npm run format && npm run test-coverage"
+    "test-api": "node --conditions development test/index.js",
+    "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node --conditions development test/index.js",
+    "test": "npm run build && npm run format && npm run test-coverage"
   },
-  "nyc": {
-    "check-coverage": true,
-    "lines": 100,
-    "functions": 100,
-    "branches": 100
-  },
   "prettier": {
@@ -82,8 +84,3 @@ "tabWidth": 2,
   "xo": {
-    "prettier": true,
-    "esnext": false,
-    "rules": {
-      "guard-for-in": "off",
-      "unicorn/prefer-optional-catch-binding": "off"
-    }
+    "prettier": true
   },
@@ -94,3 +91,9 @@ "remarkConfig": {
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true,
+    "ignoreCatch": true
   }
 }

readme.md

@@ -17,5 +17,9 @@ # mdast-util-gfm
 
-You probably shouldn’t use this package directly, but instead use
-[`remark-gfm`][remark-gfm] with **[remark][]**.
+## When to use this
 
+Use this if you’re dealing with the AST manually and need all of GFM.
+It’s probably nicer to use [`remark-gfm`][remark-gfm] with
+**[remark][]**, which includes this but provides a nicer interface and
+makes it easier to combine with hundreds of plugins.
+
 Alternatively, the extensions can be used separately:
@@ -34,2 +38,5 @@
 
+This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c):
+Node 12+ is needed to use it and it must be `import`ed instead of `require`d.
+
 [npm][]:
@@ -67,16 +74,16 @@
 
-And our script, `example.js`, looks as follows:
+And our module, `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')
-var gfm = require('mdast-util-gfm')
+import fs from 'node:fs'
+import {fromMarkdown} from 'mdast-util-from-markdown'
+import {toMarkdown} from 'mdast-util-to-markdown'
+import {gfm} from 'micromark-extension-gfm'
+import {gfmFromMarkdown, gfmToMarkdown} from 'mdast-util-gfm'
 
-var doc = fs.readFileSync('example.md')
+const doc = fs.readFileSync('example.md')
 
-var tree = fromMarkdown(doc, {
-  extensions: [syntax()],
-  mdastExtensions: [gfm.fromMarkdown]
+const tree = fromMarkdown(doc, {
+  extensions: [gfm()],
+  mdastExtensions: [gfmFromMarkdown]
 })
@@ -86,3 +93,3 @@
 
-var out = toMarkdown(tree, {extensions: [gfm.toMarkdown()]})
+const out = toMarkdown(tree, {extensions: [gfmToMarkdown()]})
 
@@ -219,9 +226,9 @@ console.log(out)
 
-### `gfm.fromMarkdown`
+This package exports the following identifier: `gfmFromMarkdown`,
+`gfmToMarkdown`.
+There is no default export.
 
-### `gfm.toMarkdown(options?)`
+### `gfmFromMarkdown`
 
-> Note: the separate extensions are also available at
-> `mdast-util-gfm/from-markdown` and
-> `mdast-util-gfm/to-markdown`.
+### `gfmToMarkdown(options?)`
 
@@ -238,6 +245,2 @@ Support GFM.
 
-The exports are extensions, respectively
-for [`mdast-util-from-markdown`][from-markdown] and
-[`mdast-util-to-markdown`][to-markdown].
-
 ## Related
@@ -244,0 +247,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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

13844

increased by2.4%

Dependency count

4

decreased by-20%

Lines of code

56

increased by1.82%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

324

increased by0.93%

Is type module

Yes

Worsened metrics

Dev dependency count

17

increased by41.67%

Number of package files

5

decreased by-16.67%

Dependency changes

• + Added@types/debug@4.1.12(transitive)

• + Added@types/mdast@3.0.15(transitive)

• + Added@types/ms@0.7.34(transitive)

• + Addedccount@2.0.1(transitive)

• + Addedcharacter-entities@2.0.2(transitive)

• + Addeddecode-named-character-reference@1.0.2(transitive)

• + Addeddequal@2.0.3(transitive)

• + Addeddiff@5.2.0(transitive)

• + Addedescape-string-regexp@5.0.0(transitive)

• + Addedkleur@4.1.5(transitive)

• + Addedlongest-streak@3.1.0(transitive)

• + Addedmarkdown-table@3.0.3(transitive)

• + Addedmdast-util-find-and-replace@2.2.2(transitive)

• + Addedmdast-util-from-markdown@1.3.1(transitive)

• + Addedmdast-util-gfm-autolink-literal@1.0.3(transitive)

• + Addedmdast-util-gfm-strikethrough@1.0.3(transitive)

• + Addedmdast-util-gfm-table@1.0.7(transitive)

• + Addedmdast-util-gfm-task-list-item@1.0.2(transitive)

• + Addedmdast-util-phrasing@3.0.1(transitive)

• + Addedmdast-util-to-markdown@1.5.0(transitive)

• + Addedmdast-util-to-string@3.2.0(transitive)

• + Addedmicromark@3.2.0(transitive)

• + Addedmicromark-core-commonmark@1.1.0(transitive)

• + Addedmicromark-factory-destination@1.1.0(transitive)

• + Addedmicromark-factory-label@1.1.0(transitive)

• + Addedmicromark-factory-space@1.1.0(transitive)

• + Addedmicromark-factory-title@1.1.0(transitive)

• + Addedmicromark-factory-whitespace@1.1.0(transitive)

• + Addedmicromark-util-character@1.2.0(transitive)

• + Addedmicromark-util-chunked@1.1.0(transitive)

• + Addedmicromark-util-classify-character@1.1.0(transitive)

• + Addedmicromark-util-combine-extensions@1.1.0(transitive)

• + Addedmicromark-util-decode-numeric-character-reference@1.1.0(transitive)

• + Addedmicromark-util-decode-string@1.1.0(transitive)

• + Addedmicromark-util-encode@1.1.0(transitive)

• + Addedmicromark-util-html-tag-name@1.2.0(transitive)

• + Addedmicromark-util-normalize-identifier@1.1.0(transitive)

• + Addedmicromark-util-resolve-all@1.1.0(transitive)

• + Addedmicromark-util-sanitize-uri@1.2.0(transitive)

• + Addedmicromark-util-subtokenize@1.1.0(transitive)

• + Addedmicromark-util-symbol@1.1.0(transitive)

• + Addedmicromark-util-types@1.1.0(transitive)

• + Addedmri@1.2.0(transitive)

• + Addedsade@1.8.1(transitive)

• + Addedunist-util-is@5.2.1(transitive)

• + Addedunist-util-stringify-position@3.0.3(transitive)

• + Addedunist-util-visit@4.1.2(transitive)

• + Addedunist-util-visit-parents@5.1.3(transitive)

• + Addeduvu@0.5.6(transitive)

• + Addedzwitch@2.0.4(transitive)

• - Removedmdast-util-to-markdown@^0.6.1

• - Removedccount@1.1.0(transitive)

• - Removedcharacter-entities@1.2.4(transitive)

• - Removedcharacter-entities-legacy@1.1.4(transitive)

• - Removedcharacter-reference-invalid@1.1.4(transitive)

• - Removedescape-string-regexp@4.0.0(transitive)

• - Removedis-alphabetical@1.0.4(transitive)

• - Removedis-alphanumerical@1.0.4(transitive)

• - Removedis-decimal@1.0.4(transitive)

• - Removedis-hexadecimal@1.0.4(transitive)

• - Removedlongest-streak@2.0.4(transitive)

• - Removedmarkdown-table@2.0.0(transitive)

• - Removedmdast-util-find-and-replace@1.1.1(transitive)

• - Removedmdast-util-gfm-autolink-literal@0.1.3(transitive)

• - Removedmdast-util-gfm-strikethrough@0.2.3(transitive)

• - Removedmdast-util-gfm-table@0.1.6(transitive)

• - Removedmdast-util-gfm-task-list-item@0.1.6(transitive)

• - Removedmdast-util-to-markdown@0.6.5(transitive)

• - Removedmdast-util-to-string@2.0.0(transitive)

• - Removedmicromark@2.11.4(transitive)

• - Removedparse-entities@2.0.0(transitive)

• - Removedrepeat-string@1.6.1(transitive)

• - Removedunist-util-is@4.1.0(transitive)

• - Removedunist-util-visit-parents@3.1.1(transitive)

• - Removedzwitch@1.0.5(transitive)

• Updatedmdast-util-gfm-autolink-literal@^1.0.0

• Updatedmdast-util-gfm-strikethrough@^1.0.0

• Updatedmdast-util-gfm-table@^1.0.0

• Updatedmdast-util-gfm-task-list-item@^1.0.0