fix: quote component name in error message (#1136)

* quote component name in error message * revert unnecessary changes in readme
mdx-js · Jul 15, 2020 · 6cac979 · 6cac979 · vercel · Jul 15, 2020
1 parent 075a3c4
commit 6cac979
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/docs/advanced/components.mdx b/docs/advanced/components.mdx
@@ -68,9 +68,9 @@ stubbed `Button`:
 const makeShortcode = name =>
   function MDXDefaultShortcode(props) {
     console.warn(
-      'Component ' +
+      "Component '" +
         name +
-        ' was not imported, exported, or provided by MDXProvider as global scope'
+        "' was not imported, exported, or provided by MDXProvider as global scope"
     )
     return <div {...props} />
   }

diff --git a/packages/mdx/mdx-hast-to-jsx.js b/packages/mdx/mdx-hast-to-jsx.js
@@ -163,7 +163,7 @@ MDXContent.isMDXComponent = true`
     const importExportNames = importNames.concat(exportNames)
     const fakedModulesForGlobalScope =
       `const makeShortcode = name => function MDXDefaultShortcode(props) {
-  console.warn("Component " + name + " was not imported, exported, or provided by MDXProvider as global scope")
+  console.warn("Component '" + name + "' was not imported, exported, or provided by MDXProvider as global scope")
   return <div {...props}/>
 };
 ` +

diff --git a/packages/mdx/test/index.test.js b/packages/mdx/test/index.test.js
@@ -47,9 +47,9 @@ it('Should match sample blog post snapshot', async () => {
     const makeShortcode = (name) =>
       function MDXDefaultShortcode(props) {
         console.warn(
-          \\"Component \\" +
+          \\"Component '\\" +
             name +
-            \\" was not imported, exported, or provided by MDXProvider as global scope\\"
+            \\"' was not imported, exported, or provided by MDXProvider as global scope\\"
         );
         return <div {...props} />;
       };
@@ -333,7 +333,7 @@ test('Should handle layout props', () => {
       authors: ['fred', 'sally']
     };
     const makeShortcode = name => function MDXDefaultShortcode(props) {
-      console.warn(\\"Component \\" + name + \\" was not imported, exported, or provided by MDXProvider as global scope\\")
+      console.warn(\\"Component '\\" + name + \\"' was not imported, exported, or provided by MDXProvider as global scope\\")
       return <div {...props}/>
     };
     const Foo = makeShortcode(\\"Foo\\");

diff --git a/packages/remark-mdx/test/__snapshots__/test.js.snap b/packages/remark-mdx/test/__snapshots__/test.js.snap
@@ -5,7 +5,7 @@ exports[`correctly transpiles 1`] = `
 
 export { Baz } from './foo';
 const makeShortcode = name => function MDXDefaultShortcode(props) {
-  console.warn(\\"Component \\" + name + \\" was not imported, exported, or provided by MDXProvider as global scope\\")
+  console.warn(\\"Component '\\" + name + \\"' was not imported, exported, or provided by MDXProvider as global scope\\")
   return <div {...props}/>
 };
 const Baz = makeShortcode(\\"Baz\\");