mdast-util-mdx - npm Package Compare versions

Comparing version 0.1.1 to 1.0.0

index.js

@@ -1,2 +0,23 @@
-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
+ */
+
+import {
+  mdxExpressionFromMarkdown,
+  mdxExpressionToMarkdown
+} from 'mdast-util-mdx-expression'
+import {mdxJsxFromMarkdown, mdxJsxToMarkdown} from 'mdast-util-mdx-jsx'
+import {mdxjsEsmFromMarkdown, mdxjsEsmToMarkdown} from 'mdast-util-mdxjs-esm'
+
+/** @type {FromMarkdownExtension[]} */
+export const mdxFromMarkdown = [
+  mdxExpressionFromMarkdown,
+  mdxJsxFromMarkdown,
+  mdxjsEsmFromMarkdown
+]
+
+/** @type {ToMarkdownExtension} */
+export const mdxToMarkdown = {
+  extensions: [mdxExpressionToMarkdown, mdxJsxToMarkdown, mdxjsEsmToMarkdown]
+}

package.json

 {
   "name": "mdast-util-mdx",
-  "version": "0.1.1",
+  "version": "1.0.0",
   "description": "mdast extension to parse and serialize MDX (or MDX.js)",
@@ -30,36 +30,38 @@ "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-mdx-expression": "~0.1.0",
-    "mdast-util-mdx-jsx": "~0.1.0",
-    "mdast-util-mdxjs-esm": "~0.1.0",
-    "mdast-util-to-markdown": "^0.6.1"
+    "mdast-util-mdx-expression": "^1.0.0",
+    "mdast-util-mdx-jsx": "^1.0.0",
+    "mdast-util-mdxjs-esm": "^1.0.0"
   },
   "devDependencies": {
-    "mdast-util-from-markdown": "^0.8.0",
-    "micromark-extension-mdx": "^0.1.0",
-    "micromark-extension-mdxjs": "^0.1.0",
-    "nyc": "^15.0.0",
+    "@types/tape": "^4.0.0",
+    "c8": "^7.0.0",
+    "mdast-util-from-markdown": "^1.0.0",
+    "mdast-util-to-markdown": "^1.0.0",
+    "micromark-extension-mdx": "^1.0.0",
+    "micromark-extension-mdxjs": "^1.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.36.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",
-    "test-api": "node test",
-    "test-coverage": "nyc --reporter lcov tape test.js",
-    "test": "npm run format && npm run test-coverage"
+    "test-api": "node --conditions development test.js",
+    "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node --conditions development test.js",
+    "test": "npm run build && npm run format && npm run test-coverage"
   },
-  "nyc": {
-    "check-coverage": true,
-    "lines": 100,
-    "functions": 100,
-    "branches": 100
-  },
   "prettier": {
@@ -74,8 +76,3 @@ "tabWidth": 2,
   "xo": {
-    "prettier": true,
-    "esnext": false,
-    "rules": {
-      "guard-for-in": "off",
-      "unicorn/prefer-optional-catch-binding": "off"
-    }
+    "prettier": true
   },
@@ -86,3 +83,9 @@ "remarkConfig": {
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true,
+    "ignoreCatch": true
   }
 }

readme.md

@@ -17,6 +17,6 @@ # mdast-util-mdx
 
-You might instead want to use this package through `remark-mdx` or
-`remark-mdxjs` with **[remark][]**.
+## When to use this
 
-Alternatively, the extensions can be used separately:
+Use this if you’re dealing with the AST manually and want to support all of MDX.
+You can also use the extensions separately:
 
@@ -32,2 +32,5 @@ *   [`mdast-util-mdx-expression`](https://github.com/syntax-tree/mdast-util-mdx-expression)
 
+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][]:
@@ -64,13 +67,13 @@
 ```js
-var fs = require('fs')
-var fromMarkdown = require('mdast-util-from-markdown')
-var toMarkdown = require('mdast-util-to-markdown')
-var syntax = require('micromark-extension-mdxjs')
-var mdx = require('mdast-util-mdx')
+import fs from 'node:fs'
+import {fromMarkdown} from 'mdast-util-from-markdown'
+import {toMarkdown} from 'mdast-util-to-markdown'
+import {mdxjs} from 'micromark-extension-mdxjs'
+import {mdxFromMarkdown, mdxToMarkdown} from 'mdast-util-mdx'
 
-var doc = fs.readFileSync('example.mdx')
+const doc = fs.readFileSync('example.mdx')
 
-var tree = fromMarkdown(doc, {
-  extensions: [syntax()],
-  mdastExtensions: [mdx.fromMarkdown]
+const tree = fromMarkdown(doc, {
+  extensions: [mdxjs()],
+  mdastExtensions: [mdxFromMarkdown]
 })
@@ -80,3 +83,3 @@
 
-var out = toMarkdown(tree, {extensions: [mdx.toMarkdown]})
+const out = toMarkdown(tree, {extensions: [mdxToMarkdown]})
 
@@ -107,3 +110,3 @@ console.log(out)
               ],
-              source: {type: 'Literal', value: 'place'}
+              source: {type: 'Literal', value: 'place', raw: '"place"'}
             }
@@ -124,6 +127,15 @@ ],
         estree: {
-          type: 'BinaryExpression',
-          left: {type: 'Literal', value: 1},
-          operator: '+',
-          right: {type: 'Literal', value: 1}
+          type: 'Program',
+          body: [
+            {
+              type: 'ExpressionStatement',
+              expression: {
+                type: 'BinaryExpression',
+                left: {type: 'Literal', value: 1, raw: '1'},
+                operator: '+',
+                right: {type: 'Literal', value: 1, raw: '1'}
+              }
+            }
+          ],
+          sourceType: 'module'
         }
@@ -141,6 +153,15 @@ }
             estree: {
-              type: 'BinaryExpression',
-              left: {type: 'Literal', value: 1},
-              operator: '+',
-              right: {type: 'Literal', value: 1}
+              type: 'Program',
+              body: [
+                {
+                  type: 'ExpressionStatement',
+                  expression: {
+                    type: 'BinaryExpression',
+                    left: {type: 'Literal', value: 1, raw: '1'},
+                    operator: '+',
+                    right: {type: 'Literal', value: 1, raw: '1'}
+                  }
+                }
+              ],
+              sourceType: 'module'
             }
@@ -211,13 +232,13 @@ }
 
-### `mdx.fromMarkdown`
+This package exports the following identifier: `mdxFromMarkdown`,
+`mdxToMarkdown`.
+There is no default export.
 
-### `mdx.toMarkdown`
+### `mdxFromMarkdown`
 
-> Note: the separate extensions are also available at
-> `mdast-util-mdx/from-markdown` and `mdast-util-mdx/to-markdown`.
+### `mdxToMarkdown`
 
 Support MDX (or MDX.js).
-The exports of `fromMarkdown` is an extension for
-[`mdast-util-from-markdown`][from-markdown].
-The export of `toMarkdown` is an extension for
+The exports are respectively an extension for
+[`mdast-util-from-markdown`][from-markdown] and
 [`mdast-util-to-markdown`][to-markdown].
@@ -231,6 +252,4 @@
     — markdown processor powered by plugins
-*   `remarkjs/remark-mdx`
-    — remark plugin to support MDX
-*   `remarkjs/remark-mdxjs`
-    — remark plugin to support MDX.js
+*   [`remarkjs/remark-mdx`][remark-mdx]
+    — remark plugin to support MDX (or MDX.js)
 *   [`micromark/micromark`][micromark]
@@ -314,1 +333,3 @@ — the smallest commonmark-compliant markdown parser that exists
 [mdxjs]: https://github.com/micromark/micromark-extension-mdxjs
+
+[remark-mdx]: https://github.com/mdx-js/mdx/tree/next/packages/remark-mdx

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

12784

increased by5.45%

Dependency count

3

decreased by-25%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

326

increased by6.89%

Is type module

Yes

Worsened metrics

Dev dependency count

14

increased by55.56%

Number of package files

5

decreased by-16.67%

Lines of code

26

decreased by-38.1%

Dependency changes

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

• + Added@types/estree@1.0.6(transitive)

• + Added@types/estree-jsx@0.0.11.0.5(transitive)

• + Added@types/hast@2.3.10(transitive)

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

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

• + Addedcharacter-entities@2.0.2(transitive)

• + Addedcharacter-entities-html4@2.1.0(transitive)

• + Addedcharacter-entities-legacy@3.0.0(transitive)

• + Addedcharacter-reference-invalid@2.0.1(transitive)

• + Addeddebug@4.3.7(transitive)

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

• + Addeddequal@2.0.3(transitive)

• + Addeddiff@5.2.0(transitive)

• + Addedis-alphabetical@2.0.1(transitive)

• + Addedis-alphanumerical@2.0.1(transitive)

• + Addedis-decimal@2.0.1(transitive)

• + Addedis-hexadecimal@2.0.1(transitive)

• + Addedkleur@4.1.5(transitive)

• + Addedlongest-streak@3.1.0(transitive)

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

• + Addedmdast-util-mdx-expression@1.3.2(transitive)

• + Addedmdast-util-mdx-jsx@1.2.0(transitive)

• + Addedmdast-util-mdxjs-esm@1.3.1(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)

• + Addedms@2.1.3(transitive)

• + Addedparse-entities@4.0.1(transitive)

• + Addedsade@1.8.1(transitive)

• + Addedstringify-entities@4.0.4(transitive)

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

• + Addedunist-util-remove-position@4.0.2(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)

• + Addedvfile-message@3.1.4(transitive)

• + Addedzwitch@2.0.4(transitive)

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

• - Removedcharacter-entities@1.2.4(transitive)

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

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

• - Removedcharacter-reference-invalid@1.1.4(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)

• - Removedmdast-util-mdx-expression@0.1.1(transitive)

• - Removedmdast-util-mdx-jsx@0.1.4(transitive)

• - Removedmdast-util-mdxjs-esm@0.1.1(transitive)

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

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

• - Removedmin-indent@1.0.1(transitive)

• - Removedparse-entities@2.0.0(transitive)

• - Removedrepeat-string@1.6.1(transitive)

• - Removedstringify-entities@3.1.0(transitive)

• - Removedstrip-indent@3.0.0(transitive)

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

• - Removedunist-util-remove-position@3.0.0(transitive)

• - Removedunist-util-stringify-position@2.0.3(transitive)

• - Removedunist-util-visit@2.0.3(transitive)

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

• - Removedvfile-message@2.0.4(transitive)

• - Removedxtend@4.0.2(transitive)

• - Removedzwitch@1.0.5(transitive)

• Updatedmdast-util-mdx-expression@^1.0.0

• Updatedmdast-util-mdx-jsx@^1.0.0

• Updatedmdast-util-mdxjs-esm@^1.0.0