add prettier and eslint

Author: phamquyetthang

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

eslint.config.mjs

@@ -0,0 +1,10 @@
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+export default [
+  { files: ['**/*.{js,mjs,cjs,ts}'] },
+  { languageOptions: { globals: globals.browser } },
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+];

package.json

@@ -1,12 +1,13 @@
 {
   "name": "ts-nester",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "A TypeScript utility for converting nested JSON objects into TypeScript interfaces, optimized for i18n applications.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc"
+    "build": "tsc",
+    "prepare": "husky"
   },
   "repository": {
     "type": "git",
@@ -27,9 +28,20 @@
   },
   "homepage": "https://github.com/phamquyetthang/ts-nester#readme",
   "devDependencies": {
-    "typescript": "^5.4.5"
+    "@eslint/js": "^9.6.0",
+    "eslint": "9.x",
+    "globals": "^15.8.0",
+    "husky": "^9.0.11",
+    "lint-staged": "^15.2.7",
+    "prettier": "3.3.2",
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^7.16.0"
   },
   "dependencies": {
     "@types/node": "^20.14.2"
+  },
+  "lint-staged": {
+    "**/*": "prettier --write --ignore-unknown",
+    "**/*.{ts}": "eslint --cache --cache-location ./node_modules/.cache/eslint --fix ."
   }
 }

utils/FlattenedTypePaths.ts

@@ -1,4 +1,4 @@
-import { DotNestedKeys } from "./dotNestedKey";
+import { DotNestedKeys } from './dotNestedKey';
 
 /**
  * Generates a flattened representation of an object's type structure, mapping each nested path to its corresponding value type.
@@ -24,7 +24,6 @@ export type FlattenedTypePaths<T> = {
     : never;
 };
 
-
 /**
  * Recursively generates a flattened representation of an object's type structure, mapping each nested path to its corresponding value type up to a specified depth.
  * This utility type iterates over each key in the object, and for objects at each level, it recursively applies itself to flatten the structure.
@@ -46,17 +45,18 @@ export type FlattenedTypePaths<T> = {
  *     }
  *   }
  * };
- * 
+ *
  * // Flatten up to depth 2
  * type ResultDepth2 = DeepFlattenedTypePaths<typeof example, 2>;
  * // Expected type: { 'b.c': number, 'b.d': number, 'b.e': { f: number, g: { k: number, l: string } } }
- * 
+ *
  * // Flatten up to depth 3
  * type ResultDepth3 = DeepFlattenedTypePaths<typeof example, 3>;
  * // Expected type: { 'b.c': number, 'b.d': number, 'b.e.f': number, 'b.e.g.k': number, 'b.e.g.l': string }
  */
 export type DeepFlattenedTypePaths<T, Depth extends number> = Depth extends 0
-  ? {}
+  ? // eslint-disable-next-line @typescript-eslint/ban-types
+    {}
   : {
       [K in keyof T]: T[K] extends object
         ? {
@@ -74,26 +74,28 @@ export type DeepFlattenedTypePaths<T, Depth extends number> = Depth extends 0
         ? {
             [K in keyof T]: T[K];
           }
-        : {});
+        : // eslint-disable-next-line @typescript-eslint/ban-types
+          {});
 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 type Subtract<N extends number, M extends number> = N extends 1
   ? 0
   : N extends 2
-  ? 1
-  : N extends 3
-  ? 2
-  : N extends 4
-  ? 3
-  : N extends 5
-  ? 4
-  : N extends 6
-  ? 5
-  : N extends 7
-  ? 6
-  : N extends 8
-  ? 7
-  : N extends 9
-  ? 8
-  : N extends 10
-  ? 9
-  : never;
+    ? 1
+    : N extends 3
+      ? 2
+      : N extends 4
+        ? 3
+        : N extends 5
+          ? 4
+          : N extends 6
+            ? 5
+            : N extends 7
+              ? 6
+              : N extends 8
+                ? 7
+                : N extends 9
+                  ? 8
+                  : N extends 10
+                    ? 9
+                    : never;

utils/childType.ts

@@ -17,9 +17,9 @@
  * type BarItem = ChildItemType<Obj, "bar"> // { baz: number }
  * type BazItem = ChildItemType<Obj, "baz"> // { id: number, name: string }
  */
-export type ChildItemType<T, key extends keyof T> = T[key] extends Array<any> ? T[key][number] : T[key];
-
-
+export type ChildItemType<T, key extends keyof T> =
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  T[key] extends Array<any> ? T[key][number] : T[key];
 
 /**
  * The type of the child.
@@ -38,4 +38,3 @@ export type ChildItemType<T, key extends keyof T> = T[key] extends Array<any> ?
  * type BarItem = ChildType<Obj, "bar"> // { baz: number }
  */
 export type ChildType<T, key extends keyof T> = T[key];
-