Added GH Action with PR checks for build validity (#8)

* Cleaned up logger

* Added GH Action to do PR checks

* Consolidated GH Action

* Making pnpm happy

* Move TS type check after build so types are ready

* Resolved issue with new noOpLogger type

Author: mmnavarr

.github/README.md

@@ -0,0 +1,29 @@
+# GitHub Actions Workflows
+
+This directory contains GitHub Actions workflows that automate various tasks for the MessariKit project.
+
+## Workflows
+
+### PR Checks (`pr-checks.yml`)
+
+This workflow runs on pull requests and pushes to master branches (main, master, develop). It ensures that:
+
+- Code passes linting
+- API spec validation and generation works
+- All packages build successfully
+- Tests pass
+- TypeScript types check correctly
+- Dependencies can be installed without conflicts
+
+## Contributing
+
+When contributing to this project, your PR will automatically be validated by these workflows. Make sure that all checks pass before requesting a review.
+
+## Customizing
+
+To modify these workflows:
+
+1. Edit the YAML files in this directory
+2. Commit your changes
+3. Push to your branch
+4. Create a PR to get your changes reviewed 

.github/workflows/pr-checks.yml

@@ -0,0 +1,89 @@
+name: PR Checks
+
+on:
+  pull_request:
+    branches: [ master ]
+  push:
+    branches: [ master ]
+
+jobs:
+  # Runs linter, tsc type-check, api type generation + validation, pkg build, and tests
+  build-checks:
+    runs-on: ubuntu-latest
+    
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+    
+    - name: Setup PNPM
+      uses: pnpm/action-setup@v2
+      with:
+        version: latest
+        run_install: false
+    
+    - name: Get pnpm store directory
+      id: pnpm-cache
+      shell: bash
+      run: |
+        echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+    
+    - name: Setup pnpm cache
+      uses: actions/cache@v3
+      with:
+        path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+        key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+        restore-keys: |
+          ${{ runner.os }}-pnpm-store-
+    
+    - name: Install dependencies
+      run: pnpm install
+    
+    - name: Lint code
+      run: pnpm lint:fix
+    
+    - name: API validation and generation
+      run: pnpm api:build
+    
+    - name: Build all packages
+      run: pnpm build
+
+    - name: Check TypeScript
+      run: pnpm -r exec tsc --noEmit
+    
+    - name: Run tests
+      run: pnpm test
+
+  dependency-check:
+    runs-on: ubuntu-latest
+    
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+    
+    - name: Setup PNPM
+      uses: pnpm/action-setup@v2
+      with:
+        version: latest
+        run_install: false
+    
+    - name: Check for dependency issues
+      run: pnpm install --frozen-lockfile
+      

packages/api/src/client/base.ts

@@ -31,7 +31,7 @@ import type {
   getAssetListResponse,
   getAssetListParameters,
 } from "@messari-kit/types";
-import { LogLevel, type Logger, makeConsoleLogger, createFilteredLogger, makeNoOpLogger } from "../logging";
+import { LogLevel, type Logger, makeConsoleLogger, createFilteredLogger, noOpLogger } from "../logging";
 import type { PaginatedResult, RequestOptions, ClientEventMap, ClientEventType, ClientEventHandler } from "./types";
 
 /**
@@ -255,7 +255,7 @@ export abstract class MessariClientBase {
    */
   public disableLogging(): void {
     this.isLoggingDisabled = true;
-    this.logger = makeNoOpLogger();
+    this.logger = noOpLogger;
   }
 
   /**

packages/api/src/client/client.ts

@@ -53,7 +53,7 @@ import type {
 } from "@messari-kit/types";
 import type { Agent } from "node:http";
 import { pick } from "../utils";
-import { LogLevel, type Logger, makeConsoleLogger, createFilteredLogger, makeNoOpLogger } from "../logging";
+import { LogLevel, type Logger, makeConsoleLogger, createFilteredLogger, noOpLogger } from "../logging";
 import { RequestTimeoutError } from "../error";
 import type {
   ClientEventHandler,
@@ -108,10 +108,10 @@ export class MessariClient extends MessariClientBase {
     // Handle logger initialization with disableLogging option
     this.isLoggingDisabled = !!options.disableLogging;
     if (this.isLoggingDisabled) {
-      this.logger = makeNoOpLogger();
+      this.logger = noOpLogger;
     } else {
       const baseLogger = options.logger || makeConsoleLogger("messari-client");
-      this.logger = options.logLevel ? createFilteredLogger(baseLogger, options.logLevel) : createFilteredLogger(baseLogger, LogLevel.INFO);
+      this.logger = createFilteredLogger(baseLogger, options.logLevel ?? LogLevel.INFO);
     }
 
     this.defaultHeaders = {

packages/api/src/logging.ts

@@ -68,8 +68,8 @@ export const createFilteredLogger = (logger: Logger, minLevel: LogLevel): Logger
 };
 
 /**
- * Creates a logger that does nothing (no-op).
+ * Returns a logger that does nothing (no-op).
  * Use this when you want to completely disable logging.
  * @returns A no-op logger.
  */
-export const makeNoOpLogger: Logger = () => {};
+export const noOpLogger: Logger = () => {};