Skip to content

fix: add @deprecated to NgrokV1Proxy #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
odanado merged 4 commits into from
Jun 10, 2025
+7 −5
Merged

fix: add @deprecated to NgrokV1Proxy #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bb3fd1c
add @deprecated to NgrokV1Proxy
odanado Jun 4, 2025
3c289d0
update README.md
odanado Jun 4, 2025
d9f9150
fix description of --proxy-type
odanado Jun 9, 2025
baf9096
fix test
odanado Jun 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ $ mkcert localhost
#### When using `ngrok-v1`

> [!WARNING]
> This feature is experimental.
> This feature is deprecated.

Before using the `serve` command, you need to install [ngrok](https://github.com/inconshreveable/ngrok) and [node-pty](https://www.npmjs.com/package/node-pty).

Expand Down
2 changes: 1 addition & 1 deletion src/serve/commands/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export const installServeCommands = (program: Command) => {
)
.option(
"--proxy-type <proxyType>",
"The type of proxy to use. local-proxy, ngrok-v1, or ngrok",
"The type of proxy to use. local-proxy or ngrok",
"local-proxy",
)
.option(
Expand Down
2 changes: 1 addition & 1 deletion src/serve/proxy/ngrok-v1-proxy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ async function tryImportNodePty(): Promise<typeof pty> {
}

/**
* @experimental
* @deprecated
*/
export class NgrokV1Proxy implements ProxyInterface {
private ptyProcess?: pty.IPty;
Expand Down
4 changes: 3 additions & 1 deletion src/serve/resolveProxy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ export const resolveProxy = (
}

if (options.proxyType === "ngrok-v1") {
console.warn("ngrok-v1 is experimental feature.");
console.warn(
`proxyType 'ngrok-v1' is deprecated. Please use 'ngrok' instead.`,
);

@kazuma0129 kazuma0129 Jun 5, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/line/liff-cli/blob/add-deprecated-tag-ngrok-v1/src/serve/commands/index.ts#L22

I think it would be fine to remove it from this description. What do you think?

@odanado odanado Jun 9, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see.
I fixed it.
d9f9150

return {
liffAppProxy: new NgrokV1Proxy({
ngrokCommand: options.ngrokCommand,
Expand Down
2 changes: 1 addition & 1 deletion src/setup.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Options:
--host <host> The host of the application server.
--port <port> The port number of the application server.
-i, --inspect The flag indicates LIFF app starts on debug mode. (default: false)
--proxy-type <proxyType> The type of proxy to use. local-proxy, ngrok-v1, or ngrok (default: "local-proxy")
--proxy-type <proxyType> The type of proxy to use. local-proxy or ngrok (default: "local-proxy")
--local-proxy-port <localProxyPort> The port number of the application proxy server to listen on when running the CLI. (default: "9000")
--local-proxy-inspector-port <localProxyInspectorPort> The port number of the inspector proxy server to listen on when running the CLI. (default: "9223")
--ngrok-command <ngrokCommand> The command to run ngrok. (default: "ngrok")
Expand Down