Initial commit with vitest

Author: djMax

.gitignore

@@ -6,7 +6,7 @@ coverage
 .nyc_output
 *.log
 .tap_output
-__tests__/petstore.d.ts
+__tests__/snapshot.d.ts
 
 .yarn/*
 !.yarn/patches

.trunk/.gitignore

@@ -0,0 +1,8 @@
+*out
+*logs
+*actions
+*notifications
+plugins
+user_trunk.yaml
+user.yaml
+tools

.trunk/configs/.markdownlint.yaml

@@ -0,0 +1,10 @@
+# Autoformatter friendly markdownlint config (all formatting rules disabled)
+default: true
+blank_lines: false
+bullet: false
+html: false
+indentation: false
+line_length: false
+spaces: false
+url: false
+whitespace: false

.trunk/configs/.yamllint.yaml

@@ -0,0 +1,10 @@
+rules:
+  quoted-strings:
+    required: only-when-needed
+    extra-allowed: ['{|}']
+  empty-values:
+    forbid-in-block-mappings: true
+    forbid-in-flow-mappings: true
+  key-duplicates: {}
+  octal-values:
+    forbid-implicit-octal: true

.trunk/trunk.yaml

@@ -0,0 +1,30 @@
+version: 0.1
+cli:
+  version: 1.13.0
+plugins:
+  sources:
+    - id: trunk
+      ref: v1.0.0
+      uri: https://github.com/trunk-io/plugins
+lint:
+  enabled:
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - git-diff-check
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+runtimes:
+  enabled:
+    - [email protected]
+    - [email protected]
+actions:
+  enabled:
+    - trunk-announce
+    - trunk-check-pre-push
+    - trunk-fmt-pre-commit
+    - trunk-upgrade-available

Makefile

@@ -1,89 +1,11 @@
-import { InMemoryLRUCache } from '@apollo/utils.keyvaluecache';
+import fs from 'fs';
+import path from 'path';
 
-import { type JsonPutBody, TypedRESTDataSource } from '../src/index';
+import { expect, test } from 'vitest';
 
-import type { paths } from './petstore';
+import { generate } from '../src/index';
 
-interface ApolloContext {
-  petId: number;
-}
-
-class PetStoreDataSource extends TypedRESTDataSource<paths, ApolloContext> {
-  override baseURL = 'https://petstore3.swagger.io/api/v3';
-
-  protected willSendRequest() {}
-
-  callSimpleMethod() {
-    return this.openapi.GET(
-      '/pet/{petId}',
-      {
-        params: {
-          path: {
-            petId: this.context.petId,
-          },
-        },
-      },
-      {
-        cacheOptions: {
-          ttl: 100000,
-        },
-      },
-    );
-  }
-
-  uploadBadImage() {
-    return this.openapi.POST('/pet/{petId}/uploadImage', {
-      params: {
-        path: { petId: 1 },
-        query: { additionalMetadata: 'test' },
-      },
-      body: 'binarydata',
-    });
-  }
-}
-
-test('should create a client', async () => {
-  const petStore = new PetStoreDataSource();
-  const cache = new InMemoryLRUCache();
-  expect(petStore).toBeInstanceOf(PetStoreDataSource);
-  petStore.initialize({
-    context: { petId: 1 },
-    cache,
-  });
-
-  const response = await petStore.callSimpleMethod();
-  expect(response.name).toBe('Pet1');
-  expect(cache.keys()).toHaveLength(1);
-
-  const response2 = await petStore.callSimpleMethod();
-  expect(response2.name).toBe('Pet1');
-  expect(cache.keys()).toHaveLength(1);
-
-  const reqSpy = jest.spyOn(
-    petStore as unknown as { willSendRequest: () => void },
-    'willSendRequest',
-  );
-
-  await petStore.uploadBadImage().catch((error) => {
-    expect(error.extensions?.response).toBeTruthy();
-    expect(error.extensions?.response.status).toBe(415);
-  });
-
-  expect(reqSpy).toHaveBeenCalledTimes(1);
-  expect(reqSpy).toHaveBeenCalledWith(
-    expect.objectContaining({
-      method: 'POST',
-      path: '/pet/1/uploadImage',
-      body: 'binarydata',
-      params: new URLSearchParams({ additionalMetadata: 'test' }),
-    }),
-  );
-
-  // This is essentially a build time test.
-  const body: JsonPutBody<paths['/pet']> = {
-    id: 1,
-    name: 'Kiki',
-    photoUrls: [],
-  };
-  expect(body).toBeTruthy();
+test('should generate a matching document', async () => {
+  const now = await generate(path.resolve(__dirname, 'petstore.json'), {});
+  expect(now).toMatch(fs.readFileSync(path.resolve(__dirname, 'snapshot.d.ts'), 'utf8'));
 });

__tests__/index.spec.ts

@@ -46,22 +46,20 @@
     "@openapi-typescript-infra/coconfig": "^3.2.2",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@types/jest": "^29.5.3",
+    "@types/yargs-parser": "^21.0.0",
     "@typescript-eslint/eslint-plugin": "^6.2.0",
     "@typescript-eslint/parser": "^6.2.0",
     "coconfig": "^0.12.2",
     "eslint": "^8.45.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jest": "^27.2.3",
-    "jest": "^29.6.1",
     "prettier": "^3.0.0",
-    "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "typescript": "^5.1.6"
+    "typescript": "^5.1.6",
+    "vitest": "^0.33.0"
   },
   "scripts": {
-    "test": "make && tsc -p tsconfig.json --noEmit && jest",
+    "test": "tsc -p tsconfig.test.json --noEmit && vitest",
     "lint": "eslint .",
     "build": "tsc -p tsconfig.build.json && yarn dlx glob-chmod 755 build/bin/*",
     "watch": "tsc -p tsconfig.json -w --preserveWatchOutput",

package.json

@@ -11,8 +11,6 @@ interface ComponentWithProps {
 }
 
 export async function generate(file: string | typeof process.stdin, options: OpenAPITSOptions) {
-  const { default: openApiTs } = await import('openapi-typescript');
-
   const enums: string[] = [];
   const visitedEnums: Record<string, string[]> = {};
 
@@ -34,7 +32,7 @@ export async function generate(file: string | typeof process.stdin, options: Ope
     enums.push(definition);
   }
 
-  const basicOutput = await openApiTs(file, {
+  const finalOptions: OpenAPITSOptions = {
     ...options,
     transform(schemaObject, metadata) {
       // There are two places where we look for enums. Path handlers, and components.
@@ -73,7 +71,9 @@ export async function generate(file: string | typeof process.stdin, options: Ope
       }
       return undefined;
     },
-  });
+  };
 
+  const { default: openApiTs } = await import('openapi-typescript');
+  const basicOutput = await openApiTs(file, finalOptions);
   return [basicOutput, ...enums].join('\n');
 }

src/index.ts

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "skipLibCheck": true
+  }
+}

tsconfig.test.json

@@ -0,0 +1,8 @@
+import { configDefaults, defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    watch: false,
+    exclude: ['.trunk', ...configDefaults.exclude],
+  },
+});