fix: rename exports and fix exports of importers (#690)

BREAKING_CHANGE: `handlers`, `resolver`, and `importers` was renamed to `builtinHandlers`, `builtinResolvers`, and `builtinImporters`.

Author: danez

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"

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();

packages/react-docgen/src/importer/ignoreImports.ts renamed to packages/react-docgen/src/importer/ignoreImporter.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 };

packages/react-docgen/src/importer/index.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,
 };
 

packages/react-docgen/src/main.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,