Addressing PR comments

Author: kevincai3

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 .DS_Store
 .husky
+dist/*

README.md

@@ -1 +1,17 @@
-# speakeasy-typescript-sdk
+# speakeasy-typescript-sdk
+
+## Setting up
+
+Feel free to use any system to manage your Node installing, but a `.nvmrc` is included in the library for `nvm` support.
+
+To setup:
+
+1. Install `nvm` following instructions on (nvm repo)[https://github.com/nvm-sh/nvm]
+2. Install the correct node version with `nvm install`
+3. Make sure the symlinks are correct with `nvm use`
+
+## Formating, Linting & Testing
+
+`prettier` is used with `husky` and `lint-staged` to lint on commit, which should be installed automatically by `npm`.
+
+Use `yarn test` to run the test suite.

package.json

@@ -6,9 +6,11 @@
   "author": "",
   "license": "MIT",
   "devDependencies": {
+    "@types/express": "^4.17.13",
+    "@types/har-format": "^1.2.8",
     "@types/jest": "^28.1.6",
+    "@types/node": "^18.6.0",
     "@types/supertest": "^2.0.12",
-    "express": "^4.18.1",
     "husky": "^8.0.1",
     "jest": "^28.1.3",
     "lint-staged": "^13.0.3",
@@ -18,17 +20,15 @@
     "ts-node": "^10.9.1",
     "typescript": "^4.7.4"
   },
+  "peerDepedencies": {
+    "express": "^4.18.1"
+  },
   "scripts": {
     "build": "yarn tsc",
     "test": "yarn jest",
     "prepare": "yarn husky install"
   },
-  "dependencies": {
-    "@types/express": "^4.17.13",
-    "@types/har-format": "^1.2.8",
-    "@types/node": "^18.6.0",
-    "har": "^1.0.0"
-  },
+  "dependencies": {},
   "engines": {
     "node": ">=16.0.0"
   },

src/client.ts

@@ -1,10 +1,10 @@
-const DEFAULT_SPEAKEASY_SERVER_URL = "grpc.speakeasyapi.dev:443"
+const DEFAULT_SPEAKEASY_SERVER_URL = "grpc.speakeasyapi.dev:443";
 
 export type Config = {
   apiKey: string;
 };
 
-export class SpeakeasyClient {
+export class SpeakeasySDK {
   apiKey: string;
   serverUrl: string;
 
@@ -17,10 +17,10 @@ export class SpeakeasyClient {
     this.apiKey = config.apiKey;
 
     const serverUrl = process.env.SPEAKEASY_SERVER_URL;
-    if (serverUrl == null) {
-      this.serverUrl = DEFAULT_SPEAKEASY_SERVER_URL;
-    } else {
+    if (serverUrl) {
       this.serverUrl = serverUrl;
+    } else {
+      this.serverUrl = DEFAULT_SPEAKEASY_SERVER_URL;
     }
   }
 }

src/index.ts

@@ -1 +1 @@
-export { SpeakeasyClient } from "./client";
+export { SpeakeasySDK } from "./client";

src/speakeasy.ts

@@ -1,9 +1,9 @@
-import { Config, SpeakeasyClient } from "./client";
+import { Config, SpeakeasySDK } from "./client";
 import { outputError } from "./error";
 
-let speakeasyInstance: SpeakeasyClient | null = null;
+let speakeasyInstance: SpeakeasySDK | null = null;
 
-export function init(config: Config): SpeakeasyClient | null {
+export function init(config: Config): SpeakeasySDK | null {
   if (speakeasyInstance != null) {
     outputError(
       "Speakeasy has already been initialized, skipping initialization"
@@ -12,14 +12,14 @@ export function init(config: Config): SpeakeasyClient | null {
   }
 
   try {
-    speakeasyInstance = new SpeakeasyClient(config);
+    speakeasyInstance = new SpeakeasySDK(config);
   } catch (err: any) {
     outputError(err.message);
     return null;
   }
   return speakeasyInstance;
 }
 
-export function getInstance(): SpeakeasyClient | null {
+export function getInstance(): SpeakeasySDK | null {
   return speakeasyInstance;
 }