@visulima/tsconfig 1.1.8 → 1.1.9

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## @visulima/tsconfig [1.1.9](https://github.com/visulima/visulima/compare/@visulima/tsconfig@1.1.8...@visulima/tsconfig@1.1.9) (2025-01-21)
+
+### Bug Fixes
+
+* **tsconfig:** added missing tscCompatible option on findTsConfig and findTsConfigSync ([9f56637](https://github.com/visulima/visulima/commit/9f56637b5158f6364fa3e1c215ec9e7f2022a161))
+* **tsconfig:** fixed tscCompatible default on jsdoc ([fa80961](https://github.com/visulima/visulima/commit/fa809618aec6ec5f8777beb384509ed6c6794d43))
+
 ## @visulima/tsconfig [1.1.8](https://github.com/visulima/visulima/compare/@visulima/tsconfig@1.1.7...@visulima/tsconfig@1.1.8) (2025-01-13)
 
 ### Bug Fixes

package/README.md

@@ -191,7 +191,7 @@ Instructs the TypeScript compiler how to watch files.
 function findTsConfig(cwd?, options?): Promise<TsConfigResult>
 ```
 
-Defined in: [packages/tsconfig/src/find-tsconfig.ts:29](https://github.com/visulima/visulima/blob/91304e1126993b7c002fd16a406185a908b64074/packages/tsconfig/src/find-tsconfig.ts#L29)
+Defined in: [packages/tsconfig/src/find-tsconfig.ts:30](https://github.com/visulima/visulima/blob/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/find-tsconfig.ts#L30)
 
 An asynchronous function that retrieves the TSConfig by searching for the "tsconfig.json" first,
 second attempt is to look for the "jsconfig.json" file from a given current working directory.
@@ -207,7 +207,7 @@ Optional. The current working directory from which to search for the "tsconfig.j
 
 ##### options?
 
-`Options` = `{}`
+[`FindTsConfigOptions`](README.md#findtsconfigoptions) = `{}`
 
 #### Returns
 
@@ -228,7 +228,7 @@ An `Error` when the "tsconfig.json" file is not found.
 function findTsConfigSync(cwd?, options?): TsConfigResult
 ```
 
-Defined in: [packages/tsconfig/src/find-tsconfig.ts:66](https://github.com/visulima/visulima/blob/91304e1126993b7c002fd16a406185a908b64074/packages/tsconfig/src/find-tsconfig.ts#L66)
+Defined in: [packages/tsconfig/src/find-tsconfig.ts:69](https://github.com/visulima/visulima/blob/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/find-tsconfig.ts#L69)
 
 #### Parameters
 
@@ -238,7 +238,7 @@ Defined in: [packages/tsconfig/src/find-tsconfig.ts:66](https://github.com/visul
 
 ##### options?
 
-`Options` = `{}`
+[`FindTsConfigOptions`](README.md#findtsconfigoptions) = `{}`
 
 #### Returns
 
@@ -252,7 +252,7 @@ Defined in: [packages/tsconfig/src/find-tsconfig.ts:66](https://github.com/visul
 function readTsConfig(tsconfigPath, options?): object
 ```
 
-Defined in: [packages/tsconfig/src/read-tsconfig.ts:460](https://github.com/visulima/visulima/blob/91304e1126993b7c002fd16a406185a908b64074/packages/tsconfig/src/read-tsconfig.ts#L460)
+Defined in: [packages/tsconfig/src/read-tsconfig.ts:460](https://github.com/visulima/visulima/blob/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/read-tsconfig.ts#L460)
 
 #### Parameters
 
@@ -262,7 +262,7 @@ Defined in: [packages/tsconfig/src/read-tsconfig.ts:460](https://github.com/visu
 
 ##### options?
 
-`Options`
+[`ReadTsConfigOptions`](README.md#readtsconfigoptions)
 
 #### Returns
 
@@ -344,7 +344,7 @@ Instructs the TypeScript compiler how to watch files.
 function writeTsConfig(tsConfig, options): Promise<void>
 ```
 
-Defined in: [packages/tsconfig/src/write-tsconfig.ts:17](https://github.com/visulima/visulima/blob/91304e1126993b7c002fd16a406185a908b64074/packages/tsconfig/src/write-tsconfig.ts#L17)
+Defined in: [packages/tsconfig/src/write-tsconfig.ts:17](https://github.com/visulima/visulima/blob/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/write-tsconfig.ts#L17)
 
 An asynchronous function that writes the provided TypeScript configuration object to a tsconfig.json file.
 
@@ -378,7 +378,7 @@ The return type of function is `Promise<void>`.
 function writeTsConfigSync(tsConfig, options): void
 ```
 
-Defined in: [packages/tsconfig/src/write-tsconfig.ts:35](https://github.com/visulima/visulima/blob/91304e1126993b7c002fd16a406185a908b64074/packages/tsconfig/src/write-tsconfig.ts#L35)
+Defined in: [packages/tsconfig/src/write-tsconfig.ts:35](https://github.com/visulima/visulima/blob/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/write-tsconfig.ts#L35)
 
 A function that writes the provided TypeScript configuration object to a tsconfig.json file.
 
@@ -412,7 +412,61 @@ The return type of function is `Promise<void>`.
 const implicitBaseUrlSymbol: typeof implicitBaseUrlSymbol;
 ```
 
-Defined in: [packages/tsconfig/src/read-tsconfig.ts:457](https://github.com/visulima/visulima/blob/91304e1126993b7c002fd16a406185a908b64074/packages/tsconfig/src/read-tsconfig.ts#L457)
+Defined in: [packages/tsconfig/src/read-tsconfig.ts:457](https://github.com/visulima/visulima/blob/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/read-tsconfig.ts#L457)
+
+***
+
+### FindTsConfigOptions
+
+```ts
+type FindTsConfigOptions = ReadTsConfigOptions & object;
+```
+
+Defined in: [packages/tsconfig/src/find-tsconfig.ts:10](https://github.com/visulima/visulima/blob/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/find-tsconfig.ts#L10)
+
+#### Type declaration
+
+##### cache?
+
+```ts
+optional cache: 
+  | Map<string, TsConfigJsonResolved>
+  | boolean;
+```
+
+##### configFileName?
+
+```ts
+optional configFileName: string;
+```
+
+***
+
+### ReadTsConfigOptions
+
+```ts
+type ReadTsConfigOptions = object;
+```
+
+Defined in: [packages/tsconfig/src/read-tsconfig.ts:444](https://github.com/visulima/visulima/blob/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/read-tsconfig.ts#L444)
+
+#### Type declaration
+
+##### tscCompatible?
+
+```ts
+optional tscCompatible: "5.3" | "5.4" | "5.5" | "5.6" | true;
+```
+
+Make the configuration compatible with the specified TypeScript version.
+
+When `true`, it will make the configuration compatible with the latest TypeScript version.
+
+###### Default
+
+```ts
+undefined
+```
 
 ***
 
@@ -422,7 +476,7 @@ Defined in: [packages/tsconfig/src/read-tsconfig.ts:457](https://github.com/visu
 type TsConfigJsonResolved = Except<TsConfigJson, "extends">;
 ```
 
-Defined in: [packages/tsconfig/src/types.ts:3](https://github.com/visulima/visulima/blob/91304e1126993b7c002fd16a406185a908b64074/packages/tsconfig/src/types.ts#L3)
+Defined in: [packages/tsconfig/src/types.ts:3](https://github.com/visulima/visulima/blob/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/types.ts#L3)
 
 ***
 
@@ -432,7 +486,7 @@ Defined in: [packages/tsconfig/src/types.ts:3](https://github.com/visulima/visul
 type TsConfigResult = object;
 ```
 
-Defined in: [packages/tsconfig/src/find-tsconfig.ts:14](https://github.com/visulima/visulima/blob/91304e1126993b7c002fd16a406185a908b64074/packages/tsconfig/src/find-tsconfig.ts#L14)
+Defined in: [packages/tsconfig/src/find-tsconfig.ts:15](https://github.com/visulima/visulima/blob/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/find-tsconfig.ts#L15)
 
 #### Type declaration
 
@@ -461,6 +515,8 @@ path: string;
 - [writeTsConfigSync](README.md#writetsconfigsync)
 - [TsConfigJson](namespaces/TsConfigJson/README.md)
 - [implicitBaseUrlSymbol](README.md#implicitbaseurlsymbol)
+- [FindTsConfigOptions](README.md#findtsconfigoptions)
+- [ReadTsConfigOptions](README.md#readtsconfigoptions)
 - [TsConfigJsonResolved](README.md#tsconfigjsonresolved)
 - [TsConfigResult](README.md#tsconfigresult)
 

package/dist/index.cjs

@@ -2,7 +2,7 @@
 
 Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
 
-const findTsConfig = require('./packem_shared/findTsConfig-ZJsQkecJ.cjs');
+const findTsConfig = require('./packem_shared/findTsConfig-DeoHFadL.cjs');
 const implicitBaseUrlSymbol = require('./packem_shared/implicitBaseUrlSymbol-COTDbERy.cjs');
 const writeTsConfig = require('./packem_shared/writeTsConfig-DJa7JuZ_.cjs');
 

package/dist/index.d.cts

@@ -1397,6 +1397,12 @@ type TsConfigJson = {
 type TsConfigJsonResolved = Except<TsConfigJson, "extends">;
 
 type Options$1 = {
+    tscCompatible?: "5.3" | "5.4" | "5.5" | "5.6" | true;
+};
+declare const implicitBaseUrlSymbol: unique symbol;
+declare const readTsConfig: (tsconfigPath: string, options?: Options$1) => TsConfigJsonResolved;
+
+type Options = Options$1 & {
     cache?: Map<string, TsConfigJsonResolved> | boolean;
     configFileName?: string;
 };
@@ -1404,14 +1410,8 @@ type TsConfigResult = {
     config: TsConfigJsonResolved;
     path: string;
 };
-declare const findTsConfig: (cwd?: URL | string, options?: Options$1) => Promise<TsConfigResult>;
-declare const findTsConfigSync: (cwd?: URL | string, options?: Options$1) => TsConfigResult;
-
-type Options = {
-    tscCompatible?: "5.3" | "5.4" | "5.5" | "5.6" | true;
-};
-declare const implicitBaseUrlSymbol: unique symbol;
-declare const readTsConfig: (tsconfigPath: string, options?: Options) => TsConfigJsonResolved;
+declare const findTsConfig: (cwd?: URL | string, options?: Options) => Promise<TsConfigResult>;
+declare const findTsConfigSync: (cwd?: URL | string, options?: Options) => TsConfigResult;
 
 declare const writeTsConfig: (tsConfig: TsConfigJson, options?: WriteJsonOptions & {
     cwd?: URL | string;
@@ -1420,4 +1420,4 @@ declare const writeTsConfigSync: (tsConfig: TsConfigJson, options?: WriteJsonOpt
     cwd?: URL | string;
 }) => void;
 
-export { TsConfigJson, type TsConfigJsonResolved, type TsConfigResult, findTsConfig, findTsConfigSync, implicitBaseUrlSymbol, readTsConfig, writeTsConfig, writeTsConfigSync };
+export { type Options as FindTsConfigOptions, type Options$1 as ReadTsConfigOptions, TsConfigJson, type TsConfigJsonResolved, type TsConfigResult, findTsConfig, findTsConfigSync, implicitBaseUrlSymbol, readTsConfig, writeTsConfig, writeTsConfigSync };

package/dist/index.d.mts

@@ -1397,6 +1397,12 @@ type TsConfigJson = {
 type TsConfigJsonResolved = Except<TsConfigJson, "extends">;
 
 type Options$1 = {
+    tscCompatible?: "5.3" | "5.4" | "5.5" | "5.6" | true;
+};
+declare const implicitBaseUrlSymbol: unique symbol;
+declare const readTsConfig: (tsconfigPath: string, options?: Options$1) => TsConfigJsonResolved;
+
+type Options = Options$1 & {
     cache?: Map<string, TsConfigJsonResolved> | boolean;
     configFileName?: string;
 };
@@ -1404,14 +1410,8 @@ type TsConfigResult = {
     config: TsConfigJsonResolved;
     path: string;
 };
-declare const findTsConfig: (cwd?: URL | string, options?: Options$1) => Promise<TsConfigResult>;
-declare const findTsConfigSync: (cwd?: URL | string, options?: Options$1) => TsConfigResult;
-
-type Options = {
-    tscCompatible?: "5.3" | "5.4" | "5.5" | "5.6" | true;
-};
-declare const implicitBaseUrlSymbol: unique symbol;
-declare const readTsConfig: (tsconfigPath: string, options?: Options) => TsConfigJsonResolved;
+declare const findTsConfig: (cwd?: URL | string, options?: Options) => Promise<TsConfigResult>;
+declare const findTsConfigSync: (cwd?: URL | string, options?: Options) => TsConfigResult;
 
 declare const writeTsConfig: (tsConfig: TsConfigJson, options?: WriteJsonOptions & {
     cwd?: URL | string;
@@ -1420,4 +1420,4 @@ declare const writeTsConfigSync: (tsConfig: TsConfigJson, options?: WriteJsonOpt
     cwd?: URL | string;
 }) => void;
 
-export { TsConfigJson, type TsConfigJsonResolved, type TsConfigResult, findTsConfig, findTsConfigSync, implicitBaseUrlSymbol, readTsConfig, writeTsConfig, writeTsConfigSync };
+export { type Options as FindTsConfigOptions, type Options$1 as ReadTsConfigOptions, TsConfigJson, type TsConfigJsonResolved, type TsConfigResult, findTsConfig, findTsConfigSync, implicitBaseUrlSymbol, readTsConfig, writeTsConfig, writeTsConfigSync };

package/dist/index.d.ts

@@ -1397,6 +1397,12 @@ type TsConfigJson = {
 type TsConfigJsonResolved = Except<TsConfigJson, "extends">;
 
 type Options$1 = {
+    tscCompatible?: "5.3" | "5.4" | "5.5" | "5.6" | true;
+};
+declare const implicitBaseUrlSymbol: unique symbol;
+declare const readTsConfig: (tsconfigPath: string, options?: Options$1) => TsConfigJsonResolved;
+
+type Options = Options$1 & {
     cache?: Map<string, TsConfigJsonResolved> | boolean;
     configFileName?: string;
 };
@@ -1404,14 +1410,8 @@ type TsConfigResult = {
     config: TsConfigJsonResolved;
     path: string;
 };
-declare const findTsConfig: (cwd?: URL | string, options?: Options$1) => Promise<TsConfigResult>;
-declare const findTsConfigSync: (cwd?: URL | string, options?: Options$1) => TsConfigResult;
-
-type Options = {
-    tscCompatible?: "5.3" | "5.4" | "5.5" | "5.6" | true;
-};
-declare const implicitBaseUrlSymbol: unique symbol;
-declare const readTsConfig: (tsconfigPath: string, options?: Options) => TsConfigJsonResolved;
+declare const findTsConfig: (cwd?: URL | string, options?: Options) => Promise<TsConfigResult>;
+declare const findTsConfigSync: (cwd?: URL | string, options?: Options) => TsConfigResult;
 
 declare const writeTsConfig: (tsConfig: TsConfigJson, options?: WriteJsonOptions & {
     cwd?: URL | string;
@@ -1420,4 +1420,4 @@ declare const writeTsConfigSync: (tsConfig: TsConfigJson, options?: WriteJsonOpt
     cwd?: URL | string;
 }) => void;
 
-export { TsConfigJson, type TsConfigJsonResolved, type TsConfigResult, findTsConfig, findTsConfigSync, implicitBaseUrlSymbol, readTsConfig, writeTsConfig, writeTsConfigSync };
+export { type Options as FindTsConfigOptions, type Options$1 as ReadTsConfigOptions, TsConfigJson, type TsConfigJsonResolved, type TsConfigResult, findTsConfig, findTsConfigSync, implicitBaseUrlSymbol, readTsConfig, writeTsConfig, writeTsConfigSync };

package/dist/index.mjs

@@ -1,3 +1,3 @@
-export { findTsConfig, findTsConfigSync } from './packem_shared/findTsConfig-BpddJoXs.mjs';
+export { findTsConfig, findTsConfigSync } from './packem_shared/findTsConfig-C0Rp7UlA.mjs';
 export { implicitBaseUrlSymbol, readTsConfig } from './packem_shared/implicitBaseUrlSymbol-QFe6oEcv.mjs';
 export { writeTsConfig, writeTsConfigSync } from './packem_shared/writeTsConfig-BImVv2Ba.mjs';

package/dist/packem_shared/{findTsConfig-BpddJoXs.mjs → findTsConfig-C0Rp7UlA.mjs}

@@ -25,7 +25,9 @@ const findTsConfig = /* @__PURE__ */ __name(async (cwd, options = {}) => {
     return cache.get(filePath);
   }
   const output = {
-    config: readTsConfig(filePath),
+    config: readTsConfig(filePath, {
+      tscCompatible: options.tscCompatible
+    }),
     path: filePath
   };
   if (options.cache) {
@@ -53,7 +55,9 @@ const findTsConfigSync = /* @__PURE__ */ __name((cwd, options = {}) => {
     return cache.get(filePath);
   }
   const output = {
-    config: readTsConfig(filePath),
+    config: readTsConfig(filePath, {
+      tscCompatible: options.tscCompatible
+    }),
     path: filePath
   };
   if (options.cache) {

package/dist/packem_shared/{findTsConfig-ZJsQkecJ.cjs → findTsConfig-DeoHFadL.cjs}

@@ -29,7 +29,9 @@ const findTsConfig = /* @__PURE__ */ __name(async (cwd, options = {}) => {
     return cache.get(filePath);
   }
   const output = {
-    config: implicitBaseUrlSymbol.readTsConfig(filePath),
+    config: implicitBaseUrlSymbol.readTsConfig(filePath, {
+      tscCompatible: options.tscCompatible
+    }),
     path: filePath
   };
   if (options.cache) {
@@ -57,7 +59,9 @@ const findTsConfigSync = /* @__PURE__ */ __name((cwd, options = {}) => {
     return cache.get(filePath);
   }
   const output = {
-    config: implicitBaseUrlSymbol.readTsConfig(filePath),
+    config: implicitBaseUrlSymbol.readTsConfig(filePath, {
+      tscCompatible: options.tscCompatible
+    }),
     path: filePath
   };
   if (options.cache) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visulima/tsconfig",
-  "version": "1.1.8",
+  "version": "1.1.9",
   "description": "Find and/or parse the tsconfig.json file from a directory path.",
   "keywords": [
     "anolilab",