micromark-extension-mdx-md - npm Package Compare versions

Comparing version 0.1.1 to 1.0.0

index.js

@@ -1,5 +0,6 @@
-'use strict'
-
-module.exports = {
+/**
+ * @type {import('micromark-util-types').Extension}
+ */
+export const mdxMd = {
   disable: {null: ['autolink', 'codeIndented', 'htmlFlow', 'htmlText']}
 }

package.json

 {
   "name": "micromark-extension-mdx-md",
-  "version": "0.1.1",
+  "version": "1.0.0",
   "description": "micromark extension to turn some markdown features off for MDX",
@@ -25,27 +25,33 @@ "license": "MIT",
   ],
+  "sideEffects": false,
+  "type": "module",
+  "main": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js"
   ],
-  "dependencies": {},
+  "dependencies": {
+    "micromark-util-types": "^1.0.0"
+  },
   "devDependencies": {
-    "micromark": "~2.11.0",
-    "nyc": "^15.0.0",
+    "@types/tape": "^4.0.0",
+    "c8": "^7.0.0",
+    "micromark": "^3.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.40.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": {
@@ -60,7 +66,3 @@ "tabWidth": 2,
   "xo": {
-    "prettier": true,
-    "esnext": false,
-    "rules": {
-      "max-params": "off"
-    }
+    "prettier": true
   },
@@ -75,3 +77,9 @@ "remarkConfig": {
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true,
+    "ignoreCatch": true
   }
 }

readme.md

@@ -16,10 +16,18 @@ # micromark-extension-mdx-md
 
-There is no corresponding **[mdast][]** utility.
-But you can use this through either [`micromark-extension-mdx`][mdx] or
-[`micromark-extension-mdxjs`][mdxjs] with [`mdast-util-mdx`][mdast-util-mdx] to
-support all of MDX (or MDX.js).
-Or, use it through `remark-mdx` or `remark-mdxjs` (**[remark][]**).
+## When to use this
 
+This package is already included in [xdm][] and [`mdx-js/mdx` (next)][mdx-js].
+
+You should probably use [`micromark-extension-mdx`][mdx] or
+[`micromark-extension-mdxjs`][mdxjs] instead, which combine this package with
+other MDX features.
+Alternatively, if you’re using [`micromark`][micromark] or
+[`mdast-util-from-markdown`][from-markdown] and you don’t want all of MDX, use
+this package.
+
 ## Install
 
+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][]:
@@ -34,19 +42,26 @@
 ```js
-var mdxMd = require('micromark-extension-mdx-md')
+import {micromark} from 'micromark'
+import {mdxMd} from 'micromark-extension-mdx-md'
 
-micromark('...', {extensions: [mdxMd]})
+const output = micromark('\ta', {extensions: [mdxMd]})
+
+console.log(output)
 ```
 
+Yields:
+
+```html
+<p>a</p>
+```
+
 ## API
 
-### `syntax()`
+This package exports the following identifiers: `mdxMd`.
+There is no default export.
 
-Turn some markdown features (HTML, autolinks, indented code) off for
-[MDX][mdx-js] (or MDX.js).
+### `mdxMd`
 
-The export of `syntax` is an extension for the micromark parser (to not tokenize
-some constructs; can be passed in `extensions`).
+An extension for micromark to turn some markdown features (HTML, autolinks,
+indented code) off (can be passed in `extensions`).
 
-There are no options yet.
-
 ## Related
@@ -60,8 +75,2 @@
     — micromark extension to support MDX.js
-*   [`micromark/micromark-extension-mdx-expression`][mdx-expression]
-    — micromark extension to support MDX (or MDX.js) expressions
-*   [`micromark/micromark-extension-mdx-jsx`][mdx-jsx]
-    — micromark extension to support MDX (or MDX.js) JSX
-*   [`micromark/micromark-extension-mdxjs-esm`][mdxjs-esm]
-    — micromark extension to support MDX.js import/exports
 *   [`syntax-tree/mdast-util-mdx`][mdast-util-mdx]
@@ -126,14 +135,6 @@ — mdast utility to support MDX (or MDX.js)
 
-[remark]: https://github.com/remarkjs/remark
+[xdm]: https://github.com/wooorm/xdm
 
-[mdast]: https://github.com/syntax-tree/mdast
-
 [mdx-js]: https://github.com/mdx-js/mdx
 
-[mdx-expression]: https://github.com/micromark/micromark-extension-mdx-expression
-
-[mdx-jsx]: https://github.com/micromark/micromark-extension-mdx-jsx
-
-[mdxjs-esm]: https://github.com/micromark/micromark-extension-mdxjs-esm
-
 [mdx]: https://github.com/micromark/micromark-extension-mdx
@@ -144,1 +145,3 @@
 [mdast-util-mdx]: https://github.com/syntax-tree/mdast-util-mdx
+
+[from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown

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

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

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

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

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

7557

increased by4.77%

Number of package files

5

increased by25%

Lines of code

10

increased by150%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

143

increased by2.14%

Is type module

Yes

Worsened metrics

Dependency count

1

increased byInfinity%

Dev dependency count

11

increased by57.14%

Dependency changes

• + Addedmicromark-util-types@^1.0.0

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