feat: low version support prompt (#1)

Author: kinfuy

package/index.ts

@@ -1,20 +1,58 @@
+import { readFileSync } from 'fs';
+import { join } from 'path';
+import colors from 'picocolors';
 import { bindShortcuts } from './shortcuts';
 import type { Plugin, ViteDevServer } from 'vite';
 import type { CLIShortcut } from './shortcuts';
-
 export interface ShortcutsOptions {
   /**
    * @description default `Plugin Shortcuts`
    */
   outputName?: string;
   shortcuts: CLIShortcut[];
 }
+/**
+ * 查询版本号
+ * @param path
+ * @returns
+ */
+const queryViteVersion = (path: string) => {
+  const pkg = readFileSync(path, 'utf-8');
+  let version = 4;
+  if (pkg) {
+    try {
+      version =
+        JSON.parse(pkg)?.devDependencies?.vite?.match(
+          /^[^\d]*(?<version>[0-9])/
+        ).groups?.version || 4;
+    } catch (error) {}
+  }
+  return Number(version);
+};
 
 export function shortcutsPlugin(shortcutsOptions?: ShortcutsOptions): Plugin {
   return {
     name: 'shortcuts',
     apply: 'serve',
     configureServer: (server: ViteDevServer) => {
+      const path = join(server.config.root, 'package.json');
+      const version = queryViteVersion(path);
+      const _printUrls = server.printUrls;
+
+      // 改写printUrls 方法
+      // https://github.com/kinfuy/vite-plugin-shortcuts/issues/1
+      server.printUrls = () => {
+        _printUrls();
+        if (version < 4) {
+          server.config.logger.info(
+            colors.dim(colors.green('  ➜')) +
+              colors.dim('  press ') +
+              colors.bold('h') +
+              colors.dim(' to show help')
+          );
+        }
+      };
+
       return () => {
         bindShortcuts(server, shortcutsOptions);
       };

package/shortcuts.ts

@@ -24,6 +24,13 @@ export function bindShortcuts(
     .filter(isDefined)
     .concat(BASE_SHORTCUTS);
 
+  if (shortcuts.length === 0) {
+    server.config.logger.warn(
+      colors.yellow('No additional shortcut keys configured')
+    );
+    return;
+  }
+
   let actionRunning = false;
 
   const onInput = async (input: string) => {
@@ -42,7 +49,7 @@ export function bindShortcuts(
       server.config.logger.info(
         [
           '',
-          colors.bold(`   ${outputName}`),
+          colors.bold(`  ${outputName}`),
           ...shortcuts.map(
             (shortcut) =>
               colors.dim('  press ') +

playground/vue/package.json

@@ -13,7 +13,7 @@
     "vue": "^3.2.41"
   },
   "devDependencies": {
-    "vite-plugin-shortcuts": "^0.0.5",
+    "vite-plugin-shortcuts": "workspace:*",
     "vite": "^3.0.0",
     "@vitejs/plugin-vue": "^3.0.0",
     "js-yaml": "^4.1.0",

playground/vue/vite.config.ts

@@ -12,6 +12,7 @@ export default defineConfig({
   },
   plugins: [
     shortcutsPlugin({
+      outputName: '自定义快捷键',
       shortcuts: [
         {
           key: 'c',