mirror of
https://github.com/kjanat/livedash-node.git
synced 2026-01-16 13:52:16 +01:00
feat: complete development environment setup and code quality improvements
- Set up pre-commit hooks with husky and lint-staged for automated code quality - Improved TypeScript type safety by replacing 'any' types with proper generics - Fixed markdown linting violations (MD030 spacing) across all documentation - Fixed compound adjective hyphenation in technical documentation - Fixed invalid JSON union syntax in API documentation examples - Automated code formatting and linting on commit - Enhanced error handling with better type constraints - Configured biome and markdownlint for consistent code style - All changes verified with successful production build
This commit is contained in:
@ -5,9 +5,11 @@ This document outlines the fixes applied to resolve TypeScript compilation error
|
||||
## Issues Resolved
|
||||
|
||||
### 1. Missing Type Imports
|
||||
|
||||
**Problem:** `lib/api/index.ts` was missing required type imports
|
||||
**Error:** `Cannot find name 'APIHandler'`, `Cannot find name 'Permission'`
|
||||
**Fix:** Added proper imports at the top of the file
|
||||
|
||||
```typescript
|
||||
import type { APIContext, APIHandler, APIHandlerOptions } from "./handler";
|
||||
import { createAPIHandler } from "./handler";
|
||||
@ -15,9 +17,11 @@ import { Permission, createPermissionChecker } from "./authorization";
|
||||
```
|
||||
|
||||
### 2. Zod API Breaking Change
|
||||
|
||||
**Problem:** Zod error property name changed from `errors` to `issues`
|
||||
**Error:** `Property 'errors' does not exist on type 'ZodError'`
|
||||
**Fix:** Updated all references to use `error.issues` instead of `error.errors`
|
||||
|
||||
```typescript
|
||||
// Before
|
||||
error.errors.map((e) => `${e.path.join(".")}: ${e.message}`)
|
||||
@ -26,17 +30,21 @@ error.issues.map((e) => `${e.path.join(".")}: ${e.message}`)
|
||||
```
|
||||
|
||||
### 3. Missing LRU Cache Dependency
|
||||
|
||||
**Problem:** `lru-cache` package was missing from dependencies
|
||||
**Error:** `Cannot find module 'lru-cache'`
|
||||
**Fix:** Installed the missing dependency
|
||||
|
||||
```bash
|
||||
pnpm add lru-cache
|
||||
```
|
||||
|
||||
### 4. LRU Cache Generic Type Constraints
|
||||
|
||||
**Problem:** TypeScript generic constraints not satisfied
|
||||
**Error:** `Type 'K' does not satisfy the constraint '{}'`
|
||||
**Fix:** Added proper generic type constraints
|
||||
|
||||
```typescript
|
||||
// Before
|
||||
<K = string, V = any>
|
||||
@ -45,9 +53,11 @@ pnpm add lru-cache
|
||||
```
|
||||
|
||||
### 5. Map Iteration ES5 Compatibility
|
||||
|
||||
**Problem:** Map iteration requires downlevel iteration flag
|
||||
**Error:** `can only be iterated through when using the '--downlevelIteration' flag`
|
||||
**Fix:** Used `Array.from()` pattern for compatibility
|
||||
|
||||
```typescript
|
||||
// Before
|
||||
for (const [key, value] of map) { ... }
|
||||
@ -56,9 +66,11 @@ for (const [key, value] of Array.from(map.entries())) { ... }
|
||||
```
|
||||
|
||||
### 6. Redis Configuration Issues
|
||||
|
||||
**Problem:** Invalid Redis socket options
|
||||
**Error:** Redis connection failed with unsupported options
|
||||
**Fix:** Simplified Redis configuration to only include supported options
|
||||
|
||||
```typescript
|
||||
this.client = createClient({
|
||||
url: env.REDIS_URL,
|
||||
@ -69,9 +81,11 @@ this.client = createClient({
|
||||
```
|
||||
|
||||
### 7. Prisma Relationship Naming Mismatches
|
||||
|
||||
**Problem:** Code referenced non-existent Prisma relationships
|
||||
**Error:** `securityAuditLogs` and `sessionImport` don't exist
|
||||
**Fix:** Used correct relationship names
|
||||
|
||||
```typescript
|
||||
// Before
|
||||
user.securityAuditLogs
|
||||
@ -82,17 +96,21 @@ session.import
|
||||
```
|
||||
|
||||
### 8. Missing Schema Fields
|
||||
|
||||
**Problem:** Code referenced fields that don't exist in the database schema
|
||||
**Error:** `Property 'userId' does not exist on type`
|
||||
**Fix:** Applied type casting where schema fields were missing
|
||||
|
||||
```typescript
|
||||
userId: (session as any).userId || null
|
||||
```
|
||||
|
||||
### 9. Deprecated Package Dependencies
|
||||
|
||||
**Problem:** `critters` package is deprecated and caused build failures
|
||||
**Error:** `Cannot find module 'critters'`
|
||||
**Fix:** Disabled CSS optimization feature that required critters
|
||||
|
||||
```javascript
|
||||
experimental: {
|
||||
optimizeCss: false, // Disabled due to critters dependency
|
||||
@ -100,9 +118,11 @@ experimental: {
|
||||
```
|
||||
|
||||
### 10. ESLint vs Biome Conflict
|
||||
|
||||
**Problem:** ESLint warnings treated as build errors
|
||||
**Error:** Build failed due to linting warnings
|
||||
**Fix:** Disabled ESLint during build since Biome is used for linting
|
||||
|
||||
```javascript
|
||||
eslint: {
|
||||
ignoreDuringBuilds: true,
|
||||
@ -112,6 +132,7 @@ eslint: {
|
||||
## Schema Enhancements
|
||||
|
||||
### Enhanced User Management
|
||||
|
||||
Added comprehensive user management fields to the User model:
|
||||
|
||||
```prisma
|
||||
@ -137,38 +158,45 @@ model User {
|
||||
```
|
||||
|
||||
### Updated Repository Methods
|
||||
|
||||
Enhanced UserRepository with new methods:
|
||||
- `updateLastLogin()` - Tracks user login times
|
||||
- `incrementFailedLoginAttempts()` - Security feature for account locking
|
||||
- `verifyEmail()` - Email verification management
|
||||
- `deactivateUser()` - Account management
|
||||
- `unlockUser()` - Security administration
|
||||
- `updatePreferences()` - User settings management
|
||||
- `findInactiveUsers()` - Now uses `lastLoginAt` instead of `createdAt`
|
||||
|
||||
- `updateLastLogin()` - Tracks user login times
|
||||
- `incrementFailedLoginAttempts()` - Security feature for account locking
|
||||
- `verifyEmail()` - Email verification management
|
||||
- `deactivateUser()` - Account management
|
||||
- `unlockUser()` - Security administration
|
||||
- `updatePreferences()` - User settings management
|
||||
- `findInactiveUsers()` - Now uses `lastLoginAt` instead of `createdAt`
|
||||
|
||||
## Prevention Measures
|
||||
|
||||
### 1. Regular Dependency Updates
|
||||
- Monitor for breaking changes in dependencies like Zod
|
||||
- Use `pnpm outdated` to check for deprecated packages
|
||||
- Test builds after dependency updates
|
||||
|
||||
- Monitor for breaking changes in dependencies like Zod
|
||||
- Use `pnpm outdated` to check for deprecated packages
|
||||
- Test builds after dependency updates
|
||||
|
||||
### 2. TypeScript Strict Checking
|
||||
- Enable strict TypeScript checking to catch type errors early
|
||||
- Use proper type imports and exports
|
||||
- Avoid `any` types where possible
|
||||
|
||||
- Enable strict TypeScript checking to catch type errors early
|
||||
- Use proper type imports and exports
|
||||
- Avoid `any` types where possible
|
||||
|
||||
### 3. Build Pipeline Validation
|
||||
- Run `pnpm build` before committing
|
||||
- Include type checking in CI/CD pipeline
|
||||
- Separate linting from build process
|
||||
|
||||
- Run `pnpm build` before committing
|
||||
- Include type checking in CI/CD pipeline
|
||||
- Separate linting from build process
|
||||
|
||||
### 4. Schema Management
|
||||
- Regenerate Prisma client after schema changes: `pnpm prisma:generate`
|
||||
- Validate schema changes with database migrations
|
||||
- Use proper TypeScript types for database operations
|
||||
|
||||
- Regenerate Prisma client after schema changes: `pnpm prisma:generate`
|
||||
- Validate schema changes with database migrations
|
||||
- Use proper TypeScript types for database operations
|
||||
|
||||
### 5. Development Workflow
|
||||
|
||||
```bash
|
||||
# Recommended development workflow
|
||||
pnpm prisma:generate # After schema changes
|
||||
@ -206,4 +234,4 @@ pnpm install
|
||||
---
|
||||
|
||||
*Last updated: 2025-07-12*
|
||||
*Build Status: ✅ Success (47/47 pages generated)*
|
||||
*Build Status: ✅ Success (47/47 pages generated)*
|
||||
|
||||
Reference in New Issue
Block a user