Merge pull request #55 from cloudcome/feat/v0.x

Feat/v0.x

Author: cloudcome

.github/workflows/code-review.yml

@@ -1,4 +1,4 @@
-name: code-review
+name: code review
 
 on:
   push:

.github/workflows/release-please.yml

@@ -1,4 +1,4 @@
-name: release-please
+name: release please
 
 on:
   push:

README.md

@@ -2,7 +2,7 @@
 
 ---
 
-[![code-review][code-review-badge]][code-review-link] [![code-quality][code-quality-badge]][code-quality-link] ![version][version-badge] ![license][license-badge]
+[![][code-review-badge]][code-review-link] [![][code-quality-badge]][code-quality-link] [![][code-coverage-badge]][code-coverage-link] ![][version-badge] ![][license-badge]
 
 OpenAPI Specification ➡️ TypeScript
 
@@ -28,16 +28,13 @@ yarn add --dev oas-gen-ts
 
 ## CLI
 
-Create oas.config.js or oas.json in the root directory of the project, and refer to [cosmiconfig](https://www.npmjs.com/package/cosmiconfig) for the file name specification.
-
-The search order for configuration files is `oas.config.cjs`, `oas.config.js`, `oas.json`.
+Create oas.config.js or oas.json in the root directory of the project. The search order for configuration files is `oas.config.cjs`, `oas.config.js`, `oas.json`.
 
 ```js
 // oas.config.cjs
 const { defineConfig } = require('oas-gen-ts');
 
 module.exports = defineConfig({
-  axiosImport: `import { axios } from '@/util/axios';`,
   list: [
     {
       name: 'swagger/pet',
@@ -59,8 +56,6 @@ The generated file will be exported as one function and one operation, like this
 ```ts
 // src/apis/swagger/pet.ts
 
-import { axios } from '@/util/axios';
-
 // ...
 
 export interface Pet {
@@ -116,21 +111,21 @@ export async function findPetsByStatus(
 import { generate } from 'oas-gen-ts';
 
 generate({
-  // ...
+  // ...config
 });
 ```
 
 # Config
 
-| Name                 | Type      | Required | Description                                | Default                                         |
-| -------------------- | --------- | -------- | ------------------------------------------ | ----------------------------------------------- |
-| `cwd`                | `string`  | `false`  | current working directory                  | `process.cwd()`                                 |
-| `dest`               | `string`  | `false`  | Destination directory for generated files  | `src/apis`                                      |
-| `axiosImport`        | `string`  | `false`  | axios import string                        | Import from the official and create an instance |
-| `unwrapResponseData` | `boolean` | `false`  | unwrap the data item from the response     | `false`                                         |
-| `list`               | `OAS[]`   | `false`  | List of OpenAPI Specification declarations | `[]`                                            |
+| Name                 | Type        | Required | Description                                | Default                                         |
+| -------------------- | ----------- | -------- | ------------------------------------------ | ----------------------------------------------- |
+| `cwd`                | `string`    | `false`  | current working directory                  | `process.cwd()`                                 |
+| `dest`               | `string`    | `false`  | Destination directory for generated files  | `src/apis`                                      |
+| `axiosImport`        | `string`    | `false`  | axios import string                        | Import from the official and create an instance |
+| `unwrapResponseData` | `boolean`   | `false`  | unwrap the data item from the response     | `false`                                         |
+| `list`               | `OasItem[]` | `false`  | List of OpenAPI Specification declarations | `[]`                                            |
 
-`Oas`:
+`OasItem`:
 
 | Name          | Type     | Required | Description                                     | Default                                         |
 | ------------- | -------- | -------- | ----------------------------------------------- | ----------------------------------------------- |
@@ -145,5 +140,7 @@ generate({
 [code-review-link]: https://github.com/cloudcome/oas-gen-ts/actions/workflows/code-review.yml
 [code-quality-badge]: https://app.codacy.com/project/badge/Grade/e788387e5e27472ba3b5003bf19aeea7
 [code-quality-link]: https://www.codacy.com/gh/cloudcome/oas-gen-ts/dashboard?utm_source=github.com&utm_medium=referral&utm_content=cloudcome/oas-gen-ts&utm_campaign=Badge_Grade
+[code-coverage-badge]: https://app.codacy.com/project/badge/Coverage/e788387e5e27472ba3b5003bf19aeea7
+[code-coverage-link]: https://www.codacy.com/gh/cloudcome/oas-gen-ts/dashboard?utm_source=github.com&utm_medium=referral&utm_content=cloudcome/oas-gen-ts&utm_campaign=Badge_Coverage
 [version-badge]: https://img.shields.io/npm/v/oas-gen-ts
 [license-badge]: https://img.shields.io/github/license/cloudcome/oas-gen-ts

src/types.ts

@@ -14,10 +14,10 @@ export interface OasItemAsUrl extends OasItemBase {
   url: string;
 }
 
-export type Oas = import('swagger-schema-official').Spec;
+export type Spec = import('swagger-schema-official').Spec;
 
 export interface OasItemAsSpec extends OasItemBase {
-  spec: Oas;
+  spec: Spec;
 }
 
 export type OasItem = OasItemAsUrl | OasItemAsSpec;

test/generator.test.ts

@@ -2,7 +2,7 @@ import { random } from 'lodash-es';
 import path from 'path';
 import { cleanDir, isFile } from 'src/utils';
 import { afterEach, beforeAll, beforeEach, describe, expect, test, vi } from 'vitest';
-import { generate, Generated, GenerateInfo, generateItem, Oas } from '../src';
+import { generate, Generated, GenerateInfo, generateItem, Spec } from '../src';
 import petstore3 from './petstore3.json';
 
 describe('generate-item', () => {
@@ -42,7 +42,7 @@ describe('generate-item', () => {
     const generated = await generateItem(
       {
         name,
-        spec: petstore3 as unknown as Oas,
+        spec: petstore3 as unknown as Spec,
       },
       config
     );
@@ -63,11 +63,11 @@ test('generate', async () => {
     list: [
       {
         name: random(1, 1000).toString(),
-        spec: petstore3 as unknown as Oas,
+        spec: petstore3 as unknown as Spec,
       },
       {
         name: random(1, 1000).toString(),
-        spec: petstore3 as unknown as Oas,
+        spec: petstore3 as unknown as Spec,
       },
     ],
     unwrapResponseData: false,