Skip to content

Commit

Permalink
📃 docs: 更新 README
Browse files Browse the repository at this point in the history
  • Loading branch information
hmydgz committed Jul 26, 2024
1 parent 926062a commit 9339ad3
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 4 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ English | [简体中文](./README.zh_CN.md)

A plugin provided for the `Nest` project to quickly jump to code blocks through interface addresses

By querying the access path for matching Controllers and Methods, it is possible to jump to the corresponding function definition
By querying the access path for matching `Controllers` and `Methods`, it is possible to jump to the corresponding function definition

![priview](https://github.com/hmydgz/nestjs-route-jumper/raw/main/doc/images/priview.gif)

Expand All @@ -16,7 +16,11 @@ Open it through the Nest icon in the sidebar, where you can enter the interface

## Illustrate

Currently, it supports querying routes explicitly declared by decorators exported using `@nestjs/common`, as well as [Router module](https://docs.nestjs.com/recipes/router-module), Custom decorators and third-party packages are currently not supported
Currently supported queries for routing-related functionality
1. routes declared by the `@Controller` `@Get` `@Post` `@Put` `@Patch` `@Delete` `@Options` `@Head` `@All` `@Version` decorator exported from `@nestjs/common`.
2. routes handled by the [Router module](https://docs.nestjs.com/recipes/router-module) in `nest`. ![priview](https://github.com/hmydgz/nestjs-route-jumper/raw/main/doc/images/router_module.png)
3. single inheritance for classes that support `@Controller`. ![priview](https://github.com/hmydgz/nestjs-route-jumper/raw/main/doc/images/controller_extend.png)
4. Supports the [standard mode / monorepo mode](https://docs.nestjs.com/cli/monorepo#monorepo-mode).

## Visual Studio Marketplace

Expand Down
8 changes: 6 additions & 2 deletions README.zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

`Nest` 项目提供的一个通过接口访问路径快速跳转到代码块的插件

通过访问路径查询对可匹配的 Controller 和 Method,可跳转到对应的函数定义处
通过访问路径查询对可匹配的 `Controller``Method`,可跳转到对应的函数定义处

![priview](https://github.com/hmydgz/nestjs-route-jumper/raw/main/doc/images/priview.gif)

Expand All @@ -16,7 +16,11 @@

## 说明

目前支持查询使用 `@nestjs/common` 导出的装饰器显式声明的路由,和 [Router module](https://docs.nestjs.com/recipes/router-module),自定义装饰器与第三方包暂不支持
目前支持查询的路由相关功能
1. 通过从 `@nestjs/common` 导出的 `@Controller` `@Get` `@Post` `@Put` `@Patch` `@Delete` `@Options` `@Head` `@All` `@Version` 装饰器声明的路由;
2. `nest` 中的 [Router module](https://docs.nestjs.com/recipes/router-module) 处理的路由; ![priview](https://github.com/hmydgz/nestjs-route-jumper/raw/main/doc/images/router_module.png)
3. 支持 `@Controller` 的类的单继承; ![priview](https://github.com/hmydgz/nestjs-route-jumper/raw/main/doc/images/controller_extend.png)
4. 支持 [standard mode / monorepo mode](https://docs.nestjs.com/cli/monorepo#monorepo-mode);

## Visual Studio Marketplace

Expand Down
Binary file added doc/images/controller_extend.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/router_module.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9339ad3

Please sign in to comment.