refactor: consolidate types into own module

Author: velut

src/all-extracted-declaration.test.ts

@@ -17,49 +17,12 @@ import { isHidden } from "./is-hidden";
 import { modifiersText } from "./modifiers-text";
 import { sourceFilePath } from "./source-file-path";
 import { typeCheckerType } from "./type-checker-type";
-
-export type ExtractedClass = {
-	kind: "class";
-	id: string;
-	name: string;
-	docs: string[];
-	file: string;
-	line: number;
-	signature: string;
-	constructors: ExtractedClassConstructor[];
-	properties: ExtractedClassProperty[];
-	methods: ExtractedClassMethod[];
-};
-
-export type ExtractedClassConstructor = {
-	kind: "class-constructor";
-	id: string;
-	name: string;
-	docs: string[];
-	file: string;
-	line: number;
-	signature: string;
-};
-
-export type ExtractedClassProperty = {
-	kind: "class-property";
-	id: string;
-	name: string;
-	docs: string[];
-	file: string;
-	line: number;
-	signature: string;
-};
-
-export type ExtractedClassMethod = {
-	kind: "class-method";
-	id: string;
-	name: string;
-	docs: string[];
-	file: string;
-	line: number;
-	signature: string;
-};
+import type {
+	ExtractedClass,
+	ExtractedClassConstructor,
+	ExtractedClassMethod,
+	ExtractedClassProperty,
+} from "./types";
 
 export const extractClass = async (
 	containerName: string,

src/all-extracted-declaration.ts

@@ -1,24 +1,18 @@
 import { orderBy } from "natural-orderby";
-import {
-	Node,
-	type ExportedDeclarations,
-	type ModuleDeclaration,
-	type Project,
-	type SourceFile,
-} from "ts-morph";
+import { Node, type ExportedDeclarations } from "ts-morph";
 import { ambientModulesDeclarations } from "./ambient-modules-declarations";
 import { exportEqualsDeclarations } from "./export-equals-declarations";
 import { exportedDeclarations } from "./exported-declarations";
-import { extractClass, type ExtractedClass } from "./extract-class";
-import { extractEnum, type ExtractedEnum } from "./extract-enum";
+import { extractClass } from "./extract-class";
+import { extractEnum } from "./extract-enum";
 import { extractExpression } from "./extract-expression";
 import { extractFileModule } from "./extract-file-module";
-import { extractFunction, type ExtractedFunction } from "./extract-function";
+import { extractFunction } from "./extract-function";
 import { extractFunctionExpression } from "./extract-function-expression";
-import { extractInterface, type ExtractedInterface } from "./extract-interface";
-import { extractNamespace, type ExtractedNamespace } from "./extract-namespace";
-import { extractTypeAlias, type ExtractedTypeAlias } from "./extract-type-alias";
-import { extractVariable, type ExtractedVariable } from "./extract-variable";
+import { extractInterface } from "./extract-interface";
+import { extractNamespace } from "./extract-namespace";
+import { extractTypeAlias } from "./extract-type-alias";
+import { extractVariable } from "./extract-variable";
 import { extractVariableAssignmentExpression } from "./extract-variable-assignment-expression";
 import { globalAmbientDeclarations } from "./global-ambient-declarations";
 import { id } from "./id";
@@ -33,55 +27,7 @@ import { isNamespace } from "./is-namespace";
 import { isTypeAlias } from "./is-type-alias";
 import { isVariable } from "./is-variable";
 import { isVariableAssignmentExpression } from "./is-variable-assignment-expression";
-
-/**
-`ExtractDeclarationsOptions` contains all the options
-for calling {@link extractDeclarations}.
-
-@internal
-*/
-export type ExtractDeclarationsOptions = {
-	/**
-  Name of the container that contains the top-level declarations
-  (e.g., a namespace's name). This is used to generate declaration IDs.
-  */
-	containerName: string;
-
-	/** Container that contains the top-level declarations. */
-	container: SourceFile | ModuleDeclaration;
-
-	/** Maximum extraction depth for nested namespaces. */
-	maxDepth: number;
-
-	/**
-  Instance of a  `ts-morph` `Project`. This is used to find ambient modules.
-  */
-	project?: Project;
-
-	/**
-  Name of the package being analyzed. This is used to filter ambient modules.
-  */
-	pkgName?: string;
-};
-
-/**
-`ExtractedDeclaration` is the union of all possible top-level declarations
-that can be extracted from a package, module or namespace.
-*/
-export type ExtractedDeclaration =
-	| ExtractedVariable
-	| ExtractedFunction
-	| ExtractedClass
-	| ExtractedInterface
-	| ExtractedEnum
-	| ExtractedTypeAlias
-	| ExtractedNamespace;
-
-/**
-`ExtractedDeclarationKind` is the union of all discriminators
-used to detect the kind of top-level declaration.
-*/
-export type ExtractedDeclarationKind = ExtractedDeclaration["kind"];
+import type { ExtractDeclarationsOptions, ExtractedDeclaration } from "./types";
 
 /**
 `extractDeclarations` extracts the top-level declarations found in a container

src/extract-class.ts

@@ -5,27 +5,7 @@ import { headText } from "./head-text";
 import { id } from "./id";
 import { isHidden } from "./is-hidden";
 import { sourceFilePath } from "./source-file-path";
-
-export type ExtractedEnum = {
-	kind: "enum";
-	id: string;
-	name: string;
-	docs: string[];
-	file: string;
-	line: number;
-	signature: string;
-	members: ExtractedEnumMember[];
-};
-
-export type ExtractedEnumMember = {
-	kind: "enum-member";
-	id: string;
-	name: string;
-	docs: string[];
-	file: string;
-	line: number;
-	signature: string;
-};
+import type { ExtractedEnum, ExtractedEnumMember } from "./types";
 
 export const extractEnum = async (
 	containerName: string,

src/extract-declarations.ts

@@ -1,10 +1,10 @@
 import type { Expression } from "ts-morph";
 import { apparentType } from "./apparent-type";
 import { docs } from "./docs";
-import type { ExtractedVariable } from "./extract-variable";
 import { formatSignature } from "./format-signature";
 import { id } from "./id";
 import { sourceFilePath } from "./source-file-path";
+import type { ExtractedVariable } from "./types";
 
 export const extractExpression = async (
 	containerName: string,

src/extract-enum.ts

@@ -1,9 +1,8 @@
 import { SourceFile, SyntaxKind } from "ts-morph";
-import type { ExtractedDeclaration } from "./extract-declarations";
-import type { ExtractedNamespace } from "./extract-namespace";
 import { formatSignature } from "./format-signature";
 import { id } from "./id";
 import { sourceFilePath } from "./source-file-path";
+import type { ExtractedDeclaration, ExtractedNamespace } from "./types";
 
 export const extractFileModule = async (
 	containerName: string,

src/extract-expression.ts

@@ -1,10 +1,10 @@
 import type { VariableDeclaration } from "ts-morph";
 import { docs } from "./docs";
-import type { ExtractedFunction } from "./extract-function";
 import { formatSignature } from "./format-signature";
 import { id } from "./id";
 import { sourceFilePath } from "./source-file-path";
 import { typeCheckerType } from "./type-checker-type";
+import type { ExtractedFunction } from "./types";
 
 export const extractFunctionExpression = async (
 	containerName: string,

src/extract-file-module.ts

@@ -4,16 +4,7 @@ import { formatSignature } from "./format-signature";
 import { id } from "./id";
 import { sourceFilePath } from "./source-file-path";
 import { typeCheckerType } from "./type-checker-type";
-
-export type ExtractedFunction = {
-	kind: "function";
-	id: string;
-	name: string;
-	docs: string[];
-	file: string;
-	line: number;
-	signature: string;
-};
+import type { ExtractedFunction } from "./types";
 
 export const extractFunction = async (
 	containerName: string,