@visulima/tsconfig 1.1.9 → 1.1.11

package/CHANGELOG.md

@@ -1,3 +1,29 @@
+## @visulima/tsconfig [1.1.11](https://github.com/visulima/visulima/compare/@visulima/tsconfig@1.1.10...@visulima/tsconfig@1.1.11) (2025-01-25)
+
+### Miscellaneous Chores
+
+* updated all dev dependencies ([37fb298](https://github.com/visulima/visulima/commit/37fb298b2af7c63be64252024e54bb3af6ddabec))
+
+
+### Dependencies
+
+* **@visulima/fs:** upgraded to 3.0.0
+
+## @visulima/tsconfig [1.1.10](https://github.com/visulima/visulima/compare/@visulima/tsconfig@1.1.9...@visulima/tsconfig@1.1.10) (2025-01-22)
+
+### Styles
+
+* cs fixes ([f615a6a](https://github.com/visulima/visulima/commit/f615a6af4c0d4fb9ec054565fe5c93e88df487e9))
+
+### Miscellaneous Chores
+
+* updated all dev dependencies and all dependencies in the app folder ([87f4ccb](https://github.com/visulima/visulima/commit/87f4ccbf9f7900ec5b56f3c1477bc4a0ef571bcf))
+
+
+### Dependencies
+
+* **@visulima/fs:** upgraded to 2.3.8
+
 ## @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

package/README.md

@@ -101,7 +101,7 @@ const tsconfig = await readTsConfig("/Users/../Projects/visulima/packages/tsconf
 type TsConfigJson = object;
 ```
 
-Defined in: node\_modules/.pnpm/type-fest@4.32.0/node\_modules/type-fest/source/tsconfig-json.d.ts:1
+Defined in: node\_modules/.pnpm/type-fest@4.33.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).
 
@@ -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:30](https://github.com/visulima/visulima/blob/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/find-tsconfig.ts#L30)
+Defined in: [packages/tsconfig/src/find-tsconfig.ts:30](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/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.
@@ -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:69](https://github.com/visulima/visulima/blob/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/find-tsconfig.ts#L69)
+Defined in: [packages/tsconfig/src/find-tsconfig.ts:69](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/tsconfig/src/find-tsconfig.ts#L69)
 
 #### Parameters
 
@@ -252,7 +252,7 @@ Defined in: [packages/tsconfig/src/find-tsconfig.ts:69](https://github.com/visul
 function readTsConfig(tsconfigPath, options?): object
 ```
 
-Defined in: [packages/tsconfig/src/read-tsconfig.ts:460](https://github.com/visulima/visulima/blob/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/read-tsconfig.ts#L460)
+Defined in: [packages/tsconfig/src/read-tsconfig.ts:460](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/tsconfig/src/read-tsconfig.ts#L460)
 
 #### Parameters
 
@@ -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/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/write-tsconfig.ts#L17)
+Defined in: [packages/tsconfig/src/write-tsconfig.ts:17](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/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/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/write-tsconfig.ts#L35)
+Defined in: [packages/tsconfig/src/write-tsconfig.ts:35](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/tsconfig/src/write-tsconfig.ts#L35)
 
 A function that writes the provided TypeScript configuration object to a tsconfig.json file.
 
@@ -412,7 +412,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/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/read-tsconfig.ts#L457)
+Defined in: [packages/tsconfig/src/read-tsconfig.ts:457](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/tsconfig/src/read-tsconfig.ts#L457)
 
 ***
 
@@ -422,7 +422,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/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/find-tsconfig.ts#L10)
+Defined in: [packages/tsconfig/src/find-tsconfig.ts:10](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/tsconfig/src/find-tsconfig.ts#L10)
 
 #### Type declaration
 
@@ -448,7 +448,7 @@ optional configFileName: string;
 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)
+Defined in: [packages/tsconfig/src/read-tsconfig.ts:444](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/tsconfig/src/read-tsconfig.ts#L444)
 
 #### Type declaration
 
@@ -476,7 +476,7 @@ undefined
 type TsConfigJsonResolved = Except<TsConfigJson, "extends">;
 ```
 
-Defined in: [packages/tsconfig/src/types.ts:3](https://github.com/visulima/visulima/blob/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/types.ts#L3)
+Defined in: [packages/tsconfig/src/types.ts:3](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/tsconfig/src/types.ts#L3)
 
 ***
 
@@ -486,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:15](https://github.com/visulima/visulima/blob/fa809618aec6ec5f8777beb384509ed6c6794d43/packages/tsconfig/src/find-tsconfig.ts#L15)
+Defined in: [packages/tsconfig/src/find-tsconfig.ts:15](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/tsconfig/src/find-tsconfig.ts#L15)
 
 #### Type declaration
 

package/dist/index.d.cts

@@ -108,6 +108,26 @@ type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
 
 const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
 //=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
+
+// The `Omit` utility type doesn't work when omitting specific keys from objects containing index signatures.
+
+// Consider the following example:
+
+type UserData = {
+	[metadata: string]: string;
+	email: string;
+	name: string;
+	role: 'admin' | 'user';
+};
+
+// `Omit` clearly doesn't behave as expected in this case:
+type PostPayload = Omit<UserData, 'email'>;
+//=> type PostPayload = { [x: string]: string; [x: number]: string; }
+
+// In situations like this, `Except` works better.
+// It simply removes the `email` key while preserving all the other keys.
+type PostPayload = Except<UserData, 'email'>;
+//=> type PostPayload = { [x: string]: string; name: string; role: 'admin' | 'user'; }
 ```
 
 @category Object

package/dist/index.d.mts

@@ -108,6 +108,26 @@ type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
 
 const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
 //=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
+
+// The `Omit` utility type doesn't work when omitting specific keys from objects containing index signatures.
+
+// Consider the following example:
+
+type UserData = {
+	[metadata: string]: string;
+	email: string;
+	name: string;
+	role: 'admin' | 'user';
+};
+
+// `Omit` clearly doesn't behave as expected in this case:
+type PostPayload = Omit<UserData, 'email'>;
+//=> type PostPayload = { [x: string]: string; [x: number]: string; }
+
+// In situations like this, `Except` works better.
+// It simply removes the `email` key while preserving all the other keys.
+type PostPayload = Except<UserData, 'email'>;
+//=> type PostPayload = { [x: string]: string; name: string; role: 'admin' | 'user'; }
 ```
 
 @category Object

package/dist/index.d.ts

@@ -108,6 +108,26 @@ type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
 
 const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
 //=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
+
+// The `Omit` utility type doesn't work when omitting specific keys from objects containing index signatures.
+
+// Consider the following example:
+
+type UserData = {
+	[metadata: string]: string;
+	email: string;
+	name: string;
+	role: 'admin' | 'user';
+};
+
+// `Omit` clearly doesn't behave as expected in this case:
+type PostPayload = Omit<UserData, 'email'>;
+//=> type PostPayload = { [x: string]: string; [x: number]: string; }
+
+// In situations like this, `Except` works better.
+// It simply removes the `email` key while preserving all the other keys.
+type PostPayload = Except<UserData, 'email'>;
+//=> type PostPayload = { [x: string]: string; name: string; role: 'admin' | 'user'; }
 ```
 
 @category Object

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visulima/tsconfig",
-  "version": "1.1.9",
+  "version": "1.1.11",
   "description": "Find and/or parse the tsconfig.json file from a directory path.",
   "keywords": [
     "anolilab",
@@ -67,83 +67,16 @@
     "CHANGELOG.md"
   ],
   "dependencies": {
-    "@visulima/fs": "2.3.7",
+    "@visulima/fs": "3.0.0",
     "@visulima/path": "1.3.3",
     "jsonc-parser": "^3.3.1",
     "resolve-pkg-maps": "^1.0.0"
   },
-  "devDependencies": {
-    "@anolilab/eslint-config": "^15.0.3",
-    "@anolilab/prettier-config": "^5.0.14",
-    "@anolilab/semantic-release-pnpm": "1.1.6",
-    "@anolilab/semantic-release-preset": "^9.0.3",
-    "@arethetypeswrong/cli": "^0.17.2",
-    "@babel/core": "^7.26.0",
-    "@rushstack/eslint-plugin-security": "^0.8.3",
-    "@secretlint/secretlint-rule-preset-recommend": "^9.0.0",
-    "@total-typescript/ts-reset": "^0.6.1",
-    "@types/node": "18.18.14",
-    "@visulima/packem": "1.10.7",
-    "@vitest/coverage-v8": "^2.1.8",
-    "@vitest/ui": "^2.1.8",
-    "conventional-changelog-conventionalcommits": "8.0.0",
-    "cross-env": "^7.0.3",
-    "esbuild": "0.24.2",
-    "eslint": "8.57.0",
-    "eslint-plugin-deprecation": "^3.0.0",
-    "eslint-plugin-etc": "^2.0.3",
-    "eslint-plugin-import": "npm:eslint-plugin-i@^2.29.1",
-    "eslint-plugin-mdx": "^3.1.5",
-    "eslint-plugin-vitest": "^0.4.1",
-    "eslint-plugin-vitest-globals": "^1.5.0",
-    "execa": "^9.5.2",
-    "prettier": "^3.4.2",
-    "rimraf": "6.0.1",
-    "secretlint": "9.0.0",
-    "semantic-release": "^24.2.1",
-    "tempy": "^3.1.0",
-    "type-fest": "^4.32.0",
-    "typedoc": "0.27.6",
-    "typedoc-plugin-markdown": "4.4.1",
-    "typedoc-plugin-rename-defaults": "0.7.2",
-    "typescript": "5.7.3",
-    "vitest": "^2.1.8"
-  },
   "engines": {
     "node": ">=18.* <=23.*"
   },
   "publishConfig": {
     "access": "public",
     "provenance": true
-  },
-  "anolilab": {
-    "eslint-config": {
-      "plugin": {
-        "tsdoc": false,
-        "etc": false
-      },
-      "warn_on_unsupported_typescript_version": false,
-      "info_on_disabling_jsx_react_rule": false,
-      "info_on_disabling_prettier_conflict_rule": false,
-      "info_on_disabling_jsonc_sort_keys_rule": false,
-      "info_on_disabling_etc_no_deprecated": false
-    }
-  },
-  "scripts": {
-    "build": "cross-env NODE_ENV=development packem build",
-    "build:prod": "cross-env NODE_ENV=production packem build",
-    "clean": "rimraf node_modules dist .eslintcache",
-    "dev": "pnpm run build --watch",
-    "lint:attw": "attw --pack",
-    "lint:eslint": "eslint . --ext js,cjs,mjs,jsx,ts,tsx,json,yaml,yml,md,mdx --max-warnings=0 --config .eslintrc.cjs",
-    "lint:eslint:fix": "eslint . --ext js,cjs,mjs,jsx,ts,tsx,json,yaml,yml,md,mdx --max-warnings=0 --config .eslintrc.cjs --fix",
-    "lint:package-json": "publint --strict",
-    "lint:prettier": "prettier --config=.prettierrc.cjs --check .",
-    "lint:prettier:fix": "prettier --config=.prettierrc.cjs --write .",
-    "lint:types": "tsc --noEmit",
-    "test": "vitest run",
-    "test:coverage": "vitest run --coverage",
-    "test:ui": "vitest --ui --coverage.enabled=true",
-    "test:watch": "vitest"
   }
 }