From bb3fd1ce8741df46681afd5399ec41b59085bf32 Mon Sep 17 00:00:00 2001 From: "tomoya.kita" Date: Wed, 4 Jun 2025 20:57:36 +0900 Subject: [PATCH 1/4] add @deprecated to NgrokV1Proxy --- src/serve/proxy/ngrok-v1-proxy.ts | 2 +- src/serve/resolveProxy.ts | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/src/serve/proxy/ngrok-v1-proxy.ts b/src/serve/proxy/ngrok-v1-proxy.ts index 950d102..f297bfb 100644 --- a/src/serve/proxy/ngrok-v1-proxy.ts +++ b/src/serve/proxy/ngrok-v1-proxy.ts @@ -25,7 +25,7 @@ async function tryImportNodePty(): Promise { } /** - * @experimental + * @deprecated */ export class NgrokV1Proxy implements ProxyInterface { private ptyProcess?: pty.IPty; diff --git a/src/serve/resolveProxy.ts b/src/serve/resolveProxy.ts index 1844abf..01bb488 100644 --- a/src/serve/resolveProxy.ts +++ b/src/serve/resolveProxy.ts @@ -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.`, + ); return { liffAppProxy: new NgrokV1Proxy({ ngrokCommand: options.ngrokCommand, From 3c289d02976d2ecf4d48fc9f180ebe80eb57f3f1 Mon Sep 17 00:00:00 2001 From: "tomoya.kita" Date: Wed, 4 Jun 2025 21:04:38 +0900 Subject: [PATCH 2/4] update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 02b89f5..b60ff9d 100644 --- a/README.md +++ b/README.md @@ -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). From d9f9150a169705cb840b0c7ba7d02a0668374e7c Mon Sep 17 00:00:00 2001 From: "tomoya.kita" Date: Mon, 9 Jun 2025 21:39:36 +0900 Subject: [PATCH 3/4] fix description of --proxy-type --- src/serve/commands/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/serve/commands/index.ts b/src/serve/commands/index.ts index d331c93..4b063ab 100644 --- a/src/serve/commands/index.ts +++ b/src/serve/commands/index.ts @@ -19,7 +19,7 @@ export const installServeCommands = (program: Command) => { ) .option( "--proxy-type ", - "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( From baf90961c2c9a15637833ed9eb91939458fff4ed Mon Sep 17 00:00:00 2001 From: "tomoya.kita" Date: Mon, 9 Jun 2025 21:54:49 +0900 Subject: [PATCH 4/4] fix test --- src/setup.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/setup.test.ts b/src/setup.test.ts index 22d8573..7bf26fa 100644 --- a/src/setup.test.ts +++ b/src/setup.test.ts @@ -107,7 +107,7 @@ Options: --host The host of the application server. --port The port number of the application server. -i, --inspect The flag indicates LIFF app starts on debug mode. (default: false) - --proxy-type The type of proxy to use. local-proxy, ngrok-v1, or ngrok (default: "local-proxy") + --proxy-type The type of proxy to use. local-proxy or ngrok (default: "local-proxy") --local-proxy-port The port number of the application proxy server to listen on when running the CLI. (default: "9000") --local-proxy-inspector-port The port number of the inspector proxy server to listen on when running the CLI. (default: "9223") --ngrok-command The command to run ngrok. (default: "ngrok")