vladimirmikulic / route-list Goto Github PK

Folder in node_modules:

This library should support async apps (awaiting the default import of the app)

My apps usually have an async startup and this library cannot be used on my app.
This library would be useful if it resolved any promises returned by the app.

Hi there!

When I tried this package, I gave the following input:

route-list --group --methods source/app.ts

# I also tried:
route-list --group --methods ./source/app.ts

I got the following error/output message:

error: missing required argument 'appjs-file'

Usage: route-list [options] <appjs-file>

Beautifully shows Express/Koa/Hapi/Fastify routes in CLI.

Options:
  -g, --group                  Display routes in groups separated with new line
  -m, --methods <methods>      Include routes registered for HTTP method(s)
  -i, --include-paths <paths>  Include routes starting with path(s)
  -e, --exclude-paths <paths>  Exclude routes starting with path(s)
  -V, --version                output the version number
  -h, --help                   display help for command

Examples:
  $ route-list server/app.js
  $ route-list --methods GET,POST server/app.js
  $ route-list --include-paths /users,/events server/app.js

This is my folder structure
(./source/app.ts file contains the const app: Express = express(); initialization):

.
├── build/
│ └── ...
├── coverage/
│ └── ...
├── node_modules/
│ └── ...
├── source/
│ ├── db/
│ ├── handlers/
│ ├── middlewares/
│ ├── public/
│ ├── repository/
│ ├── routes/
│ ├── schemas/
│ ├── services/
│ ├── types/
│ ├── utils/
│ ├── views/
│ ├── app.ts
│ └── index.ts
├── .env.example
├── jest.config.ts
├── package-lock.json
├── package.json
├── README.md
└── tsconfig.json

Additional Info:

• Node.js v16.17.0
• Express v4.18.2
• TypeScript v4.8.4

When the package is used on a typescript project the project is compiled and output-ed to a routelist folder.
I think a better user experience would be if there was no output and ts-node was used instead of TSC.

npx route-list ./src/api/app.js
Only file and data URLs are supported by the default ESM loader. On Windows, absolute paths must be valid file:// URLs. Received
protocol 'd:'

Do you have any plans to make it also as a middleware or library for express or koa?
As one time usage, by passing application object, in case of express, into a function from this project.
Would be great, kind of hapi-print-routes!

Good work!