ci,build: add lint and format jobs

Author: panva

.github/workflows/test.yml

@@ -10,6 +10,32 @@ on:
   workflow_dispatch:
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: lts/hydrogen # 18
+          cache: 'npm'
+      - run: npm clean-install
+      - run: npm run format-check
+
+  test-types:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: lts/hydrogen # 18
+          cache: 'npm'
+      - run: npm clean-install
+      - run: npm run test-types
+
   test:
     runs-on: ubuntu-latest
     strategy:
@@ -27,4 +53,3 @@ jobs:
           check-latest: true
       - run: npm clean-install
       - run: npm run test
-      - run: npm run test-types

package-lock.json

@@ -28,6 +28,9 @@
     "types/index.d.ts"
   ],
   "scripts": {
+    "_format": "find lib types test -type f -name '*.ts' -o -name '*.mjs' -name '*.cjs' | xargs prettier",
+    "format": "npm run _format -- --write",
+    "format-check": "npm run _format -- --check",
     "test": "ava",
     "test-types": "tsd",
     "watch": "ava --watch"
@@ -40,6 +43,7 @@
   "devDependencies": {
     "@types/node": "^16.4.0",
     "ava": "^5.0.1",
+    "prettier": "^2.8.8",
     "sinon": "^11.1.2",
     "tsd": "^0.28.1",
     "typescript": "^3.6.0"

package.json

@@ -114,9 +114,15 @@ export namespace V1 {
     options?: Omit<ConsumeOptionsBuffer<true>, 'assertion'>,
   ): Promise<CompleteResultBuffer>
   function generateKey(purpose: 'local' | 'public'): Promise<KeyObject>
-  function generateKey(purpose: 'local' | 'public', options: { format: 'keyobject' }): Promise<KeyObject>
+  function generateKey(
+    purpose: 'local' | 'public',
+    options: { format: 'keyobject' },
+  ): Promise<KeyObject>
   function generateKey(purpose: 'local', options: { format: 'paserk' }): Promise<string>
-  function generateKey(purpose: 'public', options: { format: 'paserk' }): Promise<{ secretKey: string, publicKey: string }>
+  function generateKey(
+    purpose: 'public',
+    options: { format: 'paserk' },
+  ): Promise<{ secretKey: string; publicKey: string }>
 }
 export namespace V2 {
   function sign(
@@ -146,7 +152,10 @@ export namespace V2 {
   ): Promise<CompleteResultBuffer>
   function generateKey(purpose: 'public'): Promise<KeyObject>
   function generateKey(purpose: 'public', options: { format: 'keyobject' }): Promise<KeyObject>
-  function generateKey(purpose: 'public', options: { format: 'paserk' }): Promise<{ secretKey: string, publicKey: string }>
+  function generateKey(
+    purpose: 'public',
+    options: { format: 'paserk' },
+  ): Promise<{ secretKey: string; publicKey: string }>
   function bytesToKeyObject(bytes: Buffer): KeyObject
   function keyObjectToBytes(keyObject: KeyObject): Buffer
 }
@@ -202,9 +211,15 @@ export namespace V3 {
     options?: ConsumeOptionsBuffer<true>,
   ): Promise<CompleteResultBuffer>
   function generateKey(purpose: 'local' | 'public'): Promise<KeyObject>
-  function generateKey(purpose: 'local' | 'public', options: { format: 'keyobject' }): Promise<KeyObject>
+  function generateKey(
+    purpose: 'local' | 'public',
+    options: { format: 'keyobject' },
+  ): Promise<KeyObject>
   function generateKey(purpose: 'local', options: { format: 'paserk' }): Promise<string>
-  function generateKey(purpose: 'public', options: { format: 'paserk' }): Promise<{ secretKey: string, publicKey: string }>
+  function generateKey(
+    purpose: 'public',
+    options: { format: 'paserk' },
+  ): Promise<{ secretKey: string; publicKey: string }>
   function bytesToKeyObject(bytes: Buffer): KeyObject
   function keyObjectToBytes(keyObject: KeyObject): Buffer
 }
@@ -236,7 +251,10 @@ export namespace V4 {
   ): Promise<CompleteResultBuffer>
   function generateKey(purpose: 'public'): Promise<KeyObject>
   function generateKey(purpose: 'public', options: { format: 'keyobject' }): Promise<KeyObject>
-  function generateKey(purpose: 'public', options: { format: 'paserk' }): Promise<{ secretKey: string, publicKey: string }>
+  function generateKey(
+    purpose: 'public',
+    options: { format: 'paserk' },
+  ): Promise<{ secretKey: string; publicKey: string }>
   function bytesToKeyObject(bytes: Buffer): KeyObject
   function keyObjectToBytes(keyObject: KeyObject): Buffer
 }

types/index.d.ts

@@ -1,6 +1,5 @@
 import * as paseto from '.'
-import {expectType} from 'tsd';
-
+import { expectType } from 'tsd'
 ;(async () => {
   {
     const key = await paseto.V2.generateKey('public')