From c99e70858fb3677670ec9138cf63ada1c83c82f3 Mon Sep 17 00:00:00 2001 From: Daniel Tschinder <231804+danez@users.noreply.github.com> Date: Sun, 4 Dec 2022 20:47:38 +0100 Subject: [PATCH 1/2] fix: rename exports and fix exports of importers BREAKING_CHANGE: `handlers`, `resolver`, and `importers` was renamed to `builtinHandlers`, `builtinResolvers`, and `builtinImporters`. --- packages/react-docgen/package.json | 4 ++-- .../{ignoreImports.ts => ignoreImporter.ts} | 0 packages/react-docgen/src/importer/index.ts | 4 ++-- packages/react-docgen/src/main.ts | 24 +++++++++++++------ 4 files changed, 21 insertions(+), 11 deletions(-) rename packages/react-docgen/src/importer/{ignoreImports.ts => ignoreImporter.ts} (100%) diff --git a/packages/react-docgen/package.json b/packages/react-docgen/package.json index 166bd68ec70..b8dfcae86d6 100644 --- a/packages/react-docgen/package.json +++ b/packages/react-docgen/package.json @@ -5,8 +5,8 @@ "repository": "reactjs/react-docgen", "type": "module", "browser": { - "./dist/importer/fsImporter.js": "./dist/importer/ignoreImports.js", - "./src/importer/fsImporter.ts": "./src/importer/ignoreImports.ts" + "./dist/importer/fsImporter.js": "./dist/importer/ignoreImporter.js", + "./src/importer/fsImporter.ts": "./src/importer/ignoreImporter.ts" }, "files": [ "dist" diff --git a/packages/react-docgen/src/importer/ignoreImports.ts b/packages/react-docgen/src/importer/ignoreImporter.ts similarity index 100% rename from packages/react-docgen/src/importer/ignoreImports.ts rename to packages/react-docgen/src/importer/ignoreImporter.ts diff --git a/packages/react-docgen/src/importer/index.ts b/packages/react-docgen/src/importer/index.ts index 4d57a815d64..8bcf4e30bdf 100644 --- a/packages/react-docgen/src/importer/index.ts +++ b/packages/react-docgen/src/importer/index.ts @@ -5,7 +5,7 @@ import type { ImportDeclaration, } from '@babel/types'; import type FileState from '../FileState.js'; -import ignoreImports from './ignoreImports.js'; +import ignoreImporter from './ignoreImporter.js'; import fsImporter from './fsImporter.js'; import makeFsImporter from './makeFsImporter.js'; @@ -19,4 +19,4 @@ export type Importer = ( file: FileState, ) => NodePath | null; -export { fsImporter, ignoreImports, makeFsImporter }; +export { fsImporter, ignoreImporter, makeFsImporter }; diff --git a/packages/react-docgen/src/main.ts b/packages/react-docgen/src/main.ts index 6bf00e6fb94..eca16dfbeae 100644 --- a/packages/react-docgen/src/main.ts +++ b/packages/react-docgen/src/main.ts @@ -1,7 +1,11 @@ -import * as allHandlers from './handlers/index.js'; +import * as builtinHandlers from './handlers/index.js'; import parse from './parse.js'; -import * as allResolvers from './resolver/index.js'; -import * as allImporters from './importer/index.js'; +import * as builtinResolvers from './resolver/index.js'; +import { + fsImporter, + ignoreImporter, + makeFsImporter, +} from './importer/index.js'; import * as utils from './utils/index.js'; import type { DocumentationObject as Documentation } from './Documentation.js'; import type { Resolver } from './resolver/index.js'; @@ -11,6 +15,11 @@ import type FileState from './FileState.js'; import type { Config } from './config.js'; import { createConfig, defaultHandlers } from './config.js'; +const builtinImporters = { + fsImporter, + ignoreImporter, +}; + declare module '@babel/traverse' { export interface HubInterface { file: FileState; @@ -47,11 +56,12 @@ function defaultParse( } export { - defaultParse as parse, + builtinHandlers, + builtinResolvers, + builtinImporters, defaultHandlers, - allHandlers as handlers, - allResolvers as resolver, - allImporters as importers, + makeFsImporter, + defaultParse as parse, utils, }; From 3dfe1f6c562e9c2d2b1e796a4ae2e976efc82893 Mon Sep 17 00:00:00 2001 From: Daniel Tschinder <231804+danez@users.noreply.github.com> Date: Sun, 4 Dec 2022 20:58:31 +0100 Subject: [PATCH 2/2] chore: fix tests --- packages/react-docgen/src/__tests__/main-test.ts | 4 ++-- packages/react-docgen/tests/integration/integration-test.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/react-docgen/src/__tests__/main-test.ts b/packages/react-docgen/src/__tests__/main-test.ts index 7a55b1b425a..8078e1b36e5 100644 --- a/packages/react-docgen/src/__tests__/main-test.ts +++ b/packages/react-docgen/src/__tests__/main-test.ts @@ -1,4 +1,4 @@ -import { handlers, parse } from '../main.js'; +import { builtinHandlers, parse } from '../main.js'; import { ERROR_MISSING_DEFINITION } from '../parse.js'; import { describe, expect, test } from 'vitest'; @@ -13,7 +13,7 @@ describe('main', () => { test('parses with custom handlers', () => { const docs = parse(source, { - handlers: [handlers.componentDocblockHandler], + handlers: [builtinHandlers.componentDocblockHandler], }); expect(docs).toMatchSnapshot(); diff --git a/packages/react-docgen/tests/integration/integration-test.ts b/packages/react-docgen/tests/integration/integration-test.ts index 125e3faa494..6e4c10171a1 100644 --- a/packages/react-docgen/tests/integration/integration-test.ts +++ b/packages/react-docgen/tests/integration/integration-test.ts @@ -1,7 +1,7 @@ import fs from 'fs'; import { dirname, join } from 'path'; import { describe, expect, test } from 'vitest'; -import { parse, importers } from '../../src/main'; +import { parse, makeFsImporter } from '../../src/main'; import { fileURLToPath } from 'url'; describe('integration', () => { @@ -26,7 +26,7 @@ describe('integration', () => { expect(() => { result = parse(fileContent, { - importer: importers.makeFsImporter(), + importer: makeFsImporter(), babelOptions: { filename: filePath, babelrc: false,