chore: proper update of dts-buddy that avoids hiding types (#193)

dominikg · Sep 11, 2024 · 3737491 · 3737491
1 parent 20c9e70
commit 3737491
Show file tree

Hide file tree

Showing 6 changed files with 173 additions and 168 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -17,7 +17,7 @@ export function find(filename: string, options?: TSConfckFindOptions | undefined
 #### TSConfckFindOptions
 
 ```ts
-interface TSConfckFindOptions {
+export interface TSConfckFindOptions {
 	/**
 	 * A cache to improve performance for multiple calls in the same project
 	 *
@@ -67,15 +67,15 @@ export function parse(filename: string, options?: TSConfckParseOptions | undefin
 #### TSConfckParseOptions
 
 ```ts
-interface TSConfckParseOptions extends TSConfckFindOptions {
+export interface TSConfckParseOptions extends TSConfckFindOptions {
 	// same as find options
 }
 ```
 
 #### TSConfckParseResult
 
 ```ts
-interface TSConfckParseResult {
+export interface TSConfckParseResult {
 	/**
 	 * absolute path to parsed tsconfig.json
 	 */
@@ -164,7 +164,7 @@ export function parseNative(filename: string, options?: TSConfckParseNativeOptio
 #### TSConfckParseNativeOptions
 
 ```ts
-interface TSConfckParseNativeOptions extends TSConfckParseOptions {
+export interface TSConfckParseNativeOptions extends TSConfckParseOptions {
 	/**
 	 * Set this option to true to force typescript to ignore all source files.
 	 *
@@ -180,7 +180,7 @@ interface TSConfckParseNativeOptions extends TSConfckParseOptions {
 #### TSConfckParseNativeResult
 
 ```ts
-interface TSConfckParseNativeResult {
+export interface TSConfckParseNativeResult {
 	/**
 	 * absolute path to parsed tsconfig.json
 	 */
@@ -254,7 +254,7 @@ export function findAll(dir: string, options?: TSConfckFindAllOptions | undefine
 #### TSConfckFindAllOptions
 
 ```ts
-interface TSConfckFindAllOptions {
+export interface TSConfckFindAllOptions {
 	/**
 	 * helper to skip subdirectories when scanning for tsconfig.json
 	 *

diff --git a/package.json b/package.json
@@ -13,7 +13,7 @@
 		"format": "pnpm check:format --write",
 		"fixup": "run-s generate lint format",
 		"generate": "run-s generate:types generate:docs",
-		"generate:types": "pnpm --dir packages/tsconfck run dts-buddy",
+		"generate:types": "pnpm --dir packages/tsconfck run dts-buddy -m tsconfck:src/public.d.ts",
 		"generate:docs": "node scripts/generate-api-docs.js",
 		"release": "pnpm changeset publish",
 		"prepare": "husky",
@@ -23,7 +23,7 @@
 		"@changesets/cli": "^2.27.7",
 		"@eslint/js": "^9.9.0",
 		"@svitejs/changesets-changelog-github-compact": "^1.1.0",
-		"dts-buddy": "^0.4.7",
+		"dts-buddy": "^0.5.3",
 		"esbuild": "^0.23.1",
 		"eslint": "^9.9.0",
 		"eslint-config-prettier": "^9.1.0",

diff --git a/packages/tsconfck/src/public.d.ts b/packages/tsconfck/src/public.d.ts
@@ -120,3 +120,6 @@ export interface TSConfckParseNativeResult {
 	 */
 	result: any;
 }
+
+// eslint-disable-next-line n/no-missing-import
+export * from './index.js';