126: Add linter command to CI

.github/workflows/lint.yml

@@ -0,0 +1,26 @@
+name: Run Linter
+
+on:
+  push:
+    branches: [ develop ]
+  pull_request:
+    types: [ opened, synchronize, reopened ]
+    paths:
+      - 'src/**'
+      - 'tests/**'
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4.0.2
+        with:
+          node-version: 21.x
+      - name: Install Yarn
+        run: npm install -g yarn
+      - name: Install dependencies
+        run: yarn install --immutable
+      - name: Run linter
+        run: npm run lint

package.json

@@ -20,7 +20,7 @@
     "prepublishOnly": "npm run build",
     "test": "jest",
     "docs": "npx typedoc",
-    "lint": "eslint . --ext .ts",
+    "lint": "eslint --ext ts src tests",
     "lint:fix": "eslint . --ext .ts --fix"
   },
   "keywords": [],

src/base-resource.ts

@@ -120,7 +120,8 @@ export default class ShortcutResource<Interface = BaseInterface> {
     public async save(): Promise<void> {
       if (this.id) {
         await this.update()
-      } else {
+      }
+      else {
         await this.create()
       }
     }

src/client.ts

@@ -25,7 +25,8 @@ export default class Client {
         'Content-Type': 'application/json',
         'Shortcut-Token': this.shortcutApiKey
       }
-    } else if (!process.env.SHORTCUT_API_KEY) throw new Error('Shortcut API Key not found')
+    }
+    else if (!process.env.SHORTCUT_API_KEY) throw new Error('Shortcut API Key not found')
     return {
       'Content-Type': 'application/json',
       'Shortcut-Token': process.env.SHORTCUT_API_KEY

src/stories/history/actions/history-action.ts

@@ -8,7 +8,7 @@ import {getHeaders} from '@sx/utils/headers'
 import UUID from '@sx/utils/uuid'
 
 
-class HistoryAction extends ShortcutResource<HistoryActionInterface> implements HistoryActionInterface{
+class HistoryAction extends ShortcutResource<HistoryActionInterface> implements HistoryActionInterface {
   public availableOperations: ResourceOperation[] = []
 
   constructor(init: HistoryActionInterface) {
@@ -23,7 +23,8 @@ class HistoryAction extends ShortcutResource<HistoryActionInterface> implements
   get owners(): Promise<Member[]> {
     if (!this.ownerIds) {
       return Promise.resolve([])
-    } else {
+    }
+    else {
       const service = new MembersService({headers: getHeaders()})
       return service.getMany(this.ownerIds)
     }
@@ -51,4 +52,4 @@ class HistoryAction extends ShortcutResource<HistoryActionInterface> implements
   labelIds?: number[]
 }
 
-export default HistoryAction
+export default HistoryAction

src/uploaded-files/uploaded-files-service.ts

@@ -34,7 +34,8 @@ export default class UploadedFilesService extends BaseService<UploadedFile, Uplo
       const data = response.data as UploadedFileApiData
       const uploadedFile = convertApiFields(data) as UploadedFileInterface
       return this.factory(uploadedFile)
-    } catch (error) {
+    }
+    catch (error) {
       throw new Error('Failed to upload file: ' + error)
     }
   }