Skip to content
This repository has been archived by the owner on Jun 27, 2024. It is now read-only.

Commit

Permalink
refactor: final tweaks before v1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
boywithkeyboard committed Jul 16, 2023
1 parent 82f2c73 commit abe75f4
Show file tree
Hide file tree
Showing 7 changed files with 45 additions and 61 deletions.
2 changes: 1 addition & 1 deletion .github/cheetah.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion .github/update_license_year.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { walk } from 'https://deno.land/std@0.194.0/fs/walk.ts'

for await (const entry of walk(Deno.cwd(), { exts: ['ts'] })) {
for await (const entry of walk(Deno.cwd(), { exts: ['ts', 'tsx'] })) {
if (!entry.isFile) {
continue
}
Expand Down
36 changes: 36 additions & 0 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: check

on:
- push
- pull_request

jobs:
check:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3

- name: Setup Deno
uses: denoland/setup-deno@v1
with:
deno-version: v1.x

- name: Run deno fmt
run: deno fmt --check

- name: Run deno lint
run: deno lint

- name: Run deno test
run: deno task test --fail-fast

- name: Run deno test
run: deno task test --fail-fast

- name: Check license headers
run: |
deno run -A --no-check https://deno.land/x/anzu@1.0.0/src/cli.ts \
-i ./ "/.+\.ts/" \
-l "// Copyright 2023 Samuel Kopp. All rights reserved. Apache-2.0 license." \
-p
20 changes: 0 additions & 20 deletions .github/workflows/publish.yml

This file was deleted.

20 changes: 0 additions & 20 deletions .github/workflows/test.yml

This file was deleted.

8 changes: 0 additions & 8 deletions .vscode/settings.json

This file was deleted.

18 changes: 7 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,16 @@
## Sneak Peek

```ts
import cheetah from 'https://deno.land/x/cheetah@v0.13.0/mod.ts'
import cheetah from 'https://deno.land/x/cheetah/mod.ts'

const app = new cheetah()
.get('/', () => 'Hello World')

Deno.serve(app.fetch)
app.serve()
```

Please read our [guide](https://cheetah.mod.land) to learn more.

## Release Schedule

We strictly follow [SemVer](https://semver.org) and release updates in two channels:
Expand All @@ -57,16 +59,10 @@ We strictly follow [SemVer](https://semver.org) and release updates in two chann

## Benchmark

[//]: bstart

| Channel | Avg | Max | p75 | p90 | p95 | p99 |
| --- | --- | --- | --- | --- | --- | --- |
|[**current**](https://deno.land/x/cheetah@v0.13.0) <sup>v0.13.0</sup> | 29749 | 33993 | 32603 | 33287 | 33561 | 33993 |
|[**canary**](https://deno.land/x/cheetah@v1.0.0-canary.1) <sup>v1.0.0-canary.1</sup> | 30683 | 34999 | 33449 | 33818 | 34039 | 34999 |

[//]: bend
We don't benchmark cheetah against other modules ourselves, but there are some well-written resources that might be worth checking out:

###### A basic [RPS](https://www.google.com/search?q=requests+per+second) benchmark conducted with [oha](https://github.com/hatoo/oha).
1. [denosaurs/bench](https://github.com/denosaurs/bench)
2. [Im-Beast/http_benchmarks](https://github.com/Im-Beast/http_benchmarks)

## Contributing

Expand Down

0 comments on commit abe75f4

Please sign in to comment.