feat: add new helper to create api with default settings and add testing

Author: anbraten

.env.example

@@ -0,0 +1 @@
+TEST_GITEA_TOKEN=

.github/workflows/tests.yml

@@ -8,71 +8,77 @@ on:
       - main
 
 jobs:
-  # unit-tests:
-  #   name: Unit tests
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - name: Checkout
-  #       uses: actions/checkout@v2
-  #       with:
-  #         fetch-depth: 0
+  unit-tests:
+    name: Unit tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
 
-  #     - name: Setup Node.js
-  #       uses: actions/setup-node@v2
-  #       with:
-  #         node-version: '14'
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '14'
 
-  #     - name: Cache pnpm modules
-  #       uses: actions/cache@v2
-  #       with:
-  #         path: ~/.pnpm-store
-  #         key: ${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
-  #         restore-keys: |
-  #           ${{ runner.os }}-
+      - name: Cache pnpm modules
+        uses: actions/cache@v2
+        with:
+          path: ~/.pnpm-store
+          key: ${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-
 
-  #     - uses: pnpm/[email protected]
-  #       with:
-  #         version: 6
-  #         run_install: true
+      - uses: pnpm/[email protected]
+        with:
+          version: 6
+          run_install: true
 
-  #     - name: Unit test
-  #       run: pnpm run test
+      - name: Generate api
+        run: pnpm generate:api
 
-  #     - uses: artiomtr/[email protected]
-  #       if: "github.event_name == 'pull_request'"
-  #       with:
-  #         github-token: ${{ secrets.GITHUB_TOKEN }}
-  #         skip-step: all
+      - name: Unit test
+        run: pnpm coverage
 
-  # typecheck:
-  #   name: Typecheck
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - name: Checkout
-  #       uses: actions/checkout@v2
-  #       with:
-  #         fetch-depth: 0
+      # - uses: artiomtr/[email protected]
+      #   if: "github.event_name == 'pull_request'"
+      #   with:
+      #     github-token: ${{ secrets.GITHUB_TOKEN }}
+      #     skip-step: all
 
-  #     - name: Setup Node.js
-  #       uses: actions/setup-node@v2
-  #       with:
-  #         node-version: '14'
+  typecheck:
+    name: Typecheck
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
 
-  #     - name: Cache pnpm modules
-  #       uses: actions/cache@v2
-  #       with:
-  #         path: ~/.pnpm-store
-  #         key: ${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
-  #         restore-keys: |
-  #           ${{ runner.os }}-
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '14'
 
-  #     - uses: pnpm/[email protected]
-  #       with:
-  #         version: 6
-  #         run_install: true
+      - name: Cache pnpm modules
+        uses: actions/cache@v2
+        with:
+          path: ~/.pnpm-store
+          key: ${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-
+
+      - uses: pnpm/[email protected]
+        with:
+          version: 6
+          run_install: true
+
+      - name: Generate api
+        run: pnpm generate:api
 
-  #     - name: Typecheck
-  #       run: pnpm run typecheck
+      - name: Typecheck
+        run: pnpm typecheck
 
   # lint:
   #   name: Lint

.gitignore

@@ -1,9 +1,9 @@
 node_modules
 dist/
 docs/
-src/*
-!src/.gitkeep
 coverage/
 junit.xml
 *.tgz
-report.json
+report.json
+.env
+src/api.ts

.prettierignore

@@ -2,5 +2,5 @@ dist/
 coverage/
 pnpm-lock.yaml
 report.json
-src/
+src/api.ts
 docs/

README.md

@@ -8,33 +8,32 @@
 
 Gitea-js is an api client created based on the official [swagger definition](https://gitea.com/swagger.v1.json) from Gitea. Generated client uses [Fetch Api](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) (native browser support) to make requests.
 
-## Exsamples
+## Examples
 
 ### Browser
 
 ```ts
 import { Api } from 'gitea-js';
 
-const api = new Api({
-  baseUrl: 'https://try.gitea.com/',
+const api = new giteaApi('https://try.gitea.com/', {
+  token: 'access-token', // generate one at https://gitea.example.com/user/settings/applications
 });
 
-const api = new Api();
 const repo = api.repos.repoGet('anbraten', 'gitea-js');
 console.log(repo);
 ```
 
 ### Node.js
 
 ```js
-const { Api } = require('gitea-js');
-const fetch = require('node-fetch'); // You have to use node-fetch dependency for Node.JS
+const { createApi } = require('gitea-js');
+const fetch = require('cross-fetch'); // You have to use a fetch compatible polyfill like cross-fetch for Node.JS
 
-const api = new Api({
-  baseUrl: 'https://try.gitea.com/',
+const api = new giteaApi('https://try.gitea.com/', {
+  token: 'access-token', // generate one at https://gitea.example.com/user/settings/applications
+  customFetch: fetch,
 });
 
-const api = new Api({ customFetch: fetch });
 const repo = api.repos.repoGet('anbraten', 'gitea-js');
 console.log(repo);
 ```

package.json

@@ -19,24 +19,33 @@
   ],
   "scripts": {
     "download": "wget https://gitea.com/swagger.v1.json -O ./src/swagger.json",
-    "generate:api": "swagger-typescript-api -p ./src/swagger.json -o ./src -n index.ts",
+    "generate:api": "swagger-typescript-api -p https://gitea.com/swagger.v1.json -o ./src -n api.ts",
     "generate:docs": "typedoc ./src/index.ts",
     "generate": "pnpm generate:api && pnpm generate:docs",
     "build": "tsup src/index.ts --dts --format cjs,esm",
     "all": "pnpm download && pnpm generate && pnpm build",
     "clean": "rm -rf dist/ node_modules/",
+    "test": "dotenv vitest",
+    "test:ui": "pnpm test -- --ui",
+    "coverage": "pnpm test run -- --coverage",
     "lint:format": "prettier --check .",
     "typecheck": "tsc --noEmit",
     "release": "semantic-release"
   },
   "devDependencies": {
     "@geprog/semantic-release-config": "1.0.0",
     "@types/node": "17.0.13",
+    "@vitest/ui": "0.5.9",
+    "c8": "7.11.0",
+    "cross-fetch": "3.1.5",
+    "dotenv-cli": "5.0.0",
     "prettier": "2.5.1",
     "semantic-release": "19.0.2",
     "swagger-typescript-api": "9.3.1",
     "tsup": "5.11.13",
     "typedoc": "0.22.11",
-    "typescript": "4.5.5"
+    "typescript": "4.5.5",
+    "vite": "2.8.6",
+    "vitest": "0.5.9"
   }
 }