Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from
Sep 11, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down Expand Up @@ -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
*/
Expand Down Expand Up @@ -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.
*
Expand All @@ -180,7 +180,7 @@ interface TSConfckParseNativeOptions extends TSConfckParseOptions {
#### TSConfckParseNativeResult

```ts
interface TSConfckParseNativeResult {
export interface TSConfckParseNativeResult {
/**
* absolute path to parsed tsconfig.json
*/
Expand Down Expand Up @@ -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
*
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand Down
3 changes: 3 additions & 0 deletions packages/tsconfck/src/public.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,3 +120,6 @@ export interface TSConfckParseNativeResult {
*/
result: any;
}

// eslint-disable-next-line n/no-missing-import
export * from './index.js';
Loading