Merge pull request #168 from FrontEndDev-org/feat/v0.x

cloudcome · web-flow · commit 716325e5af7d · 2023-04-24T14:34:31.000+08:00
Feat/v0.x
diff --git a/.commitlintrc.cjs b/.commitlintrc.cjs
@@ -1,4 +1,6 @@
 /**
+ * commitlint.config
+ * @ref http://commitlint.js.org/
  * @type {import('@commitlint/types').UserConfig}
  */
 module.exports = {
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -1,5 +1,9 @@
 const { defineConfig } = require('eslint-define-config');
 
+/**
+ * eslint config
+ * @ref https://eslint.org/
+ */
 module.exports = defineConfig({
   root: true,
 
diff --git a/.lintstagedrc.cjs b/.lintstagedrc.cjs
@@ -1,3 +1,7 @@
+/**
+ * lint-staged config
+ * @ref https://www.npmjs.com/package/lint-staged
+ */
 module.exports = {
   '*.{cjs,mjs,ts,tsx}': 'eslint --fix',
   '*.{cjs,mjs,ts,tsx,html,css,scss}': 'prettier --write',
diff --git a/.prettierrc.cjs b/.prettierrc.cjs
@@ -1,4 +1,6 @@
 /**
+ * prettier.config
+ * @ref https://prettier.io/
  * @type {import('prettier').Config}
  */
 module.exports = {
diff --git a/README.md b/README.md
@@ -53,7 +53,7 @@ npx openapi-axios
 ```
 
 <details>
-<summary>生成的文件将导出为一个函数和一个操作，如下所示</summary>
+<summary>【点击展开】生成的文件将导出为一个函数和一个操作，如下所示</summary>
 
 ```ts
 // src/apis/swagger/petStore3.ts
diff --git a/TODO.md b/TODO.md
@@ -1,5 +1,9 @@
 - [ ] 支持 OneOf AllOf
-- [ ] 支持长度为一的必填参数展开
+- [ ] 支持长度为一的必填参数展开 `type XXReqPath = { name: string }` -> `name: string`
 - [ ] openapi document validate
 - [ ] 接口 mock
 - [ ] 接口运行期类型检查
+- [ ] unplugin
+- [ ] vue hook
+- [ ] react hook
+- [ ] 自定义 printer
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -4,41 +4,52 @@
   "description": "OpenAPI ➡️ Axios",
   "scripts": {
     "prepare": "husky install",
-    "dev": "vite build --watch",
     "build": "vite build",
-    "lint:es": "eslint --ext=.cjs,.mjs,.ts,.tsx src/ test/",
+    "lint:js": "eslint --ext=.cjs,.mjs,.ts,.tsx src test",
+    "lint:js:fix": "eslint --ext=.cjs,.mjs,.ts,.tsx src test --fix",
     "lint:type": " tsc --project tsconfig.json",
-    "lint": "npm run lint:es && npm run lint:type",
+    "lint": "npm run lint:js && npm run lint:type",
+    "lint:fix": "npm run lint:js:fix && npm run lint:type",
     "test": "vitest run",
     "test:coverage": "vitest run --coverage"
   },
   "engines": {
     "node": ">=14.21"
   },
   "sideEffects": false,
+  "main": "./dist-cjs/index.cjs",
+  "module": "./dist-esm/index.mjs",
   "type": "module",
-  "module": "dist/index.mjs",
-  "main": "dist/index.cjs",
-  "types": "dist/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs",
-      "types": "./dist/index.d.ts"
+      "import": "./dist-esm/index.mjs",
+      "require": "./dist-cjs/index.cjs",
+      "types": "./dist-types/index.d.ts"
     },
+    "./package.json": "./package.json",
     "./helpers": {
-      "import": "./dist/helpers.mjs",
-      "require": "./dist/helpers.cjs",
-      "types": "./dist/helpers.d.ts"
-    },
-    "./package.json": "./package.json"
+      "import": "./dist-esm/helpers.mjs",
+      "require": "./dist-cjs/helpers.cjs",
+      "types": "./dist-types/helpers.d.ts"
+    }
   },
-  "bin": {
-    "openapi-axios": "bin/index.cjs"
+  "types": "./dist-types/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./dist-types/index.d.ts",
+        "./dist-types/*"
+      ]
+    }
   },
   "files": [
-    "dist"
+    "dist-cjs",
+    "dist-esm",
+    "dist-types"
   ],
+  "bin": {
+    "openapi-axios": "bin/index.cjs"
+  },
   "keywords": [
     "cloudcome",
     "ydr.me",
@@ -56,11 +67,11 @@
   "repository": "https://github.com/FrontEndDev-org/openapi-axios",
   "license": "MIT",
   "dependencies": {
-    "axios": "^1.3.5",
+    "axios": "^1.3.6",
     "chalk": "^4.1.2",
     "lodash": "^4.17.21",
     "openapi-types": "^12.1.0",
-    "prettier": "^2.8.7",
+    "prettier": "^2.8.8",
     "strict-event-emitter": "^0.5.0",
     "try-flatten": "^1.1.0",
     "zod": "^3.21.4"
@@ -75,14 +86,14 @@
     "@typescript-eslint/eslint-plugin": "^5.59.0",
     "@typescript-eslint/parser": "^5.59.0",
     "@vitest/coverage-c8": "^0.30.1",
-    "eslint": "^8.38.0",
+    "eslint": "^8.39.0",
     "eslint-config-prettier": "^8.8.0",
-    "eslint-define-config": "^1.18.0",
+    "eslint-define-config": "^1.19.0",
     "eslint-plugin-prettier": "^4.2.1",
     "husky": "^8.0.3",
     "lint-staged": "^13.2.1",
     "typescript": "^5.0.4",
-    "vite": "^4.2.1",
+    "vite": "^4.3.1",
     "vite-plugin-dts": "^2.3.0",
     "vite-plugin-externalize-deps": "^0.5.0",
     "vitest": "^0.30.1"
diff --git a/src/const.ts b/src/const.ts
@@ -1,2 +1,2 @@
-export const pkgName = process.env.PKG_NAME!;
-export const pkgVersion = process.env.PKG_VERSION!;
+export const pkgName = process.env.PKG_NAME;
+export const pkgVersion = process.env.PKG_VERSION;
diff --git a/src/generators/Generator.ts b/src/generators/Generator.ts
@@ -6,7 +6,7 @@ import { normalizeError } from 'try-flatten';
 import { DocumentParser } from '../parsers/DocumentParser';
 import { DocumentPrinter } from '../printers/DocumentPrinter';
 import { Reader } from './Reader';
-import {
+import type {
   GeneratingOptions,
   GeneratingStage,
   GeneratorEmits,
diff --git a/src/generators/Logger.ts b/src/generators/Logger.ts
@@ -1,6 +1,6 @@
 import chalk from 'chalk';
 import path from 'path';
-import { GeneratorEmits } from './types';
+import type { GeneratorEmits } from './types';
 
 export class Logger {
   pipeStartEvent(...[payload]: GeneratorEmits['start']) {
diff --git a/src/generators/Reader.ts b/src/generators/Reader.ts
@@ -2,8 +2,8 @@ import axios from 'axios';
 import fs from 'fs';
 import path from 'path';
 import * as process from 'process';
-import { AcceptDocument } from '../parsers/types';
-import { OpenAPIV3Document } from '../types/openapi';
+import type { AcceptDocument } from '../parsers/types';
+import type { OpenAPIV3Document } from '../types/openapi';
 import { isString } from '../utils/type-is';
 
 export class Reader {
diff --git a/src/generators/command.ts b/src/generators/command.ts
@@ -5,7 +5,7 @@ import { tryFlatten } from 'try-flatten';
 import { z } from 'zod';
 import { Generator } from './Generator';
 import { Logger } from './Logger';
-import { GeneratorOptions } from './types';
+import type { GeneratorOptions } from './types';
 
 export function defineConfig(options: GeneratorOptions): GeneratorOptions {
   return options;
diff --git a/src/generators/types.ts b/src/generators/types.ts
@@ -1,6 +1,6 @@
-import { AcceptDocument, ParserOptions } from '../parsers/types';
-import { PrinterOptions } from '../printers/types';
-import { OpenAPIV3Document } from '../types/openapi';
+import type { AcceptDocument, ParserOptions } from '../parsers/types';
+import type { PrinterOptions } from '../printers/types';
+import type { OpenAPIV3Document } from '../types/openapi';
 
 type RequiredWith<T, K extends keyof T> = T & { [P in K]-?: T[P] };
 
diff --git a/src/helpers.ts b/src/helpers.ts
@@ -1,3 +1,5 @@
+export * from './const';
+
 // @ref https://github.com/drwpow/openapi-typescript/blob/bc52343c44f9dab4006e04c27411e405fb67a739/src/index.ts#L215
 export type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };
 export type XOR<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
diff --git a/src/index.ts b/src/index.ts
@@ -1,4 +1,4 @@
-export { pkgName, pkgVersion } from './const';
+export * from './const';
 export { defineConfig, run } from './generators/command';
 export { DocumentPrinter } from './printers/DocumentPrinter';
 export { DocumentParser } from './parsers/DocumentParser';
diff --git a/src/parsers/BaseParser.ts b/src/parsers/BaseParser.ts
@@ -1,8 +1,8 @@
 import * as process from 'process';
-import { OpenAPIV3, OpenAPIV3Document } from '../types/openapi';
+import type { OpenAPIV3, OpenAPIV3Document } from '../types/openapi';
 import { INTERNAL_TYPE_NAMES, JSON_MIME } from './const';
 import { Named } from './Named';
-import { ParserOptions, StrictParserOptions, TypeAlias, TypeItem } from './types';
+import type { ParserOptions, StrictParserOptions, TypeAlias, TypeItem } from './types';
 
 export class BaseParser {
   named = new Named();
diff --git a/src/parsers/ComponentsParser.ts b/src/parsers/ComponentsParser.ts
@@ -1,7 +1,7 @@
 import { OpenAPIV3 } from 'openapi-types';
 import { isBoolean } from '../utils/type-is';
 import { BaseParser } from './BaseParser';
-import { TypeAlias, TypeItem, TypeList, TypeOrigin, TypeUnit } from './types';
+import type { TypeAlias, TypeItem, TypeList, TypeOrigin, TypeUnit } from './types';
 
 export class ComponentsParser extends BaseParser {
   parseComponents(): TypeList {
diff --git a/src/parsers/DocumentParser.ts b/src/parsers/DocumentParser.ts
@@ -1,5 +1,5 @@
 import { PathsParser } from './PathsParser';
-import { TypeDocument } from './types';
+import type { TypeDocument } from './types';
 
 export class DocumentParser extends PathsParser {
   parse(): TypeDocument {
diff --git a/src/parsers/Named.ts b/src/parsers/Named.ts
@@ -1,5 +1,5 @@
 import { buildName, findOrigin, nextUniqueName, refToType } from '../utils/string';
-import { TypeAlias } from './types';
+import type { TypeAlias } from './types';
 
 export class Named {
   private aliasRelationMap = new Map<string /*source*/, string /*target*/>();
diff --git a/src/parsers/PathsParser.ts b/src/parsers/PathsParser.ts
@@ -1,7 +1,7 @@
 import { OpenAPIV3 } from 'openapi-types';
 import { ComponentsParser } from './ComponentsParser';
 import { BLOB_MIME, JSON_MIME, HTTP_METHODS } from './const';
-import { TypeItem, TypeList, TypeOperation, TypeOperations, TypeOrigin } from './types';
+import type { TypeItem, TypeList, TypeOperation, TypeOperations, TypeOrigin } from './types';
 
 export class PathsParser extends ComponentsParser {
   parsingUrl = '';
diff --git a/src/parsers/types.ts b/src/parsers/types.ts
@@ -1,4 +1,4 @@
-import { OpenAPIV3Document } from '../types/openapi';
+import type { OpenAPIV3Document } from '../types/openapi';
 
 export type TypeUnit = 'number' | 'string' | 'boolean' | 'never' | 'object' | 'array' | 'any';
 
diff --git a/src/printers/BasePrinter.ts b/src/printers/BasePrinter.ts
@@ -1,6 +1,6 @@
-import { TypeAlias, TypeDocument, TypeItem } from '../parsers/types';
+import type { TypeAlias, TypeDocument, TypeItem } from '../parsers/types';
 import { joinSlices } from '../utils/string';
-import { StrictPrinterOptions, PrinterOptions } from './types';
+import type { StrictPrinterOptions, PrinterOptions } from './types';
 import prettier from 'prettier';
 
 export class BasePrinter {
diff --git a/src/printers/CommentsPrinter.ts b/src/printers/CommentsPrinter.ts
@@ -1,4 +1,4 @@
-import { TypeComments, TypeItem } from '../parsers/types';
+import type { TypeComments, TypeItem } from '../parsers/types';
 import { joinSlices } from '../utils/string';
 import { isUndefined } from '../utils/type-is';
 import { BasePrinter } from './BasePrinter';
diff --git a/src/printers/ComponentsPrinter.ts b/src/printers/ComponentsPrinter.ts
@@ -1,4 +1,4 @@
-import { TypeItem, TypeOrigin } from '../parsers/types';
+import type { TypeItem, TypeOrigin } from '../parsers/types';
 import { joinSlices, toTypePath } from '../utils/string';
 import { BasePrinter } from './BasePrinter';
 import { CommentsPrinter } from './CommentsPrinter';
diff --git a/src/printers/PathsPrinter.ts b/src/printers/PathsPrinter.ts
@@ -1,6 +1,6 @@
-import { AxiosRequestConfig } from 'axios';
+import type { AxiosRequestConfig } from 'axios';
 import { groupBy } from 'lodash';
-import { TypeItem, TypeList, TypeOperation, TypeOperations, TypeOrigin } from '../parsers/types';
+import type { TypeItem, TypeList, TypeOperation, TypeOperations, TypeOrigin } from '../parsers/types';
 import { joinSlices, nextUniqueName, varString } from '../utils/string';
 import { isBoolean, isString } from '../utils/type-is';
 import { ComponentsPrinter } from './ComponentsPrinter';
diff --git a/src/printers/types.ts b/src/printers/types.ts
@@ -1,4 +1,4 @@
-import { Config } from 'prettier';
+import type { Config } from 'prettier';
 
 export interface PrinterOptions {
   axiosImport?: string;
diff --git a/src/types/env.shim.d.ts b/src/types/env.shim.d.ts
diff --git a/src/types/process.env.d.ts b/src/types/process.env.d.ts
@@ -0,0 +1,15 @@
+// @ref https://bobbyhadz.com/blog/typescript-process-env-type
+
+declare global {
+  namespace NodeJS {
+    interface ProcessEnv {
+      // package name
+      PKG_NAME: string;
+
+      // package version
+      PKG_VERSION: string;
+    }
+  }
+}
+
+export {};
diff --git a/test/generators/commands.test.ts b/test/generators/commands.test.ts
@@ -1,7 +1,7 @@
 import fs from 'fs';
 import path from 'path';
 import { configFileNameOrder, resolveConfig, resolveConfigFile, run } from '../../src/generators/command';
-import { OpenAPIV3Document } from '../../src/types/openapi';
+import type { OpenAPIV3Document } from '../../src/types/openapi';
 import { createTempDirname } from '../helpers';
 
 test('resolveConfigFile', async () => {
diff --git a/test/parsers/ComponentsPaser.test.ts b/test/parsers/ComponentsPaser.test.ts
@@ -1,6 +1,6 @@
 import { expect } from 'vitest';
 import { ComponentsParser } from '../../src/parsers/ComponentsParser';
-import { TypeAlias, TypeList } from '../../src/parsers/types';
+import type { TypeAlias, TypeList } from '../../src/parsers/types';
 
 test('empty components', async () => {
   const parser = new ComponentsParser({
diff --git a/test/parsers/DocumentParser.test.ts b/test/parsers/DocumentParser.test.ts
@@ -1,7 +1,7 @@
 import { OpenAPIV3 } from 'openapi-types';
 import { doc } from 'prettier';
 import { DocumentParser } from '../../src/parsers/DocumentParser';
-import { TypeDocument } from '../../src/parsers/types';
+import type { TypeDocument } from '../../src/parsers/types';
 import document from '../files/petStore3.openapi.json';
 import { writeFile } from '../helpers';
 
diff --git a/test/parsers/PathsParser.test.ts b/test/parsers/PathsParser.test.ts
@@ -1,6 +1,6 @@
 import { OpenAPIV3 } from 'openapi-types';
 import { PathsParser } from '../../src/parsers/PathsParser';
-import { TypeOperations } from '../../src/parsers/types';
+import type { TypeOperations } from '../../src/parsers/types';
 import HttpMethods = OpenAPIV3.HttpMethods;
 
 test('empty paths keys', async () => {
diff --git a/test/printers/DocumentPrinter.test.ts b/test/printers/DocumentPrinter.test.ts
@@ -1,5 +1,5 @@
-import { TypeDocument } from '../../src/parsers/types';
-import { DocumentPrinter } from '../../src/printers/DocumentPrinter';
+import type { TypeDocument } from '../../src/parsers/types';
+import { DocumentPrinter } from '../../src';
 
 import petStore3 from '../files/petStore3.types.json';
 import { writeFile } from '../helpers';
diff --git a/test/utils/string.test.ts b/test/utils/string.test.ts
@@ -3,7 +3,7 @@ import {
   findOrigin,
   joinSlices,
   nextUniqueName,
-  RefInfo,
+  type RefInfo,
   refToType,
   toTypePath,
   varString,
diff --git a/tsconfig.json b/tsconfig.json
@@ -8,6 +8,7 @@
     "esModuleInterop": true,
     "isolatedModules": true,
     "resolveJsonModule": true,
+    "verbatimModuleSyntax": true,
     "useDefineForClassFields": true,
     "allowSyntheticDefaultImports": true,
     "forceConsistentCasingInFileNames": true,
@@ -17,5 +18,5 @@
     "lib": ["Es2020"],
     "types": ["vitest/globals"]
   },
-  "include": ["src", "test", "vite.config.ts", "package.json"]
+  "include": ["src", "test", "package.json", "vite.config.ts"]
 }
diff --git a/vite.config.ts b/vite.config.ts
