Fix linting (#1161)

* Fix linting * Fix error in remark formatter
mdx-js · Jul 17, 2020 · 3ca8e0a · 3ca8e0a
1 parent 577d48f
commit 3ca8e0a
Show file tree

Hide file tree

Showing 36 changed files with 63 additions and 61 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -21,3 +21,5 @@ packages/remark-mdx
 # tmp
 examples/vue
 packages/vue
+
+readme.md
diff --git a/docs/advanced/contributing.mdx b/docs/advanced/contributing.mdx
@@ -1 +1,3 @@
+import Redirect from 'gatsby-theme-mdx/src/components/redirect'
+
 <Redirect to="/contributing" />
diff --git a/docs/advanced/custom-loader.mdx b/docs/advanced/custom-loader.mdx
@@ -1 +1,3 @@
+import Redirect from 'gatsby-theme-mdx/src/components/redirect'
+
 <Redirect to="/guides/custom-loader" />
diff --git a/docs/advanced/retext-plugins.mdx b/docs/advanced/retext-plugins.mdx
@@ -1 +1,3 @@
+import Redirect from 'gatsby-theme-mdx/src/components/redirect'
+
 <Redirect to="/advanced/using-plugins#using-retext-plugins" />
diff --git a/docs/advanced/specification.mdx b/docs/advanced/specification.mdx
@@ -1 +1,3 @@
+import Redirect from 'gatsby-theme-mdx/src/components/redirect'
+
 <Redirect to="/advanced/ast" />
diff --git a/docs/advanced/sync-api.mdx b/docs/advanced/sync-api.mdx
@@ -1 +1,3 @@
+import Redirect from 'gatsby-theme-mdx/src/components/redirect'
+
 <Redirect to="/advanced/api#sync-api" />
diff --git a/docs/advanced/writing-a-plugin.mdx b/docs/advanced/writing-a-plugin.mdx
@@ -1 +1,3 @@
+import Redirect from 'gatsby-theme-mdx/src/components/redirect'
+
 <Redirect to="/guides/custom-loader" />
diff --git a/docs/editor-plugins.mdx b/docs/editor-plugins.mdx
@@ -1 +1,3 @@
+import Redirect from 'gatsby-theme-mdx/src/components/redirect'
+
 <Redirect to="/editors" />
diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx
@@ -1,6 +1,6 @@
 import {Box} from '@rebass/emotion'
 
-import TableOfComponents from './_table-of-components.mdx'
+import TableOfComponents from './table-of-components.mdx'
 
 # Getting Started
 

diff --git a/.../getting-started/_table-of-components.mdx → docs/getting-started/table-of-components.mdx b/.../getting-started/_table-of-components.mdx → docs/getting-started/table-of-components.mdx
diff --git a/docs/getting-started/typescript.mdx b/docs/getting-started/typescript.mdx
@@ -1 +1,3 @@
+import Redirect from 'gatsby-theme-mdx/src/components/redirect'
+
 <Redirect to="/advanced/typescript" />
diff --git a/docs/plugins.mdx b/docs/plugins.mdx
@@ -1 +1,3 @@
+import Redirect from 'gatsby-theme-mdx/src/components/redirect'
+
 <Redirect to="/advanced/plugins" />
diff --git a/docs/syntax.mdx b/docs/syntax.mdx
@@ -1 +1,3 @@
+import Redirect from 'gatsby-theme-mdx/src/components/redirect'
+
 <Redirect to="/getting-started#syntax" />
diff --git a/docs/table-of-components.mdx b/docs/table-of-components.mdx
@@ -1,4 +1,4 @@
-import TableOfComponents from './getting-started/_table-of-components.mdx'
+import TableOfComponents from './getting-started/table-of-components.mdx'
 
 # Table of components
 

diff --git a/examples/create-react-app/readme.md b/examples/create-react-app/readme.md
@@ -8,36 +8,42 @@ In the project directory, you can run:
 
 ### `npm start`
 
-Runs the app in the development mode.<br>
-Open <http://localhost:3000> to view it in the browser.
+Runs the app in the development mode.<br />
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 
-The page will reload if you make edits.<br>
+The page will reload if you make edits.<br />
 You will also see any lint errors in the console.
 
 ### `npm test`
 
-Launches the test runner in the interactive watch mode.<br>
+Launches the test runner in the interactive watch mode.<br />
 See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
 
 ### `npm run build`
 
-Builds the app for production to the `build` folder.<br>
+Builds the app for production to the `build` folder.<br />
 It correctly bundles React in production mode and optimizes the build for the best performance.
 
-The build is minified and the filenames include the hashes.<br>
+The build is minified and the filenames include the hashes.<br />
 Your app is ready to be deployed!
 
 See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
 
 ### `npm run eject`
 
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+**Note: this is a one-way operation.
+Once you `eject`, you can’t go back!**
 
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time.
+This command will remove the single build dependency from your project.
 
-Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them.
+All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them.
+At this point you’re on your own.
 
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+You don’t have to ever use `eject`.
+The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature.
+However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
 
 ## Learn More
 

diff --git a/package.json b/package.json
@@ -17,7 +17,7 @@
   },
   "scripts": {
     "build": "r -f cjs,esm -o dist --exclude 'babel-plugin-*,create-mdx,*loader,mdx,parcel-plugin-mdx,remark-*,*util'",
-    "clean": "lerna exec \"rimraf dist node_modules\"",
+    "clean": "lerna exec \"rimraf dist node_modules\" && gatsby clean",
     "docs": "gatsby develop",
     "docs-build": "gatsby build",
     "docs-deploy": "now && now alias $(pbpaste) mdxjs.com && now alias $(pbpaste) www.mdxjs.com",

diff --git a/packages/create-mdx/readme.md b/packages/create-mdx/readme.md
@@ -36,8 +36,6 @@ abide by its terms.
 
 [MIT][] © [Compositor][] and [Vercel][]
 
-<!-- Definitions -->
-
 [build]: https://travis-ci.com/mdx-js/mdx
 [build-badge]: https://travis-ci.com/mdx-js/mdx.svg?branch=master
 [lerna]: https://lernajs.io/

diff --git a/packages/gatsby-theme-mdx/src/components/code-preview.js b/packages/gatsby-theme-mdx/src/components/code-preview.js
@@ -14,7 +14,7 @@ const transformCode = isMDX => src => {
   let transpiledMDX
   try {
     transpiledMDX = mdx.sync(src, {skipExport: true})
-  } catch (e) {
+  } catch (_e) {
     return ''
   }
 

diff --git a/packages/gatsby-theme-mdx/src/components/playground-editor.js b/packages/gatsby-theme-mdx/src/components/playground-editor.js
@@ -18,7 +18,7 @@ const transformCode = src => {
       skipExport: true,
       remarkPlugins: [removeImports, removeExports]
     })
-  } catch (e) {
+  } catch (_e) {
     return ''
   }
 

diff --git a/packages/loader/readme.md b/packages/loader/readme.md
@@ -29,14 +29,17 @@ module: {
 }
 ```
 
-The `renderer` option specifies a string that will be prepended to the generated source allowing for the use of any `createElement` implementation. By default, that string is:
+The `renderer` option specifies a string that will be prepended to the generated
+source allowing for the use of any `createElement` implementation.
+By default, that string is:
 
 ```js
 import React from 'react'
 import {mdx} from '@mdx-js/react'
 ```
 
-Using the `renderer` option, one can swap out React for another implementation. The example below wraps a generic JSX compatible function named `h`.
+Using the `renderer` option, one can swap out React for another implementation.
+The example below wraps a generic JSX compatible function named `h`.
 
 ```js
 const renderer = `
@@ -89,8 +92,6 @@ abide by its terms.
 
 [MIT][] © [Compositor][] and [Vercel][]
 
-<!-- Definitions -->
-
 [build]: https://travis-ci.com/mdx-js/mdx
 [build-badge]: https://travis-ci.com/mdx-js/mdx.svg?branch=master
 [lerna]: https://lernajs.io/

diff --git a/packages/mdx/mdx-hast-to-jsx.js b/packages/mdx/mdx-hast-to-jsx.js
@@ -144,7 +144,6 @@ MDXContent.isMDXComponent = true`
     ]
   }).code
 
-  // TODO: Remove layout props entirely
   let layoutProps = 'const layoutProps = {'
 
   if (exportNames.length !== 0) {

diff --git a/packages/mdx/readme.md b/packages/mdx/readme.md
@@ -52,8 +52,6 @@ abide by its terms.
 
 [MIT][] © [Compositor][] and [Vercel][]
 
-<!-- Definitions -->
-
 [build]: https://travis-ci.com/mdx-js/mdx
 [build-badge]: https://travis-ci.com/mdx-js/mdx.svg?branch=master
 [lerna]: https://lernajs.io/

diff --git a/packages/parcel-plugin-mdx/readme.md b/packages/parcel-plugin-mdx/readme.md
@@ -44,8 +44,6 @@ abide by its terms.
 
 [MIT][] © [Compositor][] and [Vercel][]
 
-<!-- Definitions -->
-
 [build]: https://travis-ci.com/mdx-js/mdx
 [build-badge]: https://travis-ci.com/mdx-js/mdx.svg?branch=master
 [lerna]: https://lernajs.io/

diff --git a/packages/preact/readme.md b/packages/preact/readme.md
@@ -61,8 +61,6 @@ abide by its terms.
 
 [MIT][] © [Compositor][] and [Vercel][]
 
-<!-- Definitions -->
-
 [build]: https://travis-ci.com/mdx-js/mdx
 [build-badge]: https://travis-ci.com/mdx-js/mdx.svg?branch=master
 [lerna]: https://lernajs.io/

diff --git a/packages/preact/test/fixture.js b/packages/preact/test/fixture.js
@@ -1,6 +1,5 @@
 /* @jsx mdx */
 
-// eslint-disable-next-line no-unused-vars
 import {mdx} from '../src'
 
 const Component = ({components}) => <p>{Object.keys(components).join(', ')}</p>

diff --git a/packages/preact/test/test.js b/packages/preact/test/test.js
@@ -1,6 +1,5 @@
 /* @jsx h */
 import {render} from 'preact-render-to-string'
-// eslint-disable-next-line
 import {h} from 'preact'
 
 import {MDXProvider} from '../src/context'

diff --git a/packages/react/readme.md b/packages/react/readme.md
@@ -60,8 +60,6 @@ abide by its terms.
 
 [MIT][] © [Compositor][] and [Vercel][]
 
-<!-- Definitions -->
-
 [build]: https://travis-ci.com/mdx-js/mdx
 [build-badge]: https://travis-ci.com/mdx-js/mdx.svg?branch=master
 [lerna]: https://lernajs.io/

diff --git a/packages/react/test/fixture.js b/packages/react/test/fixture.js
@@ -1,6 +1,4 @@
 /* @jsx mdx */
-
-// eslint-disable-next-line no-unused-vars
 import {mdx} from '../src'
 
 const Component = ({components}) => <p>{Object.keys(components).join(', ')}</p>

diff --git a/packages/remark-mdx-remove-exports/readme.md b/packages/remark-mdx-remove-exports/readme.md
@@ -4,7 +4,9 @@
 [![lerna][lerna-badge]][lerna]
 [![Join the community on Spectrum][spectrum-badge]][spectrum]
 
-Remove export nodes from the [MDXAST][]. This is useful for scenarios where the exports aren’t needed like an MDX playground.
+Remove export nodes from the [MDXAST][].
+This is useful for scenarios where the exports aren’t needed like an
+MDX playground.
 
 ## Installation
 
@@ -74,8 +76,6 @@ abide by its terms.
 
 [MIT][] © [John Otander][johno]
 
-<!-- Definitions -->
-
 [build]: https://travis-ci.com/mdx-js/mdx
 [build-badge]: https://travis-ci.com/mdx-js/mdx.svg?branch=master
 [lerna]: https://lernajs.io/

diff --git a/packages/remark-mdx-remove-imports/readme.md b/packages/remark-mdx-remove-imports/readme.md
@@ -4,7 +4,8 @@
 [![lerna][lerna-badge]][lerna]
 [![Join the community on Spectrum][spectrum-badge]][spectrum]
 
-Remove import nodes from the [MDXAST][]. This is useful for scenarios where the imports aren’t needed like an MDX playground.
+Remove import nodes from the [MDXAST][].
+This is useful for scenarios where the imports aren’t needed, like an MDX playground.
 
 ## Installation
 
@@ -72,8 +73,6 @@ abide by its terms.
 
 [MIT][] © [John Otander][johno]
 
-<!-- Definitions -->
-
 [build]: https://travis-ci.com/mdx-js/mdx
 [build-badge]: https://travis-ci.com/mdx-js/mdx.svg?branch=master
 [lerna]: https://lernajs.io/

diff --git a/packages/remark-mdxjs/readme.md b/packages/remark-mdxjs/readme.md
@@ -27,8 +27,6 @@ abide by its terms.
 
 [MIT][] © [Titus Wormer][author] and [John Otander][author2]
 
-<!-- Definitions -->
-
 [build]: https://travis-ci.com/mdx-js/mdx
 [build-badge]: https://travis-ci.com/mdx-js/mdx.svg?branch=master
 [lerna]: https://lernajs.io/

diff --git a/packages/test-util/readme.md b/packages/test-util/readme.md
@@ -6,8 +6,6 @@ Test utility functions used in [MDX][].
 
 [MIT][] © [John Otander][author]
 
-<!-- Definitions -->
-
 [mit]: license
 [mdx]: https://github.com/mdx-js/mdx
 [author]: https://johno.com
diff --git a/packages/util/readme.md b/packages/util/readme.md
@@ -12,8 +12,6 @@ yarn add @mdx-js/util
 
 [MIT][] © [John Otander][author]
 
-<!-- Definitions -->
-
 [mit]: license
 [mdx]: https://github.com/mdx-js/mdx
 [author]: https://johno.com
diff --git a/packages/vue-loader/readme.md b/packages/vue-loader/readme.md
@@ -66,8 +66,6 @@ abide by its terms.
 
 [MIT][] © [Compositor][] and [Vercel][]
 
-<!-- Definitions -->
-
 [build]: https://travis-ci.com/mdx-js/mdx
 [build-badge]: https://travis-ci.com/mdx-js/mdx.svg?branch=master
 [lerna]: https://lernajs.io/

diff --git a/packages/vue/readme.md b/packages/vue/readme.md
@@ -72,7 +72,6 @@ abide by its terms.
 
 [MIT][] © [Compositor][] and [Vercel][]
 
-<!-- Definitions -->
 [build]: https://travis-ci.com/mdx-js/mdx
 [build-badge]: https://travis-ci.com/mdx-js/mdx.svg?branch=master
 [lerna]: https://lernajs.io/

diff --git a/readme.md b/readme.md
@@ -93,33 +93,31 @@ A nice example of this is [mdx-deck][], a great way to create slides with MDX.
 
 ## Sponsors
 
-<!--lint ignore no-html maximum-line-length-->
-
 <table>
   <tr valign="top">
     <td width="20%" align="center">
-      <a href="https://vercel.com"><img src="https://avatars1.githubusercontent.com/u/14985020?s=400&v=4"></a>
-      <br><br>🥇
+      <a href="https://vercel.com"><img src="https://avatars1.githubusercontent.com/u/14985020?s=400&v=4" /></a>
+      <br /><br />🥇
       <a href="https://vercel.com">Vercel</a>
     </td>
     <td width="20%" align="center">
-      <a href="https://www.gatsbyjs.org"><img src="https://avatars1.githubusercontent.com/u/12551863?s=400&v=4"></a>
-      <br><br>🥇
+      <a href="https://www.gatsbyjs.org"><img src="https://avatars1.githubusercontent.com/u/12551863?s=400&v=4" /></a>
+      <br /><br />🥇
       <a href="https://www.gatsbyjs.org">Gatsby</a>
     </td>
     <td width="20%" align="center">
-      <a href="https://www.netlify.com"><img src="https://avatars1.githubusercontent.com/u/7892489?s=400&v=4"></a>
-      <br><br>🥇
+      <a href="https://www.netlify.com"><img src="https://avatars1.githubusercontent.com/u/7892489?s=400&v=4" /></a>
+      <br /><br />🥇
       <a href="https://www.netlify.com">Netlify</a>
     </td>
     <td width="20%" align="center">
-      <a href="https://www.holloway.com"><img src="https://avatars1.githubusercontent.com/u/35904294?s=400&v=4"></a>
-      <br><br>
+      <a href="https://www.holloway.com"><img src="https://avatars1.githubusercontent.com/u/35904294?s=400&v=4" /></a>
+      <br /><br />
       <a href="https://www.holloway.com">Holloway</a>
     </td>
     <td width="20%" align="center">
-      <br><br><br><br>
-      <a href="https://opencollective.com/unified"><strong>You?</strong>
+      <br /><br /><br /><br />
+      <a href="https://opencollective.com/unified"><strong>You?</strong></a>
     </td>
   </tr>
 </table>