chore: improved project setup

Author: alessiofrittoli

.env.test

@@ -0,0 +1 @@
+VAR_LOADED=true

.gitignore

@@ -2,4 +2,5 @@
 /node_modules
 
 .env.*
+!.env.test
 .DS_Store

.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+	"configurations": [
+		{
+			"type": "node",
+			"name": "Debug Tests",
+			"request": "launch",
+			"args": [
+				"test",
+				"--",
+				"--runInBand",
+				"--watchAll=false",
+				"--testNamePattern",
+				"${jest.testNamePattern}",
+				"--runTestsByPath",
+				"${jest.testFile}"
+			],
+			"console": "integratedTerminal",
+			"internalConsoleOptions": "neverOpen",
+			"disableOptimisticBPs": true,
+			"runtimeExecutable": "pnpm"
+		}
+	]
+}

.vscode/settings.json

@@ -6,5 +6,6 @@
 		"statusBar.background": "#212121",
 		"statusBar.border":"#C637CB",
 		"statusBar.foreground": "#F0F0F0",
+		"activityBar.activeBorder": "#C637CB",
 	},
 }

__tests__/jest.test.ts

@@ -0,0 +1,14 @@
+describe( 'Jest', () => {
+
+	it( 'loads .env files correctly', () => {
+		// Arrange ...
+		const envVar = process.env.VAR_LOADED
+
+		// Act ...
+		const isLoaded = envVar === 'true'
+
+		// Assert ...
+		expect( isLoaded ).toBe( true )
+	} )
+
+} )

type-utils.d.ts renamed to alessiofrittoli-env.d.ts

@@ -1,16 +1,22 @@
+import type { JestConfigWithTsJest } from 'ts-jest'
+import dotenv from 'dotenv'
+
 const env = process.env.NODE_ENV
 
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-require( 'dotenv' )
-	.config( { path: [ `.env.${ env }`, '.env.local', '.env' ] } )
+dotenv.config( { path: [
+	`.env.${ env }.local`,
+	`.env.${ env }`,
+	'.env.local',
+	'.env'
+] } )
 
 
 /**
  * Initial file generated with `npx ts-jest config:init`
  * 
- * @type {import('ts-jest').JestConfigWithTsJest}
  */
-module.exports = {
+const config: JestConfigWithTsJest = {
+	/** https://jestjs.io/docs/configuration#testenvironment-string */
 	testEnvironment: 'node',
 	moduleDirectories: [ 'node_modules', '<rootDir>/' ],
 	/**
@@ -24,4 +30,6 @@ module.exports = {
 	transform: {
 		'^.+.tsx?$': [ 'ts-jest', {} ],
 	},
-}
+}
+
+export default config

jest.config.js renamed to jest.config.ts

@@ -31,6 +31,7 @@
 	],
 	"exports": {
 		".": {
+			"types": "./dist/index.d.ts",
 			"import": "./dist/index.mjs",
 			"require": "./dist/index.js"
 		},
@@ -77,31 +78,41 @@
 	},
 	"sideEffects": false,
 	"scripts": {
-		"build": "eslint && jest --ci --verbose && tsup",
+		"build": "pnpm lint && pnpm test:ci && tsup",
+		"build:watch": "tsup --watch",
+		"release": "node scripts/publish.js --verbose",
 		"lint": "eslint",
-		"test": "jest --watchAll --verbose",
+		"test:watch": "jest --watchAll --verbose",
 		"test:ci": "jest --ci --verbose",
+		"test:coverage": "pnpm test:watch --coverage",
+		"test:ci:coverage": "pnpm test:ci --coverage",
+		"test:serve-coverage": "http-server ./coverage/lcov-report --gzip true -p 0 -o --silent",
+		"test:coverage:serve": "concurrently --prefix none --kill-others \"pnpm test:coverage\" \"pnpm test:serve-coverage\"",
+		"test:jest": "pnpm test:watch jest.test.ts",
 		"test:common": "pnpm test common.test.ts",
 		"test:format": "pnpm test format.test.ts",
 		"test:timezones": "pnpm test timezones.test.ts",
 		"test:utils": "pnpm test utils.test.ts"
 	},
 	"devDependencies": {
-		"@eslint/js": "^9.16.0",
+		"@eslint/js": "^9.17.0",
 		"@jest/globals": "^29.7.0",
 		"@types/jest": "^29.5.14",
-		"@types/node": "^22.10.1",
-		"dotenv": "^16.4.5",
-		"eslint": "^9.16.0",
-		"globals": "^15.12.0",
+		"@types/node": "^22.10.2",
+		"concurrently": "^9.1.0",
+		"dotenv": "^16.4.7",
+		"eslint": "^9.17.0",
+		"globals": "^15.14.0",
+		"http-server": "^14.1.1",
 		"jest": "^29.7.0",
 		"ts-jest": "^29.2.5",
+		"ts-node": "^10.9.2",
 		"tsup": "^8.3.5",
 		"typescript": "^5.7.2",
-		"typescript-eslint": "^8.16.0"
+		"typescript-eslint": "^8.18.2"
 	},
 	"dependencies": {
-		"@alessiofrittoli/math-utils": "^0.3.0",
-		"@alessiofrittoli/type-utils": "^0.3.0"
+		"@alessiofrittoli/math-utils": "^1.2.0",
+		"@alessiofrittoli/type-utils": "^1.4.0"
 	}
 }