@alessiofrittoli/type-utils 0.1.0 → 0.1.2

package/README.md

@@ -1,6 +1,6 @@
 # Type Utils ❇️
 
-Version 0.1.0
+Version 0.1.2
 
 ## Lightweight TypeScript types utilities
 
@@ -55,6 +55,12 @@ Please make sure to add it in the array of the "include" property in your `tscon
 
 You can skip this process if `*.ts` is already in your "include" array.
 
+⚠️ If the `type-utils.d.ts` file creation fails you run the following command to manually execute the script:
+
+```bash
+node node_modules/@alessiofrittoli/type-utils/scripts/postinstall/index.js
+```
+
 ---
 
 ### [ESLint](https://www.npmjs.com/package/eslint)

package/dist/index.d.mts

@@ -20,22 +20,16 @@ declare global {
     /**
      * Get the Type of the Value of object/array specific property.
      */
-    type ValueOf2<T, P extends keyof T> = T[P];
+    type ValueOfKey<T, P extends keyof T> = T[P];
     /**
-     * Make a specific property Optional.
+     * Make a specific property optional.
      */
-    type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
-    /**
-     * Make read-only properties of an object writeable.
-     */
-    type Writeable<T> = {
-        -readonly [P in keyof T]: T[P];
-    };
+    type OptionalKey<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
     /**
      * Make read-only properties of an object recursively writeable.
      */
-    type DeepWriteable<T> = {
-        -readonly [P in keyof T]: DeepWriteable<T[P]>;
+    type Writeable<T> = {
+        -readonly [P in keyof T]: Writeable<T[P]>;
     };
     /**
      * Renames a property while inheriting its type.

package/dist/index.d.ts

@@ -20,22 +20,16 @@ declare global {
     /**
      * Get the Type of the Value of object/array specific property.
      */
-    type ValueOf2<T, P extends keyof T> = T[P];
+    type ValueOfKey<T, P extends keyof T> = T[P];
     /**
-     * Make a specific property Optional.
+     * Make a specific property optional.
      */
-    type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
-    /**
-     * Make read-only properties of an object writeable.
-     */
-    type Writeable<T> = {
-        -readonly [P in keyof T]: T[P];
-    };
+    type OptionalKey<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
     /**
      * Make read-only properties of an object recursively writeable.
      */
-    type DeepWriteable<T> = {
-        -readonly [P in keyof T]: DeepWriteable<T[P]>;
+    type Writeable<T> = {
+        -readonly [P in keyof T]: Writeable<T[P]>;
     };
     /**
      * Renames a property while inheriting its type.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@alessiofrittoli/type-utils",
-	"version": "0.1.0",
+	"version": "0.1.2",
 	"description": "Lightweight TypeScript types utilities",
 	"author": {
 		"name": "Alessio Frittoli",
@@ -23,7 +23,7 @@
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
 	"files": [
-		"dist"
+		"dist", "scripts"
 	],
 	"scripts": {
 		"build": "eslint && tsup",

package/scripts/postinstall/index.js

@@ -0,0 +1,12 @@
+const tsSetup = require( './ts-setup.js' )
+
+/** @type {(() => void | Promise<void>)[]} */
+const scripts = [ tsSetup ]
+
+const executePostInstall = async () => {
+	await Promise.all( scripts.map( async script => {
+		await script()
+	} ) )
+}
+
+executePostInstall()

package/scripts/postinstall/ts-setup.js

@@ -0,0 +1,33 @@
+const fs		= require( 'fs' )
+const path		= require( 'path' )
+const project	= require( '../../package.json' )
+
+
+const tsSetup = () => {
+
+	const projectRoot = process.env.INIT_CWD || process.cwd()
+
+	if ( ! projectRoot || projectRoot.endsWith( project.name ) ) {
+		console.error( 'INIT_CWD is not set. This script must be run during pnpm install.' )
+		process.exit( 1 )
+	}
+
+	const tsconfigPath = path.resolve( projectRoot, 'type-utils.d.ts' )
+
+	const data = [
+		`/// <reference types="${ project.name }" />`,
+		'// NOTE: This file should not be edited'
+	].join( '\n\n' )
+
+	try {
+		fs.writeFileSync( tsconfigPath, data )
+		console.log( '"type-utils.d.ts" has been created at the root of your project.' )
+		console.log( 'Please update your tsconfig.json to add this file in your "include" property of your tsconfig.json file.' )
+	} catch ( error ) {
+		console.error( 'An error occured while creating "type-utils.d.ts" at the root of your project. Some global types may not working as expect.', error )
+		process.exit( 1 )
+	}
+
+}
+
+module.exports = tsSetup