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

Feat/v0.x

Author: cloudcome

.commitlintrc.cjs

@@ -0,0 +1,6 @@
+/**
+ * @type {import('@commitlint/types').UserConfig}
+ */
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+};

.eslintignore

@@ -0,0 +1,43 @@
+# Macos
+.DS_Store
+
+# Node
+node_modules
+package-lock.json
+pnpm-lock.yaml
+yarn.lock
+
+# local env files
+.env.local
+.env.*.local
+
+# Log files
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Editor directories and files
+.idea
+.vscode
+!.vscode/extensions.json
+
+# dist and cache
+/dist
+/dist-*
+/dist_*
+.cache
+
+# testing
+/coverage
+
+# next.js
+.next
+/out
+/build
+
+# nuxt.js
+.nuxt
+.nitro
+.output

.eslintrc.cjs

@@ -0,0 +1,24 @@
+const { defineConfig } = require('eslint-define-config');
+
+module.exports = defineConfig({
+  root: true,
+
+  env: {
+    browser: true,
+    node: true,
+    es2022: true,
+  },
+
+  parser: '@typescript-eslint/parser',
+
+  extends: [
+    //
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+
+  rules: {
+    'prettier/prettier': 'error',
+  },
+});

.husky/README.md

@@ -0,0 +1,4 @@
+```shell
+chmod +x commit-msg
+chmod +x pre-commit
+```

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx commitlint --edit "$1"

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

.lintstagedrc.cjs

@@ -0,0 +1,4 @@
+module.exports = {
+  '*.ts': 'eslint --fix',
+  '*': 'prettier --ignore-unknown --write',
+};

.prettierignore

@@ -0,0 +1,43 @@
+# Macos
+.DS_Store
+
+# Node
+node_modules
+package-lock.json
+pnpm-lock.yaml
+yarn.lock
+
+# local env files
+.env.local
+.env.*.local
+
+# Log files
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Editor directories and files
+.idea
+.vscode
+!.vscode/extensions.json
+
+# dist and cache
+/dist
+/dist-*
+/dist_*
+.cache
+
+# testing
+/coverage
+
+# next.js
+.next
+/out
+/build
+
+# nuxt.js
+.nuxt
+.nitro
+.output

.prettierrc.cjs

@@ -0,0 +1,7 @@
+/**
+ * @type {import('prettier').Config}
+ */
+module.exports = {
+  tabWidth: 2,
+  singleQuote: true,
+};

README.md

@@ -2,16 +2,44 @@
 
 OpenAPI Specification ➡️ TypeScript
 
-# 安装
+# Install
 
 ```shell
 npm i -D oas-gen-ts
 ```
 
-# 使用
+# Usage
 
-## 命令行
+## 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.
+
+```ts
+// oas.config.mjs
+export default defineConfig({
+  axiosImport: `import { axios } from '@/util/axios';`,
+  list: [
+    {
+      name: 'pet',
+      url: 'https://petstore3.swagger.io/api/v3/openapi.json',
+    },
+  ],
+});
+```
+
+```shell
+# Generate typescript files based on configuration files
+npx oas-gen-ts
+
+# The `src/apis/pet.ts` file will be generated
+```
 
 ## API
 
-[](https://)
+```ts
+import { generate } from 'oas-gen-ts';
+
+generate({
+  // ...
+});
+```