@mdx-js/mdx - npm Package Compare versions

Comparing version 0.16.0 to 0.16.1

index.js

@@ -60,3 +60,3 @@ const unified = require('unified')
   mdPlugins.forEach(plugin => {
-    // handle [plugin, pluginOptions] syntax
+    // Handle [plugin, pluginOptions] syntax
     if (Array.isArray(plugin) && plugin.length > 1) {
@@ -79,3 +79,3 @@ fn.use(plugin[0], plugin[1])
   hastPlugins.forEach(plugin => {
-    // handle [plugin, pluginOptions] syntax
+    // Handle [plugin, pluginOptions] syntax
     if (Array.isArray(plugin) && plugin.length > 1) {
@@ -108,8 +108,8 @@ compiler.use(plugin[0], plugin[1])
 
-  const fileOpts = { contents: mdx };
+  const fileOpts = {contents: mdx}
   if (opts.filepath) {
-    fileOpts.path = opts.filepath;
+    fileOpts.path = opts.filepath
   }
 
-  const { contents } = compiler.processSync(fileOpts)
+  const {contents} = compiler.processSync(fileOpts)
 
@@ -123,8 +123,8 @@ return contents
 
-  const fileOpts = { contents: mdx };
+  const fileOpts = {contents: mdx}
   if (opts.filepath) {
-    fileOpts.path = opts.filepath;
+    fileOpts.path = opts.filepath
   }
 
-  const { contents } = await compiler.process(fileOpts)
+  const {contents} = await compiler.process(fileOpts)
 
@@ -131,0 +131,0 @@ return contents

md-ast-to-mdx-ast.js

@@ -5,6 +5,3 @@ const visit = require('unist-util-visit')
   visit(tree, 'html', node => {
-    if (
-      node.value.startsWith('<!--') &&
-      node.value.endsWith('-->')
-    ) {
+    if (node.value.startsWith('<!--') && node.value.endsWith('-->')) {
       node.type = 'comment'
@@ -11,0 +8,0 @@ } else {

mdx-ast-to-mdx-hast.js

@@ -5,3 +5,3 @@ const toHAST = require('mdast-util-to-hast')
 
-module.exports = function mdxAstToMdxHast() {
+function mdxAstToMdxHast() {
   return (tree, file) => {
@@ -25,5 +25,4 @@ const handlers = {
       code(h, node) {
-        const langRegex = /^[^ \t]+(?=[ \t]|$)/
         const value = node.value ? detab(node.value + '\n') : ''
-        const lang = node.lang && node.lang.match(langRegex)
+        const lang = node.lang
         const props = {}
@@ -34,8 +33,8 @@
         }
-        
-        props.metastring = node.lang && node.lang.replace(langRegex, '').trim()
 
+        props.metastring = node.meta
+
         const meta =
-          props.metastring &&
-          props.metastring.split(' ').reduce((acc, cur) => {
+          node.meta &&
+          node.meta.split(' ').reduce((acc, cur) => {
             if (cur.split('=').length > 1) {
@@ -45,9 +44,12 @@ const t = cur.split('=')
               return acc
-            } else {
-              acc[cur] = true
-              return acc
             }
+            acc[cur] = true
+            return acc
           }, {})
 
-        meta && Object.keys(meta).forEach(key => (props[key] = meta[key]))
+        if (meta) {
+          Object.keys(meta).forEach(key => {
+            props[key] = meta[key]
+          })
+        }
 
@@ -87,1 +89,3 @@ return h(node.position, 'pre', [
 }
+
+module.exports = mdxAstToMdxHast

mdx-hast-to-jsx.js

 const toStyleObject = require('to-style').object
-const { paramCase } = require('change-case')
+const {paramCase} = require('change-case')
 
+// eslint-disable-next-line complexity
 function toJSX(node, parentNode = {}, options = {}) {
   const {
-    // default options
+    // Default options
     skipExport = false,
-    preserveNewlines = false,
+    preserveNewlines = false
   } = options
@@ -14,13 +15,17 @@ let children = ''
     if (typeof node.properties.style === 'string') {
-      node.properties.style = toStyleObject(node.properties.style, { camelize: true })
+      node.properties.style = toStyleObject(node.properties.style, {
+        camelize: true
+      })
     }
 
-    // ariaProperty => aria-property
+    // AriaProperty => aria-property
     // dataProperty => data-property
     const paramCaseRe = /^(aria[A-Z])|(data[A-Z])/
-    node.properties = Object.entries(node.properties).reduce((properties, [key, value]) => Object.assign(
-      {},
-      properties,
-      { [paramCaseRe.test(key) ? paramCase(key) : key]: value },
-    ), {})
+    node.properties = Object.entries(node.properties).reduce(
+      (properties, [key, value]) =>
+        Object.assign({}, properties, {
+          [paramCaseRe.test(key) ? paramCase(key) : key]: value
+        }),
+      {}
+    )
   }
@@ -53,2 +58,3 @@
 
+          // eslint-disable-next-line max-depth
           if (/\}\s*from\s+/.test(childNode.value)) {
@@ -77,7 +83,11 @@ example = `
 
-          throw new Error(`
+          throw new Error(
+            `
             MDX doesn't support using "default" as a named export, use "export default" statement instead.
 
             ${example}
-          `.trim().replace(/^ +/gm, ''))
+          `
+              .trim()
+              .replace(/^ +/gm, '')
+          )
         }
@@ -91,3 +101,2 @@
     }
-
     return (
@@ -98,22 +107,31 @@ importNodes.map(childNode => toJSX(childNode, node)).join('\n') +
       '\n' +
-      (skipExport
-        ? ''
-        : 'export default ({components, ...props}) => ') +
-      `<MDXTag name="wrapper" ${
-        layout ? `Layout={${layout}} layoutProps={props}` : ''
-      } components={components}>${jsxNodes
-        .map(childNode => toJSX(childNode, node))
-        .join('')}</MDXTag>`
+      `${
+        skipExport ? '' : 'export default'
+      } class MDXContent extends React.Component {
+  constructor() {
+    this.layout = ${layout}
+  }
+  render() {
+    return <MDXTag
+             name="wrapper"
+             ${layout ? `Layout={this.layout} layoutProps={props}` : ''}
+             components={components}>${jsxNodes
+               .map(childNode => toJSX(childNode, node))
+               .join('')}
+           </MDXTag>
+  }
+}`
     )
   }
-
-  // recursively walk through children
+  // Recursively walk through children
   if (node.children) {
-    children = node.children.map(childNode => {
-      const childOptions = Object.assign({}, options, {
-        // tell all children inside <pre> tags to preserve newlines as text nodes
-        preserveNewlines: preserveNewlines || node.tagName === 'pre',
+    children = node.children
+      .map(childNode => {
+        const childOptions = Object.assign({}, options, {
+          // Tell all children inside <pre> tags to preserve newlines as text nodes
+          preserveNewlines: preserveNewlines || node.tagName === 'pre'
+        })
+        return toJSX(childNode, node, childOptions)
       })
-      return toJSX(childNode, node, childOptions)
-    }).join('')
+      .join('')
   }
@@ -148,5 +166,3 @@
   if (node.type === 'comment') {
-    return node.value
-      .replace('<!--', '{/*')
-      .replace('-->', '*/}')
+    return node.value.replace('<!--', '{/*').replace('-->', '*/}')
   }
@@ -153,0 +169,0 @@

package.json

 {
   "name": "@mdx-js/mdx",
-  "version": "0.16.0",
+  "version": "0.16.1",
+  "description": "Parse MDX and transpile to JSX",
   "license": "MIT",
+  "keywords": [
+    "mdx",
+    "markdown",
+    "react",
+    "jsx",
+    "remark",
+    "mdxast"
+  ],
+  "homepage": "https://mdxjs.com",
   "repository": "mdx-js/mdx",
-  "description": "Parse MDX and transpile to JSX",
+  "bugs": "https://github.com/mdx-js/mdx/issues",
+  "author": "John Otander <[e-mail]> (http://johnotander.com)",
+  "contributors": [
+    "John Otander <[e-mail]> (http://johnotander.com)",
+    "Tim Neutkens <[e-mail]>",
+    "Matija Marohnić <[e-mail]>",
+    "Titus Wormer <[e-mail]> (https://wooorm.com)"
+  ],
   "files": [
@@ -14,20 +31,10 @@ "index.js",
   ],
-  "scripts": {
-    "test": "jest"
-  },
-  "keywords": [
-    "react",
-    "markdown",
-    "remark",
-    "mdxast",
-    "mdx"
-  ],
   "dependencies": {
     "change-case": "^3.0.2",
     "detab": "^2.0.0",
-    "mdast-util-to-hast": "^3.0.0",
-    "remark-parse": "^5.0.0",
+    "mdast-util-to-hast": "^4.0.0",
+    "remark-parse": "^6.0.0",
     "remark-squeeze-paragraphs": "^3.0.1",
     "to-style": "^1.3.3",
-    "unified": "^6.1.6",
+    "unified": "^7.0.0",
     "unist-builder": "^1.0.1",
@@ -37,16 +44,19 @@ "unist-util-visit": "^1.3.0"
   "devDependencies": {
-    "@babel/core": "^7.0.0-beta.44",
-    "@babel/plugin-proposal-object-rest-spread": "^7.0.0-beta.44",
-    "@babel/plugin-syntax-jsx": "^7.0.0-beta.44",
-    "@mapbox/rehype-prism": "^0.2.0",
-    "hast-util-select": "^1.0.1",
-    "jest": "^22.4.3",
+    "@babel/core": "^7.0.0",
+    "@babel/plugin-proposal-object-rest-spread": "^7.0.0",
+    "@babel/plugin-syntax-jsx": "^7.0.0",
+    "@mapbox/rehype-prism": "^0.3.0",
+    "hast-util-select": "^3.0.0",
+    "jest": "^23.6.0",
+    "prettier": "^1.14.2",
     "rehype-katex": "^1.1.1",
-    "remark-math": "^1.0.4",
-    "request-image-size": "^2.1.0"
+    "remark-math": "^1.0.4"
   },
+  "scripts": {
+    "test": "jest"
+  },
   "jest": {
     "testEnvironment": "node"
   },
-  "gitHead": "2c1c8676327f97b060283c5a9047574d8ada11ec"
+  "gitHead": "b69654652e22043592da6db45bc8306b05c783ad"
 }

readme.md

@@ -1,11 +0,78 @@
-# @mdx-js/mdx
+# `@mdx-js/mdx`
 
-MDX implementation using Remark.
+[![Build Status][build-badge]][build]
+[![lerna][lerna-badge]][lerna]
+[![Join the community on Spectrum][spectrum-badge]][spectrum]
 
-https://github.com/mdx-js/mdx
+[MDX][] implementation using [remark][].
 
 ## Installation
 
+[npm][]:
+
 ```sh
 npm i -S @mdx-js/mdx
 ```
+
+## Usage
+
+```js
+const mdx = require('@mdx-js/mdx')
+
+const result = await mdx(`
+# Hello, MDX
+
+I <3 Markdown and JSX
+`)
+
+console.log(result)
+```
+
+Yields:
+
+```js
+export default ({components, ...props}) => <MDXTag name="wrapper"  components={components}><MDXTag name="h1" components={components}>{`Hello, MDX`}</MDXTag>
+<MDXTag name="p" components={components}>{`I <3 Markdown and JSX`}</MDXTag></MDXTag>
+```
+
+## Contribute
+
+See [`contributing.md` in `mdx-js/mdx`][contributing] for ways to get started.
+
+This organisation has a [Code of Conduct][coc].
+By interacting with this repository, organisation, or community you agree to
+abide by its terms.
+
+## License
+
+[MIT][] © [Compositor][] and [ZEIT][]
+
+<!-- Definitions -->
+
+[build]: https://travis-ci.org/mdx-js/mdx
+
+[build-badge]: https://travis-ci.org/mdx-js/mdx.svg?branch=master
+
+[lerna]: https://lernajs.io/
+
+[lerna-badge]: https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg
+
+[spectrum]: https://spectrum.chat/mdx
+
+[spectrum-badge]: https://withspectrum.github.io/badge/badge.svg
+
+[contributing]: https://github.com/mdx-js/mdx/blob/master/contributing.md
+
+[coc]: https://github.com/mdx-js/mdx/blob/master/code-of-conduct.md
+
+[mit]: license
+
+[remark]: https://github.com/remarkjs/remark
+
+[compositor]: https://compositor.io
+
+[zeit]: https://zeit.co
+
+[mdx]: https://github.com/mdx-js/mdx
+
+[npm]: https://docs.npmjs.com/cli/install

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 contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

15084

increased by16.04%

Lines of code

356

increased by5.33%

Number of low maintenance alerts

1

decreased by-50%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

79

increased by558.33%

Dependency changes

• + Added@types/node@22.7.7(transitive)

• + Added@types/unist@2.0.113.0.3(transitive)

• + Added@types/vfile@3.0.2(transitive)

• + Added@types/vfile-message@2.0.0(transitive)

• + Addedis-buffer@2.0.5(transitive)

• + Addedmdast-util-to-hast@4.0.0(transitive)

• + Addedremark-parse@6.0.3(transitive)

• + Addedundici-types@6.19.8(transitive)

• + Addedunified@7.1.0(transitive)

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

• + Addedvfile@3.0.1(transitive)

• + Addedvfile-message@4.0.2(transitive)

• - Removedis-buffer@1.1.6(transitive)

• - Removedmdast-util-to-hast@3.0.4(transitive)

• - Removedremark-parse@5.0.0(transitive)

• - Removedunified@6.2.0(transitive)

• - Removedvfile@2.3.0(transitive)

• Updatedmdast-util-to-hast@^4.0.0

• Updatedremark-parse@^6.0.0

• Updatedunified@^7.0.0