Refactor to reorganize lib

syntax-tree · Jul 12, 2023 · de6c1e6 · de6c1e6
1 parent 94c2074
commit de6c1e6
Show file tree

Hide file tree

Showing 7 changed files with 82 additions and 65 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@ node_modules/
 *.d.ts
 .DS_Store
 yarn.lock
+!/index.d.ts
diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,15 @@
+export type {
+  MdxFlowExpression,
+  MdxTextExpression
+} from 'mdast-util-mdx-expression'
+export type {
+  MdxJsxAttribute,
+  MdxJsxAttributeValueExpression,
+  MdxJsxExpressionAttribute,
+  MdxJsxFlowElement,
+  MdxJsxTextElement,
+  ToMarkdownOptions
+} from 'mdast-util-mdx-jsx'
+export type {MdxjsEsm} from 'mdast-util-mdxjs-esm'
+
+export {mdxFromMarkdown, mdxToMarkdown} from './lib/index.js'
diff --git a/index.js b/index.js
@@ -1,60 +1,2 @@
-/**
- * @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
- * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
- *
- * @typedef {import('mdast-util-mdx-expression').MdxFlowExpression} MdxFlowExpression
- * @typedef {import('mdast-util-mdx-expression').MdxTextExpression} MdxTextExpression
- * @typedef {import('mdast-util-mdx-jsx').MdxJsxAttributeValueExpression} MdxJsxAttributeValueExpression
- * @typedef {import('mdast-util-mdx-jsx').MdxJsxAttribute} MdxJsxAttribute
- * @typedef {import('mdast-util-mdx-jsx').MdxJsxExpressionAttribute} MdxJsxExpressionAttribute
- * @typedef {import('mdast-util-mdx-jsx').MdxJsxFlowElement} MdxJsxFlowElement
- * @typedef {import('mdast-util-mdx-jsx').MdxJsxTextElement} MdxJsxTextElement
- * @typedef {import('mdast-util-mdx-jsx').ToMarkdownOptions} ToMarkdownOptions
- * @typedef {import('mdast-util-mdxjs-esm').MdxjsEsm} MdxjsEsm
- */
-
-import {
-  mdxExpressionFromMarkdown,
-  mdxExpressionToMarkdown
-} from 'mdast-util-mdx-expression'
-import {mdxJsxFromMarkdown, mdxJsxToMarkdown} from 'mdast-util-mdx-jsx'
-import {mdxjsEsmFromMarkdown, mdxjsEsmToMarkdown} from 'mdast-util-mdxjs-esm'
-
-/**
- * Create an extension for `mdast-util-from-markdown` to enable MDX (ESM, JSX,
- * expressions).
- *
- * @returns {Array<FromMarkdownExtension>}
- *   Extension for `mdast-util-from-markdown` to enable MDX (ESM, JSX,
- *   expressions).
- *
- *   When using the syntax extensions with `addResult`, ESM and expression
- *   nodes will have `data.estree` fields set to ESTree `Program` node.
- */
-export function mdxFromMarkdown() {
-  return [
-    mdxExpressionFromMarkdown(),
-    mdxJsxFromMarkdown(),
-    mdxjsEsmFromMarkdown()
-  ]
-}
-
-/**
- * Create an extension for `mdast-util-to-markdown` to enable MDX (ESM, JSX,
- * expressions).
- *
- * @param {ToMarkdownOptions | null | undefined} [options]
- *   Configuration (optional).
- * @returns {ToMarkdownExtension}
- *   Extension for `mdast-util-to-markdown` to enable MDX (ESM, JSX,
- *   expressions).
- */
-export function mdxToMarkdown(options) {
-  return {
-    extensions: [
-      mdxExpressionToMarkdown(),
-      mdxJsxToMarkdown(options),
-      mdxjsEsmToMarkdown()
-    ]
-  }
-}
+// Note: types exposed from `index.d.ts`.
+export {mdxFromMarkdown, mdxToMarkdown} from './lib/index.js'
diff --git a/lib/index.js b/lib/index.js
@@ -0,0 +1,51 @@
+/**
+ * @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
+ * @typedef {import('mdast-util-mdx-jsx').ToMarkdownOptions} ToMarkdownOptions
+ * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
+ */
+
+import {
+  mdxExpressionFromMarkdown,
+  mdxExpressionToMarkdown
+} from 'mdast-util-mdx-expression'
+import {mdxJsxFromMarkdown, mdxJsxToMarkdown} from 'mdast-util-mdx-jsx'
+import {mdxjsEsmFromMarkdown, mdxjsEsmToMarkdown} from 'mdast-util-mdxjs-esm'
+
+/**
+ * Create an extension for `mdast-util-from-markdown` to enable MDX (ESM, JSX,
+ * expressions).
+ *
+ * @returns {Array<FromMarkdownExtension>}
+ *   Extension for `mdast-util-from-markdown` to enable MDX (ESM, JSX,
+ *   expressions).
+ *
+ *   When using the syntax extensions with `addResult`, ESM and expression
+ *   nodes will have `data.estree` fields set to ESTree `Program` node.
+ */
+export function mdxFromMarkdown() {
+  return [
+    mdxExpressionFromMarkdown(),
+    mdxJsxFromMarkdown(),
+    mdxjsEsmFromMarkdown()
+  ]
+}
+
+/**
+ * Create an extension for `mdast-util-to-markdown` to enable MDX (ESM, JSX,
+ * expressions).
+ *
+ * @param {ToMarkdownOptions | null | undefined} [options]
+ *   Configuration (optional).
+ * @returns {ToMarkdownExtension}
+ *   Extension for `mdast-util-to-markdown` to enable MDX (ESM, JSX,
+ *   expressions).
+ */
+export function mdxToMarkdown(options) {
+  return {
+    extensions: [
+      mdxExpressionToMarkdown(),
+      mdxJsxToMarkdown(options),
+      mdxjsEsmToMarkdown()
+    ]
+  }
+}
diff --git a/package.json b/package.json
@@ -32,6 +32,7 @@
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
+    "lib/",
     "index.d.ts",
     "index.js"
   ],

diff --git a/readme.md b/readme.md
@@ -350,10 +350,17 @@ See their readmes for the node types supported in the tree:
 ## Types
 
 This package is fully typed with [TypeScript][].
-It exports the additional types `MdxFlowExpression`, `MdxTextExpression`,
-`MdxjsEsm`, `MdxJsxAttributeValueExpression`, `MdxJsxAttribute`,
-`MdxJsxExpressionAttribute`, `MdxJsxFlowElement`,
-`MdxJsxTextElement`, and [`ToMarkdownOptions`][api-to-markdown-options].
+It exports the additional types
+`MdxFlowExpression` and `MdxTextExpression`
+from `mdast-util-mdx-expression`;
+`MdxJsxAttribute`,
+`MdxJsxAttributeValueExpression`,
+`MdxJsxExpressionAttribute`,
+`MdxJsxFlowElement`,
+`MdxJsxTextElement`,
+and [`ToMarkdownOptions`][api-to-markdown-options]
+from `mdast-util-mdx-jsx`;
+and `MdxjsEsm` from `mdast-util-mdxjs-esm`.
 
 It also registers the node types with `@types/mdast` and `@types/hast`.
 If you’re working with the syntax tree, make sure to import this utility

diff --git a/tsconfig.json b/tsconfig.json
@@ -11,5 +11,5 @@
     "target": "es2020"
   },
   "exclude": ["coverage/", "node_modules/"],
-  "include": ["**/*.js"]
+  "include": ["**/*.js", "index.d.ts"]
 }