From f03684461bd71eb772bb95793be4928b2b21869d Mon Sep 17 00:00:00 2001 From: David Crespo Date: Thu, 28 Mar 2024 12:03:52 -0500 Subject: [PATCH] get rid of npm run gen-from, update readme --- README.md | 12 +++++++----- package.json | 2 -- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 850f23a..f2a495e 100644 --- a/README.md +++ b/README.md @@ -41,12 +41,14 @@ generate several distinct pieces: ## Using the API client -We intend to publish the generated code on npm, but have not done so yet. In the -Oxide web console (the primary consumer of the TS client, not yet open source) -we use the library by generating it from a given spec version with `npm run gen-from` and versioning a full copy of the generated code in that repo. +We intend to publish the generated code on npm, but have not done so yet. In +the [Oxide web console](https://github.com/oxidecomputer/console) (the primary +consumer of the TS client) we use the client by generating it from a pinned +spec version with `tsx generator/index.ts` and versioning a full copy of the +generated code in that repo. -The generated client uses the Fetch API, so in order to be used in Node.js, it -requires either Node.js v18 or a polyfill. +The generated client uses the Fetch API, so in +order to be used in Node.js, it requires either Node.js v18 or a polyfill. ## Generating the client diff --git a/package.json b/package.json index e87bfb9..c4b4df5 100644 --- a/package.json +++ b/package.json @@ -13,10 +13,8 @@ }, "scripts": { "gen": "./tools/gen.sh $(cat ./OMICRON_VERSION) ./client", - "gen-from": "./tools/gen.sh", "lint": "eslint .", "postgen": "prettier --parser typescript --write ./client", - "postgen-from": "npm run postgen", "pretest": "npm run gen", "test": "vitest", "test:ui": "vitest --ui",