From f9e6fa326ea17c1b20f03ef1ba2eb2d7a1b0fbf9 Mon Sep 17 00:00:00 2001 From: lonyele Date: Mon, 3 Aug 2020 16:20:24 +0900 Subject: [PATCH 1/4] feat(mdx): add typings according to the code --- packages/mdx/types/index.d.ts | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/packages/mdx/types/index.d.ts b/packages/mdx/types/index.d.ts index a64c90e0b..70fe2441b 100644 --- a/packages/mdx/types/index.d.ts +++ b/packages/mdx/types/index.d.ts @@ -11,6 +11,19 @@ declare namespace mdx { */ footnotes?: boolean + /** + * skip the addition of 'export default' statement when serialize + * to JSX + * @default false + */ + skipExport?: boolean + + /** + * wrap 'export default' statement with provided string when serialize + * to JSX + */ + wrapExport?: string + /** * remark plugins to transform markdown content * From 59274d431b615562272da49daf70461599c78ccf Mon Sep 17 00:00:00 2001 From: lonyele Date: Mon, 3 Aug 2020 16:14:10 +0900 Subject: [PATCH 2/4] test(mdx): add tests that covers new typings --- packages/mdx/types/mdx-test.ts | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/packages/mdx/types/mdx-test.ts b/packages/mdx/types/mdx-test.ts index ea4226eb8..92d118398 100644 --- a/packages/mdx/types/mdx-test.ts +++ b/packages/mdx/types/mdx-test.ts @@ -3,6 +3,8 @@ import * as mdx from '@mdx-js/mdx' mdx('# title') // $ExpectType Promise mdx('# title', {}) // $ExpectType Promise mdx('# title', {footnotes: false}) // $ExpectType Promise +mdx('# title', {skipExport: false}) // $ExpectType Promise +mdx('# title', {wrapExport: 'React.memo'}) // $ExpectType Promise mdx('# title', {rehypePlugins: [() => () => ({type: 'test'})]}) // $ExpectType Promise mdx('# title', {remarkPlugins: [() => () => ({type: 'test'})]}) // $ExpectType Promise mdx('# title', {compilers: []}) // $ExpectType Promise @@ -10,13 +12,16 @@ mdx('# title', {compilers: []}) // $ExpectType Promise mdx.sync('# title') // $ExpectType string mdx.sync('# title', {}) // $ExpectType string mdx.sync('# title', {footnotes: false}) // $ExpectType string +mdx.sync('# title', {skipExport: false}) // $ExpectType string +mdx.sync('# title', {wrapExport: 'React.memo'}) // $ExpectType string mdx.sync('# title', {rehypePlugins: [() => () => ({type: 'test'})]}) // $ExpectType string mdx.sync('# title', {remarkPlugins: [() => () => ({type: 'test'})]}) // $ExpectType string mdx.sync('# title', {compilers: []}) // $ExpectType string mdx.createMdxAstCompiler() // $ExpectType Processor -mdx.createMdxAstCompiler({}) // $ExpectType Processor mdx.createMdxAstCompiler({footnotes: false}) // $ExpectType Processor +mdx.createMdxAstCompiler({skipExport: false}) // $ExpectType Processor +mdx.createMdxAstCompiler({wrapExport: 'React.memo'}) // $ExpectType Processor mdx.createMdxAstCompiler({rehypePlugins: [() => () => ({type: 'test'})]}) // $ExpectType Processor mdx.createMdxAstCompiler({remarkPlugins: [() => () => ({type: 'test'})]}) // $ExpectType Processor mdx.createMdxAstCompiler({compilers: []}) // $ExpectType Processor From 184cdf0c232d690720252d0d7c3c5531d575ab7a Mon Sep 17 00:00:00 2001 From: John Otander Date: Mon, 3 Aug 2020 07:56:47 -0600 Subject: [PATCH 3/4] Update packages/mdx/types/index.d.ts --- packages/mdx/types/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/mdx/types/index.d.ts b/packages/mdx/types/index.d.ts index 70fe2441b..c16071800 100644 --- a/packages/mdx/types/index.d.ts +++ b/packages/mdx/types/index.d.ts @@ -12,7 +12,7 @@ declare namespace mdx { footnotes?: boolean /** - * skip the addition of 'export default' statement when serialize + * skip the addition of 'export default' statement when serializing * to JSX * @default false */ From 0703f81a63fee5cb0ce817664769212513d7fb7a Mon Sep 17 00:00:00 2001 From: John Otander Date: Mon, 3 Aug 2020 07:56:53 -0600 Subject: [PATCH 4/4] Update packages/mdx/types/index.d.ts --- packages/mdx/types/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/mdx/types/index.d.ts b/packages/mdx/types/index.d.ts index c16071800..524c63808 100644 --- a/packages/mdx/types/index.d.ts +++ b/packages/mdx/types/index.d.ts @@ -19,7 +19,7 @@ declare namespace mdx { skipExport?: boolean /** - * wrap 'export default' statement with provided string when serialize + * wrap 'export default' statement with provided string when serializing * to JSX */ wrapExport?: string