Rename remark related imports.

jaydenseric · Aug 7, 2021 · b899acd · b899acd
1 parent 42b62f1
commit b899acd
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 25 deletions.
diff --git a/changelog.md b/changelog.md
@@ -5,6 +5,7 @@
 ### Patch
 
 - Updated dependencies.
+- Renamed remark related imports.
 
 ## 11.0.1
 

diff --git a/private/jsdocDataMdToMdAst.mjs b/private/jsdocDataMdToMdAst.mjs
@@ -1,5 +1,5 @@
-import gfm from 'remark-gfm';
-import parse from 'remark-parse';
+import remarkGfm from 'remark-gfm';
+import remarkParse from 'remark-parse';
 import { unified } from 'unified';
 import { removePosition } from 'unist-util-remove-position';
 import CodeLocation from './CodeLocation.mjs';
@@ -129,7 +129,7 @@ export default function jsdocDataMdToMdAst(jsdocData, members, codeFiles) {
   // technically more efficient and harmless to the public API, it bloats
   // private test snapshots.
   return removePosition(
-    unified().use(parse).use(gfm).parse(unescapeJsdoc(replacedMd)),
+    unified().use(remarkParse).use(remarkGfm).parse(unescapeJsdoc(replacedMd)),
 
     // Delete the `position` properties from nodes instead of only replacing
     // their values with `undefined`.

diff --git a/private/membersToMdAst.mjs b/private/membersToMdAst.mjs
@@ -1,6 +1,6 @@
 import remarkBehead from 'remark-behead';
-import gfm from 'remark-gfm';
-import toc from 'remark-toc';
+import remarkGfm from 'remark-gfm';
+import remarkToc from 'remark-toc';
 import { unified } from 'unified';
 import InvalidJsdocError from './InvalidJsdocError.mjs';
 import deconstructJsdocNamepath from './deconstructJsdocNamepath.mjs';
@@ -479,8 +479,8 @@ export default function membersToMdAst(members, codeFiles, topDepth = 1) {
     });
 
     const mdAstWithToC = unified()
-      .use(gfm)
-      .use(toc, {
+      .use(remarkGfm)
+      .use(remarkToc, {
         // Prettier formatting.
         tight: true,
         skip: 'Fires|See|Examples',

diff --git a/private/replaceMdSection.mjs b/private/replaceMdSection.mjs
@@ -1,6 +1,6 @@
-import gfm from 'remark-gfm';
-import parse from 'remark-parse';
-import stringify from 'remark-stringify';
+import remarkGfm from 'remark-gfm';
+import remarkParse from 'remark-parse';
+import remarkStringify from 'remark-stringify';
 import { unified } from 'unified';
 import REMARK_STRINGIFY_OPTIONS from './REMARK_STRINGIFY_OPTIONS.mjs';
 import remarkPluginReplaceSection from './remarkPluginReplaceSection.mjs';
@@ -38,9 +38,9 @@ export default function replaceMdSection(
     throw new TypeError('Argument 3 `replacementMdAst` must be an object.');
 
   return unified()
-    .use(parse)
-    .use(gfm)
-    .use(stringify, REMARK_STRINGIFY_OPTIONS)
+    .use(remarkParse)
+    .use(remarkGfm)
+    .use(remarkStringify, REMARK_STRINGIFY_OPTIONS)
     .use(remarkPluginReplaceSection, {
       targetHeading,
       replacementAst: replacementMdAst,

diff --git a/test/membersToMdAstSnapshot.mjs b/test/membersToMdAstSnapshot.mjs
@@ -1,5 +1,5 @@
-import gfm from 'remark-gfm';
-import stringify from 'remark-stringify';
+import remarkGfm from 'remark-gfm';
+import remarkStringify from 'remark-stringify';
 import snapshot from 'snapshot-assertion';
 import { unified } from 'unified';
 import REMARK_STRINGIFY_OPTIONS from '../private/REMARK_STRINGIFY_OPTIONS.mjs';
@@ -55,8 +55,8 @@ export default async function membersToMdAstSnapshot(
   );
 
   const md = unified()
-    .use(gfm)
-    .use(stringify, REMARK_STRINGIFY_OPTIONS)
+    .use(remarkGfm)
+    .use(remarkStringify, REMARK_STRINGIFY_OPTIONS)
     .stringify(mdAst);
 
   await snapshot(

diff --git a/test/private/remarkPluginReplaceSection.test.mjs b/test/private/remarkPluginReplaceSection.test.mjs
@@ -1,5 +1,5 @@
 import { deepStrictEqual, throws } from 'assert';
-import gfm from 'remark-gfm';
+import remarkGfm from 'remark-gfm';
 import { unified } from 'unified';
 import remarkPluginReplaceSection from '../../private/remarkPluginReplaceSection.mjs';
 
@@ -25,7 +25,7 @@ export default (tests) => {
   tests.add('`remarkPluginReplaceSection` with defaults.', () => {
     deepStrictEqual(
       unified()
-        .use(gfm)
+        .use(remarkGfm)
         .use(remarkPluginReplaceSection)
         .runSync({
           type: 'root',
@@ -72,7 +72,7 @@ export default (tests) => {
   tests.add('`remarkPluginReplaceSection` with options.', () => {
     deepStrictEqual(
       unified()
-        .use(gfm)
+        .use(remarkGfm)
         .use(remarkPluginReplaceSection, {
           targetHeading: 'A',
           replacementAst: {
@@ -163,7 +163,7 @@ export default (tests) => {
 
   tests.add('`remarkPluginReplaceSection` with a missing heading.', () => {
     throws(() => {
-      unified().use(gfm).use(remarkPluginReplaceSection).runSync({
+      unified().use(remarkGfm).use(remarkPluginReplaceSection).runSync({
         type: 'root',
         children: [],
       });

diff --git a/test/private/typeAstToMdAst.test.mjs b/test/private/typeAstToMdAst.test.mjs
@@ -1,6 +1,6 @@
 import { throws } from 'assert';
-import gfm from 'remark-gfm';
-import stringify from 'remark-stringify';
+import remarkGfm from 'remark-gfm';
+import remarkStringify from 'remark-stringify';
 import snapshot from 'snapshot-assertion';
 import { unified } from 'unified';
 import REMARK_STRINGIFY_OPTIONS from '../../private/REMARK_STRINGIFY_OPTIONS.mjs';
@@ -97,8 +97,8 @@ export default (tests) => {
 
         await snapshot(
           unified()
-            .use(gfm)
-            .use(stringify, REMARK_STRINGIFY_OPTIONS)
+            .use(remarkGfm)
+            .use(remarkStringify, REMARK_STRINGIFY_OPTIONS)
             .stringify({
               type: 'root',
               children: [