ci: add oxlint, refactor code, add oxlint to github actions (#67)

strdr4605 · web-flow · commit e48cbb8ef034 · 2025-01-21T22:48:34.000+02:00
* ci: add oxlint, refactor code, add oxlint to github actions

* fix: yarn lint

* test: oxlint in CI

* Another fix for oxlint

* Final fix for oxlint
diff --git a/.github/workflows/pr-check.yml b/.github/workflows/pr-check.yml
@@ -6,27 +6,54 @@ on:
       - master
 
 jobs:
-  pr_check:
+  oxlint:
+    name: Lint JS
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
         with:
-          node-version: '16.x'
+          path: '**/node_modules'
+          key: ${{ runner.os }}-node-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - name: Install dependencies
+        run: yarn
 
-      - name: Setup Node
+      - name: Run Linter
+        run: yarn lint
+
+  pr_check:
+    name: Build and export
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
         uses: actions/setup-node@v2
         with:
           node-version: '16.x'
+          cache: 'yarn'
 
       - name: Cache dependencies
         uses: actions/cache@v2
         with:
-          node-version: '16.x'
           path: '**/node_modules'
           key: ${{ runner.os }}-node-${{ hashFiles('**/yarn.lock') }}
           restore-keys: |
             ${{ runner.os }}-node-
 
-      - run: yarn
-      - run: yarn build
-      - run: yarn export
+      - name: Install dependencies
+        run: yarn
+
+      - name: Build project
+        run: yarn build
+
+      - name: Export project
+        run: yarn export
+
diff --git a/.oxlintrc.json b/.oxlintrc.json
@@ -0,0 +1,13 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "plugins": [
+    "import",
+    "typescript",
+    "unicorn"
+  ],
+  "env": {
+    "browser": true
+  },
+  "settings": {},
+  "rules": {}
+}
diff --git a/models/TransferFeed.ts b/models/TransferFeed.ts
@@ -1,4 +1,4 @@
-import { Feed, SiteFeed } from "./SiteFeed";
+import { Feed } from "./SiteFeed";
 
 export interface TransferData {
   db: number;
diff --git a/package.json b/package.json
@@ -11,7 +11,8 @@
     "build": "next build",
     "export": "next export",
     "start": "next start",
-    "format": "prettier --write ."
+    "format": "prettier --write .",
+    "lint": "oxlint --deny-warnings"
   },
   "dependencies": {
     "favecon": "^1.0.2",
@@ -27,6 +28,7 @@
     "cssnano": "^5.1.14",
     "eslint": "8.12.0",
     "eslint-config-next": "12.1.1",
+    "oxlint": "^0.15.7",
     "postcss-nested": "^6.0.0",
     "postcss-sorting": "^8.0.1",
     "prettier": "^3.4.2",
diff --git a/pages/index.tsx b/pages/index.tsx
@@ -12,7 +12,7 @@ import {
   VisitedItemsList,
   FavoritePin,
 } from "../components";
-import { Feed, SiteFeed } from "../models";
+import { Feed } from "../models";
 import {
   deleteSiteFeed,
   getSiteFeed,
@@ -88,7 +88,7 @@ export default function Home() {
         }
 
         storage[feedUrl] = feedToUpdate;
-      } catch (_e) {
+      } catch {
         console.error(`Could not update feed for ${feedUrl}`);
       }
 
@@ -111,7 +111,7 @@ export default function Home() {
       let feed;
       try {
         feed = await rssParser.parseURL(feedUrl);
-      } catch (_e) {
+      } catch {
         errors.push(feedUrl);
       }
       if (feed && !(await getSiteFeed(feedUrl))) {
diff --git a/services/exportService.ts b/services/exportService.ts
@@ -1,5 +1,5 @@
 import { getSiteFeeds, insertSiteFeed } from "../services/indexeddbService";
-import { Feed, SiteFeed, TransferData, TransferFeed } from "../models";
+import { Feed, TransferData, TransferFeed } from "../models";
 import { databaseVersion } from "../constants";
 import { compress, decompress } from "./compressService";
 import { siteDomain } from "../constants";
@@ -89,13 +89,11 @@ export async function importFeedFromFile(jsonFromFile: string) {
 }
 
 function refactorExportToFeed(feed: TransferFeed): Feed {
-  const { domain, priority } = feed;
+  const { priority } = feed;
   const url = feed.url;
 
   const visited =
-    feed.visited?.reduce<Record<string, boolean>>((acc, path) => {
-      const link = domain + path;
-
+    feed.visited?.reduce<Record<string, boolean>>((acc) => {
       acc[feed.url] = true;
 
       return acc;
@@ -107,16 +105,14 @@ function refactorFeedToExport(feed: Feed): TransferFeed {
   const { url, priority } = feed;
 
   let domain: string = "";
-  let urlPath: string = "";
 
   // regex pattern to extract domain extensions as "com", "md", "org"
   const pattern = /(?<=\.).*?(?=\/)/;
   const domainExtension = pattern.exec(feed.url)?.[0];
 
   if (domainExtension) {
-    const [feedDomain, path] = url.split(`.${domainExtension}/`);
+    const [feedDomain] = url.split(`.${domainExtension}/`);
     domain = `${feedDomain}${domainExtension}/`;
-    urlPath = path;
   } else {
     domain = `${url}/`;
   }
diff --git a/services/indexeddbService.ts b/services/indexeddbService.ts
@@ -1,5 +1,5 @@
 import { databaseName, databaseVersion, SiteFeedTable } from "../constants";
-import { Feed, SiteFeed } from "../models";
+import { Feed } from "../models";
 import { deleteByName, getAll, getOne, insert, update } from "./indexeddbCRUD";
 import { executeMigrations } from "./migrations";
 
diff --git a/services/migrations/V1_init_database.ts b/services/migrations/V1_init_database.ts
@@ -1,5 +1,5 @@
 import { SiteFeedTable } from "../../constants";
-import { Feed, SiteFeed } from "../../models";
+import { Feed } from "../../models";
 import { createTable } from "../indexeddbCRUD";
 import { insertSiteFeed } from "../indexeddbService";
 
diff --git a/services/migrations/V2_migration.ts b/services/migrations/V2_migration.ts
@@ -1,4 +1,4 @@
-export async function V2_migration(db: IDBDatabase) {
+export async function V2_migration() {
   await new Promise((resolve) => setTimeout(resolve, 2000));
   console.log("Second Migration");
 }
diff --git a/services/migrations/V3_migration.ts b/services/migrations/V3_migration.ts
@@ -1,3 +1,3 @@
-export async function V3_migration(db: IDBDatabase) {
+export async function V3_migration() {
   console.log("Third Migration");
 }
diff --git a/services/migrations/index.ts b/services/migrations/index.ts
@@ -1,6 +1,6 @@
 import { V1_init_database } from "./V1_init_database";
-import { V2_migration } from "./V2_migration";
-import { V3_migration } from "./V3_migration";
+// import { V2_migration } from "./V2_migration";
+// import { V3_migration } from "./V3_migration";
 
 const migrations: ((db: IDBDatabase) => Promise<void>)[] = [
   V1_init_database,
diff --git a/utils.ts b/utils.ts
@@ -25,7 +25,7 @@ export async function getFavicon(link?: string): Promise<string | undefined> {
       ));
 
     return feedFavicon;
-  } catch (e) {
+  } catch {
     return undefined;
   }
 }
diff --git a/yarn.lock b/yarn.lock
@@ -124,6 +124,46 @@
     "@nodelib/fs.scandir" "2.1.5"
     fastq "^1.6.0"
 
+"@oxlint/darwin-arm64@0.15.7":
+  version "0.15.7"
+  resolved "https://registry.yarnpkg.com/@oxlint/darwin-arm64/-/darwin-arm64-0.15.7.tgz#ab8aca3b94db4b49baa5823975d22d62092e54a0"
+  integrity sha512-+8jOC9MfzIhbRdmNYl+gLlGZe8dhl2hrQRLJ+mriPRXxtpfBmT5aOmEQrs9BX5GPnh6hy4ArMvjDbCCXD+bl+w==
+
+"@oxlint/darwin-x64@0.15.7":
+  version "0.15.7"
+  resolved "https://registry.yarnpkg.com/@oxlint/darwin-x64/-/darwin-x64-0.15.7.tgz#6af64ddb895a9532bef21672fead5ef6676dfc34"
+  integrity sha512-4y1v3zCtQU0dv5SxwBZqtYiqtQTUSvEdK3XzWg/JxN8qEleHonQrbSvGKmlkzraEouKTIm1bXjmnrX26MX22cQ==
+
+"@oxlint/linux-arm64-gnu@0.15.7":
+  version "0.15.7"
+  resolved "https://registry.yarnpkg.com/@oxlint/linux-arm64-gnu/-/linux-arm64-gnu-0.15.7.tgz#564050c34a871cee0752ef2ff3242c54f5c91606"
+  integrity sha512-g01PWQl1+HLlMGK3lwH8G+A/5vA6H7tcKUHnx/qGz4+LM1zKfp1w2d2aoXxPqpIgtBPn19JRcBiEMv+nr40fiw==
+
+"@oxlint/linux-arm64-musl@0.15.7":
+  version "0.15.7"
+  resolved "https://registry.yarnpkg.com/@oxlint/linux-arm64-musl/-/linux-arm64-musl-0.15.7.tgz#73895ac7277054bbd3b8c32001c8ed43ed0f67f4"
+  integrity sha512-8Dg7qaHXNgiZgP3TxQU8k/5fpzGfcxYVLK58Sj/vSZ3vMrI68ipkq+rkNBjAXT1Aq2/eM6L/9CLH8pex+I1Nkw==
+
+"@oxlint/linux-x64-gnu@0.15.7":
+  version "0.15.7"
+  resolved "https://registry.yarnpkg.com/@oxlint/linux-x64-gnu/-/linux-x64-gnu-0.15.7.tgz#68be61b8bd9cabfbbd578678ad2138cbd2b294dc"
+  integrity sha512-hLsfcOgoky/FUGF2s3v7+wd0xGGuyE7EBPSTV7BPQYEm5+P5ZeWXPlUg8uTPee6bIxHa6lZLqunRl8Jn44b/ig==
+
+"@oxlint/linux-x64-musl@0.15.7":
+  version "0.15.7"
+  resolved "https://registry.yarnpkg.com/@oxlint/linux-x64-musl/-/linux-x64-musl-0.15.7.tgz#f569f04c205459aa74de530704f1e0184113f9c3"
+  integrity sha512-BW9dACxzLRZq67lPFis/NCiitQucZbbrONeK0mReBWPSM3MaegLY82kZU7sMq3fpBbzGaKFoNLp2EcsNfS5IVw==
+
+"@oxlint/win32-arm64@0.15.7":
+  version "0.15.7"
+  resolved "https://registry.yarnpkg.com/@oxlint/win32-arm64/-/win32-arm64-0.15.7.tgz#897f6d420f3b483fc92d6c5588ca0d244da7ac33"
+  integrity sha512-VvIaIdfCjcYy8cj3yAjHwj2dDFIFxdUS7G+KeDK/iH7O3uXW8wOec2wFYcd8xmVYHEcnw8fgNAXy04gXpB6KnQ==
+
+"@oxlint/win32-x64@0.15.7":
+  version "0.15.7"
+  resolved "https://registry.yarnpkg.com/@oxlint/win32-x64/-/win32-x64-0.15.7.tgz#20eec700fa3e12b2d0f58e07faff3dd0c4bd8f40"
+  integrity sha512-1WKZTgtJswATA8NYeUfMnN4ei7AUVyomrWBiPwYGMRMOo4jeGkOlOr2/iYq/vbtOCyOuqAo2JjfzN5sBOPfI/A==
+
 "@rushstack/eslint-patch@1.0.8":
   version "1.0.8"
   resolved "https://registry.yarnpkg.com/@rushstack/eslint-patch/-/eslint-patch-1.0.8.tgz#be3e914e84eacf16dbebd311c0d0b44aa1174c64"
@@ -1873,6 +1913,20 @@ own-keys@^1.0.1:
     object-keys "^1.1.1"
     safe-push-apply "^1.0.0"
 
+oxlint@^0.15.7:
+  version "0.15.7"
+  resolved "https://registry.yarnpkg.com/oxlint/-/oxlint-0.15.7.tgz#74a0a8dbb71f934727d5046e4c0589d23ca9de7f"
+  integrity sha512-ECx9retPd7Rvq62TasGODyQ4mrMtqBCCB18xOYGiAf8PP61snHaokLeTWQFf+pTURWpJZ9pIi2pMIDKh2P2SpQ==
+  optionalDependencies:
+    "@oxlint/darwin-arm64" "0.15.7"
+    "@oxlint/darwin-x64" "0.15.7"
+    "@oxlint/linux-arm64-gnu" "0.15.7"
+    "@oxlint/linux-arm64-musl" "0.15.7"
+    "@oxlint/linux-x64-gnu" "0.15.7"
+    "@oxlint/linux-x64-musl" "0.15.7"
+    "@oxlint/win32-arm64" "0.15.7"
+    "@oxlint/win32-x64" "0.15.7"
+
 parent-module@^1.0.0:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/parent-module/-/parent-module-1.0.1.tgz#691d2709e78c79fae3a156622452d00762caaaa2"
@@ -2151,6 +2205,11 @@ prelude-ls@^1.2.1:
   resolved "https://registry.yarnpkg.com/prelude-ls/-/prelude-ls-1.2.1.tgz#debc6489d7a6e6b0e7611888cec880337d316396"
   integrity sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==
 
+prettier@^3.4.2:
+  version "3.4.2"
+  resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.4.2.tgz#a5ce1fb522a588bf2b78ca44c6e6fe5aa5a2b13f"
+  integrity sha512-e9MewbtFo+Fevyuxn/4rrcDAaq0IYxPGLvObpQjiZBMAzB9IGmzlnG9RZy3FFas+eBMu2vA0CszMeduow5dIuQ==
+
 prop-types@^15.8.1:
   version "15.8.1"
   resolved "https://registry.yarnpkg.com/prop-types/-/prop-types-15.8.1.tgz#67d87bf1a694f48435cf332c24af10214a3140b5"

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { Feed, SiteFeed } from "./SiteFeed";`
	`1`	`+import { Feed } from "./SiteFeed";`
`2`	`2`
`3`	`3`	`export interface TransferData {`
`4`	`4`	`db: number;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-export async function V2_migration(db: IDBDatabase) {`
	`1`	`+export async function V2_migration() {`
`2`	`2`	`await new Promise((resolve) => setTimeout(resolve, 2000));`
`3`	`3`	`console.log("Second Migration");`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-export async function V3_migration(db: IDBDatabase) {`
	`1`	`+export async function V3_migration() {`
`2`	`2`	`console.log("Third Migration");`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ export async function getFavicon(link?: string): Promise<string \| undefined> {`
`25`	`25`	`));`
`26`	`26`
`27`	`27`	`return feedFavicon;`
`28`		`- } catch (e) {`
	`28`	`+ } catch {`
`29`	`29`	`return undefined;`
`30`	`30`	`}`
`31`	`31`	`}`