Merge pull request #169 from neaps/prettier

bkeepers · web-flow · commit 83d00e367c83 · 2025-12-14T08:35:08.000-05:00
Add prettier, update eslint
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,12 +1,12 @@
 version: 2
 updates:
-  - package-ecosystem: "npm"
-    directory: "/"
+  - package-ecosystem: 'npm'
+    directory: '/'
     schedule:
-      interval: "weekly"
+      interval: 'weekly'
     open-pull-requests-limit: 100
-  - package-ecosystem: "github-actions"
-    directory: "/"
+  - package-ecosystem: 'github-actions'
+    directory: '/'
     schedule:
-      interval: "weekly"
+      interval: 'weekly'
     open-pull-requests-limit: 100
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,3 @@
+node_modules
+dist
+.test-cache
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1,3 @@
+{
+  "printWidth": 100
+}
diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,12 @@
+import eslint from '@eslint/js'
+import tseslint from 'typescript-eslint'
+import prettier from 'eslint-config-prettier'
+
+export default [
+  { ignores: ['dist/', 'node_modules/'] },
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  prettier,
+  { files: ['**/*.ts'], languageOptions: { parser: tseslint.parser } },
+  { files: ['**/*.js'] }
+]
diff --git a/index.html b/index.html
@@ -1,57 +1,54 @@
-<!DOCTYPE html>
+<!doctype html>
 <html>
+  <head>
+    <title>Tide Predictor in the browser</title>
+    <link
+      rel="stylesheet"
+      href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css"
+    />
+  </head>
 
-<head>
-  <title>Tide Predictor in the browser</title>
-  <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" />
-</head>
+  <body>
+    <div class="container">
+      <h1>High/low tides for Monterey, CA</h1>
+      <table class="table">
+        <thead>
+          <tr>
+            <th>Time</th>
+            <th>High/Low</th>
+            <th>Level (meters)</th>
+          </tr>
+        </thead>
+        <tbody id="tides"></tbody>
+      </table>
+    </div>
 
-<body>
-  <div class="container">
-    <h1>High/low tides for Monterey, CA</h1>
-    <table class="table">
-      <thead>
-        <tr>
-          <th>Time</th>
-          <th>High/Low</th>
-          <th>Level (meters)</th>
-        </tr>
-      <tbody id="tides"></tbody>
-      </thead>
-    </table>
-  </div>
-
-  <script type="module">
-    import tidePredictor from './src/index.js'
-
-    (() => {
-      fetch('https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/9413450/harcon.json?units=metric')
-        .then(response => {
+    <script type="module">
+      import tidePredictor from './src/index.js'
+      fetch(
+        'https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/9413450/harcon.json?units=metric'
+      )
+        .then((response) => {
           return response.json()
         })
-        .then(harmonics => {
+        .then((harmonics) => {
           const start = new Date()
-          const end = new Date(start.getTime() + (10 * 24 * 60 * 60 * 1000))
+          const end = new Date(start.getTime() + 10 * 24 * 60 * 60 * 1000)
 
-          const highLow = tidePredictor(harmonics.HarmonicConstituents).getExtremesPrediction({ start, end })
+          const highLow = tidePredictor(
+            harmonics.HarmonicConstituents
+          ).getExtremesPrediction({ start, end })
 
-          highLow.forEach(level => {
+          highLow.forEach((level) => {
             const tableRow = document.createElement('tr')
             tableRow.innerHTML = `
-              <td>${level
-                .time}</td>
-              <td>${level
-                .label}</td>
-              <td>${level
-                .level}</td>
+              <td>${level.time}</td>
+              <td>${level.label}</td>
+              <td>${level.level}</td>
             `
-            document
-              .getElementById('tides')
-              .appendChild(tableRow)
+            document.getElementById('tides').appendChild(tableRow)
           })
         })
-    })()
-  </script>
-</body>
-
+    </script>
+  </body>
 </html>
diff --git a/package.json b/package.json
@@ -18,13 +18,15 @@
     "dist"
   ],
   "devDependencies": {
+    "@eslint/js": "^9.39.2",
     "@types/node": "^20.10.6",
-    "@typescript-eslint/eslint-plugin": "^7.0.0",
-    "@typescript-eslint/parser": "^7.0.0",
     "@vitest/coverage-v8": "^3.0.0",
-    "eslint": "^8.18.0",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
     "npm-run-all": "^4.1.5",
+    "prettier": "^3.7.4",
     "typescript": "^5.3.3",
+    "typescript-eslint": "^8.49.0",
     "vite": "^7.2.7",
     "vite-plugin-dts": "^4.5.4",
     "vitest": "^3.0.0"
@@ -33,7 +35,8 @@
     "dev": "vite",
     "build": "vite build",
     "test": "vitest",
-    "lint": "eslint ./src --ext .ts,.tsx,.js",
+    "lint": "eslint && prettier --check .",
+    "format": "prettier --write .",
     "coverage": "vitest run --coverage",
     "ci": "run-s lint build coverage",
     "prepare": "npm run build"
diff --git a/src/astronomy/index.ts b/src/astronomy/index.ts
@@ -146,7 +146,10 @@ const modulus = (a: number, b: number): number => {
 }
 
 const astro = (time: Date): AstroData => {
-  const result: Partial<AstroData> = {}
+  // This gets cast to `AstroData` later, but we build it up step by step here
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const result: any = {}
+
   const polynomials: Record<string, number[]> = {
     s: coefficients.lunarLongitude,
     h: coefficients.solarLongitude,
@@ -161,12 +164,12 @@ const astro = (time: Date): AstroData => {
   // Polynomials are in T, that is Julian Centuries; we want our speeds to be
   // in the more convenient unit of degrees per hour.
   const dTdHour = 1 / (24 * 365.25 * 100)
-  Object.keys(polynomials).forEach((name) => {
-    ;(result as any)[name] = {
+  for (const name in polynomials) {
+    result[name] = {
       value: modulus(polynomial(polynomials[name], T(time)), 360.0),
       speed: derivativePolynomial(polynomials[name], T(time)) * dTdHour
     }
-  })
+  }
 
   // Some other parameters defined by Schureman which are dependent on the
   // parameters N, i, omega for use in node factor calculations. We don't need
@@ -183,13 +186,9 @@ const astro = (time: Date): AstroData => {
   }
   Object.keys(functions).forEach((name) => {
     const functionCall = functions[name]
-    ;(result as any)[name] = {
+    result[name] = {
       value: modulus(
-        functionCall(
-          (result as any).N.value,
-          (result as any).i.value,
-          (result as any).omega.value
-        ),
+        functionCall(result.N.value, result.i.value, result.omega.value),
         360.0
       ),
       speed: null
@@ -204,16 +203,16 @@ const astro = (time: Date): AstroData => {
     speed: 15.0
   }
 
-  ;(result as any)['T+h-s'] = {
-    value: hour.value + (result as any).h.value - (result as any).s.value,
-    speed: hour.speed + (result as any).h.speed - (result as any).s.speed
+  result['T+h-s'] = {
+    value: hour.value + result.h.value - result.s.value,
+    speed: hour.speed + result.h.speed - result.s.speed
   }
 
   // It is convenient to calculate Schureman's P here since several node
   // factors need it, although it could be argued that these
   // (along with I, xi, nu etc) belong somewhere else.
-  ;(result as any).P = {
-    value: (result as any).p.value - ((result as any).xi.value % 360.0),
+  result.P = {
+    value: result.p.value - (result.xi.value % 360.0),
     speed: null
   }
 
diff --git a/src/harmonics/index.ts b/src/harmonics/index.ts
@@ -1,13 +1,13 @@
 import prediction from './prediction.js'
 import constituentModels from '../constituents/index.js'
 import { d2r } from '../astronomy/constants.js'
-import type { Prediction } from './prediction.js'
+import type {
+  HarmonicConstituent,
+  InternalHarmonicConstituent,
+  Prediction
+} from './prediction.js'
 
-export interface HarmonicConstituent {
-  name: string
-  amplitude?: number
-  [key: string]: any
-}
+export type * from './prediction.js'
 
 export interface HarmonicsOptions {
   harmonicConstituents: HarmonicConstituent[]
@@ -60,15 +60,17 @@ const harmonicsFactory = ({
   if (!Array.isArray(harmonicConstituents)) {
     throw new Error('Harmonic constituents are not an array')
   }
-  const constituents: any[] = []
+  const constituents: InternalHarmonicConstituent[] = []
   harmonicConstituents.forEach((constituent) => {
     if (typeof constituent.name === 'undefined') {
       throw new Error('Harmonic constituents must have a name property')
     }
-    if (typeof constituentModels[constituent.name] !== 'undefined') {
-      constituent._model = constituentModels[constituent.name]
-      constituent._phase = d2r * constituent[phaseKey]
-      constituents.push(constituent)
+    if (constituentModels[constituent.name] !== undefined) {
+      constituents.push({
+        ...constituent,
+        _model: constituentModels[constituent.name],
+        _phase: d2r * constituent[phaseKey]
+      })
     }
   })
 
diff --git a/src/harmonics/prediction.ts b/src/harmonics/prediction.ts
@@ -11,9 +11,14 @@ export interface Timeline {
 export interface HarmonicConstituent {
   name: string
   amplitude: number
+  // This needs refactored to support generics with the `phaseKey` option
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [key: string]: any
+}
+
+export interface InternalHarmonicConstituent extends HarmonicConstituent {
   _phase: number
   _model: Constituent | CompoundConstituent
-  [key: string]: any
 }
 
 export interface TimelinePoint {
@@ -105,7 +110,7 @@ const getExtremeLabel = (
 
 interface PredictionFactoryParams {
   timeline: Timeline
-  constituents: HarmonicConstituent[]
+  constituents: InternalHarmonicConstituent[]
   start: Date
 }
 
diff --git a/src/node-corrections/index.ts b/src/node-corrections/index.ts
@@ -1,7 +1,10 @@
 import { d2r, r2d } from '../astronomy/constants.js'
 import type { AstroData } from '../astronomy/index.js'
 
-export type NodeCorrectionFunction = (a: AstroData, ...args: any[]) => number
+export type NodeCorrectionFunction = (
+  a: AstroData,
+  ...args: unknown[]
+) => number
 
 export interface NodeCorrections {
   fUnity: () => number
diff --git a/test/constituents/constituent.ts b/test/constituents/constituent.ts
@@ -23,7 +23,7 @@ const testConstituent = constituent('test', [1, 1, -1, 0, 0, 0, 1])
 describe('constituent', () => {
   it('it throws error if missing coefficients', () => {
     expect(() => {
-      // @ts-expect-error
+      // @ts-expect-error: Testing invalid input
       constituent('fail')
     }).toThrow('Coefficient must be defined for a constituent')
   })
diff --git a/test/harmonics/index.ts b/test/harmonics/index.ts
@@ -7,13 +7,15 @@ const endDate = new Date(1569966078 * 1000) // 2019-10-01
 
 describe('harmonics', () => {
   it('it checks constituents', () => {
+    // @ts-expect-error: Testing invalid input
     expect(() => harmonics({ harmonicConstituents: 'not array' })).toThrow(
       'Harmonic constituents are not an array'
     )
 
     expect(() => {
       harmonics({
         harmonicConstituents: [
+          // @ts-expect-error: Testing invalid input
           {
             description: 'Missing name property',
             amplitude: 0.43,
@@ -26,6 +28,8 @@ describe('harmonics', () => {
 
     expect(() => {
       harmonics({
+        phaseKey: 'phase_GMT',
+        offset: 0,
         harmonicConstituents: [
           {
             name: 'not a name',
@@ -49,9 +53,12 @@ describe('harmonics', () => {
 
   it('it checks start and end times', () => {
     const testHarmonics = harmonics({
+      phaseKey: 'phase_GMT',
+      offset: 0,
       harmonicConstituents: mockHarmonicConstituents
     })
     expect(() => {
+      // @ts-expect-error: Testing invalid input
       testHarmonics.setTimeSpan('lkjsdlf', 'sdfklj')
     }).toThrow('Invalid date format, should be a Date object, or timestamp')
 
diff --git a/test/index.ts b/test/index.ts
@@ -26,14 +26,14 @@ describe('Tidal station', () => {
 
     try {
       tidePrediction(mockConstituents)
-    } catch (e) {
+    } catch {
       stationCreated = false
     }
     expect(stationCreated).toBe(true)
 
     try {
       tidePrediction(mockConstituents)
-    } catch (e) {
+    } catch {
       stationCreated = false
     }
     expect(stationCreated).toBe(true)
diff --git a/test/noaa.ts b/test/noaa.ts
diff --git a/test/node-corrections/index.ts b/test/node-corrections/index.ts
diff --git a/tsconfig.json b/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+node_modules`
	`2`	`+dist`
	`3`	`+.test-cache`