Skip to content

Commit

Permalink
docs(README): enhance documentation in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
imjuni committed Feb 25, 2024
1 parent 98eead0 commit 8f7968a
Show file tree
Hide file tree
Showing 4 changed files with 807 additions and 724 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
Why `fast-maker`?

1. Zeor cost for routing configuration at runtime
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
3. flexible routing: supports various routing such as variable joining, regular expressions, etc. for example, `/student/[grade]-[id]`, `/hero/:id/power/:id?`
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
5. less code conflicts: by excluding auto-generated code from the VCS, there is less chance of code conflicts when people collaborate
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
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`
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
5. less code conflicts: by excluding auto-generated code from the VCS(eg. git), there is less chance of code conflicts when people collaborate
6. beautiful CLI interface
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

Expand Down Expand Up @@ -95,7 +95,7 @@ npx fast-maker route --help
npx fast-maker init --help
```

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

## Url building

Expand Down
2 changes: 0 additions & 2 deletions examples/handlers/justice/[dc-league]/hello/get.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ import schema from '../../../interfaces/JSC_IReqPokeHello';

export const map: string = 'test';

export const methods: number = 1;

export const option: RouteShorthandOptions = {
schema: {
querystring: schema.properties?.Querystring,
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
"@vitest/coverage-v8": "^1.1.0",
"concurrently": "^8.2.2",
"cross-env": "^7.0.3",
"ctix": "^2.3.0",
"ctix": "^2.4.0",
"deps-diff": "^1.0.2",
"esbuild": "^0.19.10",
"eslint": "^8.36.0",
Expand Down Expand Up @@ -138,7 +138,7 @@
"mathjs": "^12.2.1",
"minimist": "^1.2.8",
"my-easy-fp": "^0.22.0",
"my-node-fp": "^0.9.0",
"my-node-fp": "^0.10.3",
"my-only-either": "^1.3.0",
"ora": "^5.4.1",
"prettier": "^3.2.4",
Expand Down
Loading

0 comments on commit 8f7968a

Please sign in to comment.