feat: Add -p, --prettier options to generate command (#51)

.eslintignore

@@ -1 +1,2 @@
 examples/src/
+lib/

.github/workflows/checks.yml

@@ -39,5 +39,8 @@ jobs:
         with:
           node-version: 18
 
-      - name: TypeeScript
+      - name: Yarn install
+        run: yarn
+
+      - name: TypeScript
         run: yarn test:types

.yarnrc.yml

@@ -4,4 +4,4 @@ enableGlobalCache: false
 
 npmPublishAccess: public
 
-yarnPath: .yarn/releases/yarn-4.0.2.cjs
+yarnPath: .yarn/releases/yarn-4.1.0.cjs

CHANGELOG.md

@@ -1,6 +1,11 @@
 # CHANGELOG.md
 
+## Unreleased
+
+- Add `-p,--prettier` option to the cli to format the generated code with prettier [#51](https://github.com/Embraser01/typoas/pull/51)
+
 ## 3.1.7 - 2024-02-23
+
 ## 3.1.6 - 2024-02-23
 
 > Only the runtime was published, the generator and cli are still at 3.1.5

README.md

@@ -113,15 +113,9 @@ writeFileSync('./src/client.ts', data, 'utf8');
 Once the file is generated you'll be able to use it like this:
 
 ```typescript
-import fetch from 'node-fetch';
 import { ServerConfiguration } from '@typoas/runtime';
 import { createContext, pullsList } from './client';
 
-// Inject fetch polyfill into NodeJS env.
-if (!globalThis.fetch) {
-  // @ts-ignore
-  globalThis.fetch = fetch;
-}
 const ctx = createContext();
 
 pullsList(ctx, {
@@ -132,6 +126,8 @@ pullsList(ctx, {
   .catch((err) => console.error('Error while getting PRs', err));
 ```
 
+> The default `fetch` implementation is used (included in Node.js >= 18.0.0). You can always override the default fetch implementation in `createContext`
+
 ## Examples
 
 You can find examples in the [`examples`](./examples) folder.
@@ -164,15 +160,9 @@ which allow [Tree Shaking](https://webpack.js.org/guides/tree-shaking/). To get
 you can use `wrapApi` helper:
 
 ```typescript
-import fetch from 'node-fetch';
 import { ServerConfiguration, wrapApi } from '@typoas/runtime';
 import { createContext, pullsList, issuesList } from './client';
 
-// Inject fetch polyfill into NodeJS env.
-if (!globalThis.fetch) {
-  // @ts-ignore
-  globalThis.fetch = fetch;
-}
 const ctx = createContext();
 const ghClient = wrapApi(ctx, {
   pullsList,

examples/package.json

@@ -4,17 +4,15 @@
   "scripts": {
     "start": "ts-node src/index.ts",
     "test:types": "tsc --noEmit",
-    "generate": "ts-node scripts/generate.ts && prettier -w src/"
+    "generate": "ts-node scripts/generate.ts"
   },
   "dependencies": {
-    "@typoas/runtime": "workspace:^",
-    "node-fetch": "^2.6.11"
+    "@typoas/runtime": "workspace:^"
   },
   "devDependencies": {
-    "@types/node": "^20.2.3",
-    "@types/node-fetch": "^2.6.4",
+    "@types/node": "^20.11.24",
     "@typoas/cli": "workspace:^",
-    "prettier": "^3.2.4",
+    "prettier": "^3.2.5",
     "ts-node": "^10.9.2",
     "typescript": "^5.3.3"
   }

examples/scripts/generate.ts

@@ -29,7 +29,15 @@ async function run() {
 
   for (const sample of samples) {
     await cli.run(
-      ['generate', '-i', sample.input, '-o', `./src/${sample.output}.ts`, '-e'],
+      [
+        'generate',
+        '-i',
+        sample.input,
+        '-o',
+        `./src/${sample.output}.ts`,
+        '-e',
+        '-p',
+      ],
       context,
     );
   }