Merge pull request #24 from TextureHQ/chore/add-biome-ci-lint

chore: add Biome linting and wire into CI

Author: victorquinn

.github/workflows/ci.yml

@@ -24,38 +24,19 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: '20'
+          cache: 'yarn'
 
       - name: Install dependencies
-        run: npm install
+        run: yarn install --frozen-lockfile
 
-      - name: Run Code Climate Test Reporter before-build
-        env:
-          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
-        run: |
-          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-          chmod +x ./cc-test-reporter
-          ./cc-test-reporter before-build
+      - name: Run lint
+        run: yarn lint
 
       - name: Run tests with coverage
-        run: npm run coverage
+        run: yarn coverage
 
       - name: Upload coverage to CodeCov
         uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: coverage/lcov.info
-
-      - name: Format coverage report for Code Climate
-        env:
-          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
-        run: |
-          ./cc-test-reporter format-coverage coverage/lcov.info \
-            --input-type lcov \
-            --output coverage/codeclimate.json
-
-      - name: Upload coverage to Code Climate
-        env:
-          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
-        run: |
-          ./cc-test-reporter upload-coverage \
-            --input coverage/codeclimate.json

AGENTS.md

@@ -10,11 +10,12 @@
 - `yarn build:cjs` / `yarn build:esm` generate a single module target when you need faster iteration.
 - `yarn dev` watches the compiler (`tsc-watch`) and re-runs `node dist/index.js` after successful builds for local experimentation.
 - `yarn test` runs the Jest suite once; `yarn test:watch` keeps Jest hot during development; `yarn coverage` enforces coverage expectations and refreshes the `coverage/` report.
+- `yarn lint` runs Biome across the repo; fix any reported issues or explicitly suppress with justification.
 
 ## Coding Style & Naming Conventions
 - Write modern, strict TypeScript (see `tsconfig.json`: `strict: true`, ES6 modules). Prefer named exports, keeping default exports limited to top-level entry points (`WeatherPlus`).
 - Use two-space indentation, camelCase for functions/variables, PascalCase for classes/types, and SCREAMING_CASE for constants. Match existing file casing (e.g., `providerRegistry.ts`, `weatherService.ts`) to stay consistent.
-- Keep provider adapters cohesive: map external API responses to internal interfaces inside the provider module, and surface errors via the shared `errors` utilities.
+- Keep provider adapters cohesive: map external API responses to internal interfaces inside the provider module, and surface errors via the shared `errors` utilities. Biome (`biome.json`) enforces formatting, import order, and lint defaults—run it before committing changes.
 
 ## Testing Guidelines
 - Jest powers unit and integration tests; colocate new specs as `*.test.ts` alongside the module under test.

biome.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.7.3/schema.json",
+  "files": {
+    "ignore": ["dist", "coverage", "node_modules"]
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 100
+  },
+  "organizeImports": {
+    "enabled": true
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "style": {
+        "useImportType": "off"
+      }
+    }
+  }
+}

package.json

@@ -8,16 +8,18 @@
   "author": "Victor Quinn <mail@victorquinn.com>",
   "license": "MIT",
   "private": false,
+  "packageManager": "yarn@1.22.22",
   "scripts": {
     "build:cjs": "tsc --project tsconfig.cjs.json",
     "build:esm": "tsc --project tsconfig.esm.json",
-    "build": "npm run build:cjs && npm run build:esm",
+    "build": "yarn build:cjs && yarn build:esm",
     "dev": "tsc-watch --onSuccess 'node dist/index.js'",
     "test": "jest",
     "test:watch": "jest --watch",
     "prebuild": "rimraf ./dist",
-    "prepack": "npm run build",
-    "coverage": "jest --coverage"
+    "prepack": "yarn build",
+    "coverage": "jest --coverage",
+    "lint": "biome lint ."
   },
   "files": [
     "dist"
@@ -48,6 +50,7 @@
     "ts-jest": "^29.1.4",
     "ts-node": "^10.9.2",
     "tsc-watch": "^6.2.0",
-    "typescript": "^5.4.5"
+    "typescript": "^5.4.5",
+    "@biomejs/biome": "^1.7.3"
   }
 }

src/cache.test.ts

@@ -33,7 +33,8 @@ describe('Cache', () => {
     await cache.set(key, JSON.stringify(value), ttl);
     const result = await cache.get(key);
 
-    expect(JSON.parse(result!)).toEqual(value);
+    expect(result).not.toBeNull();
+    expect(JSON.parse(result as string)).toEqual(value);
     expect(mockRedisClient.set).toHaveBeenCalledWith(key, JSON.stringify(value), { EX: ttl });
     expect(mockRedisClient.get).toHaveBeenCalledWith(key);
   });
@@ -106,7 +107,8 @@ describe('Cache', () => {
       await cache.set(key, JSON.stringify(value), ttl);
       const result = await cache.get(key);
 
-      expect(JSON.parse(result!)).toEqual(value);
+      expect(result).not.toBeNull();
+      expect(JSON.parse(result as string)).toEqual(value);
     });
 
     it('should return null for nonexistent keys in memory cache', async () => {
@@ -219,8 +221,9 @@ describe('Cache', () => {
 
         // Assert
         expect(cachedData).not.toBeNull();
-        expect(JSON.parse(cachedData!)).toEqual(weatherData);
-        expect(JSON.parse(cachedData!).provider).toBe('nws'); // Verify provider name
+        const parsed = JSON.parse(cachedData as string);
+        expect(parsed).toEqual(weatherData);
+        expect(parsed.provider).toBe('nws'); // Verify provider name
     });
   });
-});
+});

src/cache.ts

@@ -26,23 +26,24 @@ export class Cache {
     if (this.cacheType === 'redis' && this.redisClient) {
       const val = await this.redisClient.get(key);
       return val === undefined ? null : val;
-    } else {
-      const item = this.memoryCache.get(key);
-      if (item && item.expiresAt > Date.now()) {
-        return item.value;
-      }
-      this.memoryCache.delete(key);
-      return null;
     }
+
+    const item = this.memoryCache.get(key);
+    if (item && item.expiresAt > Date.now()) {
+      return item.value;
+    }
+    this.memoryCache.delete(key);
+    return null;
   }
 
   async set(key: string, value: string, ttl?: number): Promise<void> {
     const expiresIn = ttl ?? this.defaultTTL;
     if (this.cacheType === 'redis' && this.redisClient) {
       await this.redisClient.set(key, value, { EX: expiresIn });
-    } else {
-      const expiresAt = Date.now() + expiresIn * 1000;
-      this.memoryCache.set(key, { value, expiresAt });
+      return;
     }
+
+    const expiresAt = Date.now() + expiresIn * 1000;
+    this.memoryCache.set(key, { value, expiresAt });
   }
 }

src/index.test.ts

@@ -21,12 +21,12 @@ jest.mock('redis', () => {
 
 describe('WeatherPlus Library', () => {
   let mock: MockAdapter;
-  let redisMock: any;
+  let redisMock: { mGet: jest.Mock; mSet: jest.Mock; createClient: jest.Mock };
 
   beforeAll(() => {
     // Use the same axios instance that your providers use
     mock = new MockAdapter(axios);
-    redisMock = require('redis');
+    redisMock = require('redis') as { mGet: jest.Mock; mSet: jest.Mock; createClient: jest.Mock };
   });
 
   afterAll(() => {
@@ -41,15 +41,15 @@ describe('WeatherPlus Library', () => {
   it('should throw an error if an unsupported provider is specified', () => {
     // Use type assertion to bypass TypeScript error for testing purposes
     const initUnsupportedProvider = () => {
-      new WeatherPlus({ providers: ['tomorrow.io' as any] });
+      new WeatherPlus({ providers: ['tomorrow.io'] });
     };
     expect(initUnsupportedProvider).toThrow('Provider tomorrow.io is not supported yet');
   });
 
   it('should throw an error if an unsupported provider is included in providers array', () => {
     // Use type assertion to bypass TypeScript error for testing purposes
     const initUnsupportedProvider = () => {
-      new WeatherPlus({ providers: ['nws', 'weatherkit' as any] });
+      new WeatherPlus({ providers: ['nws', 'weatherkit'] });
     };
     expect(initUnsupportedProvider).toThrow('Provider weatherkit is not supported yet');
   });
@@ -326,4 +326,4 @@ describe('WeatherPlus Library', () => {
     expect(error).toBeInstanceOf(Error);
     expect(error.message).toBe('Test error');
   });
-});
+});

src/index.ts

@@ -3,10 +3,11 @@ import { InvalidProviderLocationError, ProviderNotSupportedError, WeatherProvide
 import { RedisClientType } from 'redis';
 import { GetWeatherOptions } from './weatherService';
 import { IWeatherData } from './interfaces';
+import { ProviderId } from './providers/capabilities';
 
 // Define the options interface for WeatherPlus
 interface WeatherPlusOptions {
-  providers?: Array<'nws' | 'openweather'>; // Ordered list of providers for fallback
+  providers?: ProviderId[]; // Ordered list of providers for fallback
   apiKeys?: { [provider: string]: string };  // Mapping of provider names to their API keys
   redisClient?: RedisClientType;             // Optional Redis client for caching
   geohashPrecision?: number;                 // Optional geohash precision for caching
@@ -35,4 +36,4 @@ class WeatherPlus {
 
 export { WeatherService, GetWeatherOptions, InvalidProviderLocationError, ProviderNotSupportedError, WeatherProviderError };
 export * from './interfaces';
-export default WeatherPlus;
+export default WeatherPlus;

src/interfaces.ts

@@ -19,15 +19,17 @@ export enum IWeatherKey {
     sunset = 'sunset',
 }
 
-export interface IWeatherProviderWeatherData extends Record<IWeatherKey, IBaseWeatherProperty<any, any>> {
-    dewPoint: IDewPoint;
-    humidity: IRelativeHumidity;
-    temperature: ITemperature;
-    conditions: IConditions;
-    cloudiness: ICloudiness;
-    sunrise: ISunriseSunset;
-    sunset: ISunriseSunset;
-}
+export type WeatherProviderPropertyMap = {
+    [IWeatherKey.dewPoint]: IDewPoint;
+    [IWeatherKey.humidity]: IRelativeHumidity;
+    [IWeatherKey.temperature]: ITemperature;
+    [IWeatherKey.conditions]: IConditions;
+    [IWeatherKey.cloudiness]: ICloudiness;
+    [IWeatherKey.sunrise]: ISunriseSunset;
+    [IWeatherKey.sunset]: ISunriseSunset;
+};
+
+export type IWeatherProviderWeatherData = WeatherProviderPropertyMap;
 
 export interface IWeatherData extends Partial<IWeatherProviderWeatherData> {
     provider: string;
@@ -47,4 +49,4 @@ export type IConditions = IBaseWeatherProperty<string, IWeatherUnits.string> & {
 }
 export type ITemperature = IBaseWeatherProperty<number, IWeatherUnits.C | IWeatherUnits.F>;
 export type ICloudiness = IBaseWeatherProperty<number, IWeatherUnits.percent>;
-export type ISunriseSunset = IBaseWeatherProperty<string, IWeatherUnits.iso8601>;
+export type ISunriseSunset = IBaseWeatherProperty<string, IWeatherUnits.iso8601>;