@visulima/tsconfig 1.1.16 → 1.1.17

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+## @visulima/tsconfig [1.1.17](https://github.com/visulima/visulima/compare/@visulima/tsconfig@1.1.16...@visulima/tsconfig@1.1.17) (2025-05-30)
+
+### Styles
+
+* cs fixes ([6570d56](https://github.com/visulima/visulima/commit/6570d568a80bd3fd4bfd73c824dc78f7e3a372f8))
+
+### Miscellaneous Chores
+
+* **tsconfig:** update devDependencies ([7c12ca5](https://github.com/visulima/visulima/commit/7c12ca59b30981d5f2048b2ef2a44234efe39c77))
+* updated dev dependencies ([2433ed5](https://github.com/visulima/visulima/commit/2433ed5fb662e0303c37edee8ddc21b46c21263f))
+
+
+### Dependencies
+
+* **@visulima/fs:** upgraded to 3.1.3
+* **@visulima/path:** upgraded to 1.3.6
+
 ## @visulima/tsconfig [1.1.16](https://github.com/visulima/visulima/compare/@visulima/tsconfig@1.1.15...@visulima/tsconfig@1.1.16) (2025-03-07)
 
 ### Bug Fixes

package/README.md

@@ -101,11 +101,11 @@ const tsconfig = await readTsConfig("/Users/../Projects/visulima/packages/tsconf
 type TsConfigJson = object;
 ```
 
-Defined in: node\_modules/.pnpm/type-fest@4.37.0/node\_modules/type-fest/source/tsconfig-json.d.ts:1
+Defined in: node\_modules/.pnpm/type-fest@4.41.0/node\_modules/type-fest/source/tsconfig-json.d.ts:1
 
 Type for [TypeScript's `tsconfig.json` file](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) (TypeScript 3.7).
 
-#### Type declaration
+#### Properties
 
 ##### compileOnSave?
 
@@ -113,6 +113,8 @@ Type for [TypeScript's `tsconfig.json` file](https://www.typescriptlang.org/docs
 optional compileOnSave: boolean;
 ```
 
+Defined in: node\_modules/.pnpm/type-fest@4.41.0/node\_modules/type-fest/source/tsconfig-json.d.ts:1264
+
 Enable Compile-on-Save for this project.
 
 ##### compilerOptions?
@@ -121,6 +123,8 @@ Enable Compile-on-Save for this project.
 optional compilerOptions: CompilerOptions;
 ```
 
+Defined in: node\_modules/.pnpm/type-fest@4.41.0/node\_modules/type-fest/source/tsconfig-json.d.ts:1249
+
 Instructs the TypeScript compiler how to compile `.ts` files.
 
 ##### exclude?
@@ -129,6 +133,8 @@ Instructs the TypeScript compiler how to compile `.ts` files.
 optional exclude: string[];
 ```
 
+Defined in: node\_modules/.pnpm/type-fest@4.41.0/node\_modules/type-fest/source/tsconfig-json.d.ts:1281
+
 Specifies a list of files to be excluded from compilation. The `exclude` property only affects the files included via the `include` property and not the `files` property.
 
 Glob patterns require TypeScript version 2.0 or later.
@@ -139,6 +145,8 @@ Glob patterns require TypeScript version 2.0 or later.
 optional extends: string | string[];
 ```
 
+Defined in: node\_modules/.pnpm/type-fest@4.41.0/node\_modules/type-fest/source/tsconfig-json.d.ts:1269
+
 Path to base configuration file to inherit from.
 
 ##### files?
@@ -147,6 +155,8 @@ Path to base configuration file to inherit from.
 optional files: string[];
 ```
 
+Defined in: node\_modules/.pnpm/type-fest@4.41.0/node\_modules/type-fest/source/tsconfig-json.d.ts:1274
+
 If no `files` or `include` property is present in a `tsconfig.json`, the compiler defaults to including all files in the containing directory and subdirectories except those specified by `exclude`. When a `files` property is specified, only those files and those specified by `include` are included.
 
 ##### include?
@@ -155,6 +165,8 @@ If no `files` or `include` property is present in a `tsconfig.json`, the compile
 optional include: string[];
 ```
 
+Defined in: node\_modules/.pnpm/type-fest@4.41.0/node\_modules/type-fest/source/tsconfig-json.d.ts:1288
+
 Specifies a list of glob patterns that match files to be included in compilation.
 
 If no `files` or `include` property is present in a `tsconfig.json`, the compiler defaults to including all files in the containing directory and subdirectories except those specified by `exclude`.
@@ -165,6 +177,8 @@ If no `files` or `include` property is present in a `tsconfig.json`, the compile
 optional references: References[];
 ```
 
+Defined in: node\_modules/.pnpm/type-fest@4.41.0/node\_modules/type-fest/source/tsconfig-json.d.ts:1293
+
 Referenced projects.
 
 ##### typeAcquisition?
@@ -173,6 +187,8 @@ Referenced projects.
 optional typeAcquisition: TypeAcquisition;
 ```
 
+Defined in: node\_modules/.pnpm/type-fest@4.41.0/node\_modules/type-fest/source/tsconfig-json.d.ts:1259
+
 Auto type (.d.ts) acquisition options for this project.
 
 ##### watchOptions?
@@ -181,6 +197,8 @@ Auto type (.d.ts) acquisition options for this project.
 optional watchOptions: WatchOptions;
 ```
 
+Defined in: node\_modules/.pnpm/type-fest@4.41.0/node\_modules/type-fest/source/tsconfig-json.d.ts:1254
+
 Instructs the TypeScript compiler how to watch files.
 
 ## Other
@@ -188,10 +206,10 @@ Instructs the TypeScript compiler how to watch files.
 ### findTsConfig()
 
 ```ts
-function findTsConfig(cwd?, options?): Promise<TsConfigResult>
+function findTsConfig(cwd?, options?): Promise<TsConfigResult>;
 ```
 
-Defined in: [packages/tsconfig/src/find-tsconfig.ts:30](https://github.com/visulima/visulima/blob/ae1c843808a0fea82d6f99ef936ec12dc5b255c1/packages/tsconfig/src/find-tsconfig.ts#L30)
+Defined in: [packages/tsconfig/src/find-tsconfig.ts:30](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/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,11 +225,11 @@ Optional. The current working directory from which to search for the "tsconfig.j
 
 ##### options?
 
-[`FindTsConfigOptions`](README.md#findtsconfigoptions) = `{}`
+[`FindTsConfigOptions`](#findtsconfigoptions) = `{}`
 
 #### Returns
 
-`Promise`\<[`TsConfigResult`](README.md#tsconfigresult)\>
+`Promise`\<[`TsConfigResult`](#tsconfigresult)\>
 
 A `Promise` that resolves to the TSConfig result object.
          The return type of the function is `Promise<TsConfigResult>`.
@@ -225,10 +243,10 @@ An `Error` when the "tsconfig.json" file is not found.
 ### findTsConfigSync()
 
 ```ts
-function findTsConfigSync(cwd?, options?): TsConfigResult
+function findTsConfigSync(cwd?, options?): TsConfigResult;
 ```
 
-Defined in: [packages/tsconfig/src/find-tsconfig.ts:69](https://github.com/visulima/visulima/blob/ae1c843808a0fea82d6f99ef936ec12dc5b255c1/packages/tsconfig/src/find-tsconfig.ts#L69)
+Defined in: [packages/tsconfig/src/find-tsconfig.ts:69](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/tsconfig/src/find-tsconfig.ts#L69)
 
 #### Parameters
 
@@ -238,21 +256,21 @@ Defined in: [packages/tsconfig/src/find-tsconfig.ts:69](https://github.com/visul
 
 ##### options?
 
-[`FindTsConfigOptions`](README.md#findtsconfigoptions) = `{}`
+[`FindTsConfigOptions`](#findtsconfigoptions) = `{}`
 
 #### Returns
 
-[`TsConfigResult`](README.md#tsconfigresult)
+[`TsConfigResult`](#tsconfigresult)
 
 ***
 
 ### readTsConfig()
 
 ```ts
-function readTsConfig(tsconfigPath, options?): object
+function readTsConfig(tsconfigPath, options?): object;
 ```
 
-Defined in: [packages/tsconfig/src/read-tsconfig.ts:460](https://github.com/visulima/visulima/blob/ae1c843808a0fea82d6f99ef936ec12dc5b255c1/packages/tsconfig/src/read-tsconfig.ts#L460)
+Defined in: [packages/tsconfig/src/read-tsconfig.ts:460](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/tsconfig/src/read-tsconfig.ts#L460)
 
 #### Parameters
 
@@ -262,12 +280,10 @@ Defined in: [packages/tsconfig/src/read-tsconfig.ts:460](https://github.com/visu
 
 ##### options?
 
-[`ReadTsConfigOptions`](README.md#readtsconfigoptions)
+[`ReadTsConfigOptions`](#readtsconfigoptions)
 
 #### Returns
 
-`object`
-
 ##### compileOnSave?
 
 ```ts
@@ -341,10 +357,10 @@ Instructs the TypeScript compiler how to watch files.
 ### writeTsConfig()
 
 ```ts
-function writeTsConfig(tsConfig, options): Promise<void>
+function writeTsConfig(tsConfig, options): Promise<void>;
 ```
 
-Defined in: [packages/tsconfig/src/write-tsconfig.ts:17](https://github.com/visulima/visulima/blob/ae1c843808a0fea82d6f99ef936ec12dc5b255c1/packages/tsconfig/src/write-tsconfig.ts#L17)
+Defined in: [packages/tsconfig/src/write-tsconfig.ts:17](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/tsconfig/src/write-tsconfig.ts#L17)
 
 An asynchronous function that writes the provided TypeScript configuration object to a tsconfig.json file.
 
@@ -352,7 +368,7 @@ An asynchronous function that writes the provided TypeScript configuration objec
 
 ##### tsConfig
 
-[`TsConfigJson`](README.md#tsconfigjson)
+[`TsConfigJson`](#tsconfigjson)
 
 The TypeScript configuration object to write. The type of `tsConfig` is `TsConfigJson`.
 
@@ -375,10 +391,10 @@ The return type of function is `Promise<void>`.
 ### writeTsConfigSync()
 
 ```ts
-function writeTsConfigSync(tsConfig, options): void
+function writeTsConfigSync(tsConfig, options): void;
 ```
 
-Defined in: [packages/tsconfig/src/write-tsconfig.ts:35](https://github.com/visulima/visulima/blob/ae1c843808a0fea82d6f99ef936ec12dc5b255c1/packages/tsconfig/src/write-tsconfig.ts#L35)
+Defined in: [packages/tsconfig/src/write-tsconfig.ts:35](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/tsconfig/src/write-tsconfig.ts#L35)
 
 A function that writes the provided TypeScript configuration object to a tsconfig.json file.
 
@@ -386,7 +402,7 @@ A function that writes the provided TypeScript configuration object to a tsconfi
 
 ##### tsConfig
 
-[`TsConfigJson`](README.md#tsconfigjson)
+[`TsConfigJson`](#tsconfigjson)
 
 The TypeScript configuration object to write. The type of `tsConfig` is `TsConfigJson`.
 
@@ -412,7 +428,7 @@ 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/ae1c843808a0fea82d6f99ef936ec12dc5b255c1/packages/tsconfig/src/read-tsconfig.ts#L457)
+Defined in: [packages/tsconfig/src/read-tsconfig.ts:457](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/tsconfig/src/read-tsconfig.ts#L457)
 
 ***
 
@@ -422,7 +438,7 @@ Defined in: [packages/tsconfig/src/read-tsconfig.ts:457](https://github.com/visu
 type FindTsConfigOptions = ReadTsConfigOptions & object;
 ```
 
-Defined in: [packages/tsconfig/src/find-tsconfig.ts:10](https://github.com/visulima/visulima/blob/ae1c843808a0fea82d6f99ef936ec12dc5b255c1/packages/tsconfig/src/find-tsconfig.ts#L10)
+Defined in: [packages/tsconfig/src/find-tsconfig.ts:10](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/tsconfig/src/find-tsconfig.ts#L10)
 
 #### Type declaration
 
@@ -448,9 +464,9 @@ optional configFileName: string;
 type ReadTsConfigOptions = object;
 ```
 
-Defined in: [packages/tsconfig/src/read-tsconfig.ts:444](https://github.com/visulima/visulima/blob/ae1c843808a0fea82d6f99ef936ec12dc5b255c1/packages/tsconfig/src/read-tsconfig.ts#L444)
+Defined in: [packages/tsconfig/src/read-tsconfig.ts:444](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/tsconfig/src/read-tsconfig.ts#L444)
 
-#### Type declaration
+#### Properties
 
 ##### tscCompatible?
 
@@ -458,6 +474,8 @@ Defined in: [packages/tsconfig/src/read-tsconfig.ts:444](https://github.com/visu
 optional tscCompatible: "5.3" | "5.4" | "5.5" | "5.6" | true;
 ```
 
+Defined in: [packages/tsconfig/src/read-tsconfig.ts:452](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/tsconfig/src/read-tsconfig.ts#L452)
+
 Make the configuration compatible with the specified TypeScript version.
 
 When `true`, it will make the configuration compatible with the latest TypeScript version.
@@ -476,7 +494,7 @@ undefined
 type TsConfigJsonResolved = Except<TsConfigJson, "extends">;
 ```
 
-Defined in: [packages/tsconfig/src/types.ts:3](https://github.com/visulima/visulima/blob/ae1c843808a0fea82d6f99ef936ec12dc5b255c1/packages/tsconfig/src/types.ts#L3)
+Defined in: [packages/tsconfig/src/types.ts:3](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/tsconfig/src/types.ts#L3)
 
 ***
 
@@ -486,9 +504,9 @@ Defined in: [packages/tsconfig/src/types.ts:3](https://github.com/visulima/visul
 type TsConfigResult = object;
 ```
 
-Defined in: [packages/tsconfig/src/find-tsconfig.ts:15](https://github.com/visulima/visulima/blob/ae1c843808a0fea82d6f99ef936ec12dc5b255c1/packages/tsconfig/src/find-tsconfig.ts#L15)
+Defined in: [packages/tsconfig/src/find-tsconfig.ts:15](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/tsconfig/src/find-tsconfig.ts#L15)
 
-#### Type declaration
+#### Properties
 
 ##### config
 
@@ -496,12 +514,16 @@ Defined in: [packages/tsconfig/src/find-tsconfig.ts:15](https://github.com/visul
 config: TsConfigJsonResolved;
 ```
 
+Defined in: [packages/tsconfig/src/find-tsconfig.ts:16](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/tsconfig/src/find-tsconfig.ts#L16)
+
 ##### path
 
 ```ts
 path: string;
 ```
 
+Defined in: [packages/tsconfig/src/find-tsconfig.ts:17](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/tsconfig/src/find-tsconfig.ts#L17)
+
 <!-- /TYPEDOC -->
 
 ## Related