Skip to content

Commit 4250291

Browse files
committed
docs(README): enhance documentation in README.md
1 parent 98eead0 commit 4250291

File tree

5 files changed

+811
-728
lines changed

5 files changed

+811
-728
lines changed

.github/workflows/ci.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,19 @@ jobs:
2020
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/
2121

2222
steps:
23-
- uses: actions/checkout@v3
24-
- uses: pnpm/action-setup@v2
23+
- uses: actions/checkout@v4
24+
- uses: pnpm/action-setup@v3
2525
with:
2626
version: 8
2727
- name: Use Node.js ${{ matrix.node-version }}
28-
uses: actions/setup-node@v3
28+
uses: actions/setup-node@v4
2929
with:
3030
node-version: ${{ matrix.node-version }}
3131
cache: 'pnpm'
3232
- run: pnpm i
3333
- run: pnpm run build
3434
- run: pnpm test
3535
- name: Upload coverage to Codecov
36-
uses: codecov/codecov-action@v3
36+
uses: codecov/codecov-action@v4
3737
env:
3838
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@
1515
Why `fast-maker`?
1616

1717
1. Zeor cost for routing configuration at runtime
18-
2. [Static analysis](https://en.wikipedia.org/wiki/Static_program_analysis): `fast-maker` generates typescript source code, so many errors can be found at compile time
19-
3. flexible routing: supports various routing such as variable joining, regular expressions, etc. for example, `/student/[grade]-[id]`, `/hero/:id/power/:id?`
20-
4. single way: there is only one way to create one routing configuration, so there is no risk of creating routing configurations in different ways even when collaborating
21-
5. less code conflicts: by excluding auto-generated code from the VCS, there is less chance of code conflicts when people collaborate
18+
2. [Static analysis](https://en.wikipedia.org/wiki/Static_program_analysis): The `fast-maker` generates the TypeScript source code. Because it does not generate the `route configuration` through dynamic analysis at runtime, it can find errors during the TypeScript compilation process
19+
3. flexible routing: supports various routing such as variable joining, regular expressions, etc. for example, `/student/:grade-:id` and `/hero/:id/power/:id?`, `/avengers/heroes/:id/:hour(^d{2})h:minute(^d{2})m`
20+
4. single way: there is only one way to generate one routing configuration, so there is no risk of generating routing configurations in different ways even when collaborating
21+
5. less code conflicts: by excluding auto-generated code from the VCS(eg. git), there is less chance of code conflicts when people collaborate
2222
6. beautiful CLI interface
2323
7. generate a route-map.ts file that summarizes routing information. It can be used for a variety of purposes, including logging. The route-map.ts file is useful because it is generated before run-time
2424

@@ -95,7 +95,7 @@ npx fast-maker route --help
9595
npx fast-maker init --help
9696
```
9797

98-
Also you can see detail option [here](/docs/options.md).
98+
Also you can see detail option [here](docs/options.md).
9999

100100
## Url building
101101

examples/handlers/justice/[dc-league]/hello/get.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ import schema from '../../../interfaces/JSC_IReqPokeHello';
55

66
export const map: string = 'test';
77

8-
export const methods: number = 1;
9-
108
export const option: RouteShorthandOptions = {
119
schema: {
1210
querystring: schema.properties?.Querystring,

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@
8585
"@vitest/coverage-v8": "^1.1.0",
8686
"concurrently": "^8.2.2",
8787
"cross-env": "^7.0.3",
88-
"ctix": "^2.3.0",
88+
"ctix": "^2.4.0",
8989
"deps-diff": "^1.0.2",
9090
"esbuild": "^0.19.10",
9191
"eslint": "^8.36.0",
@@ -138,7 +138,7 @@
138138
"mathjs": "^12.2.1",
139139
"minimist": "^1.2.8",
140140
"my-easy-fp": "^0.22.0",
141-
"my-node-fp": "^0.9.0",
141+
"my-node-fp": "^0.10.3",
142142
"my-only-either": "^1.3.0",
143143
"ora": "^5.4.1",
144144
"prettier": "^3.2.4",

0 commit comments

Comments
 (0)