-
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: development server commands and search docs (#65)
This PR implements commands and integrated documentation search when running the development server. The developer can start typing in the terminal, and the server auto-suggests commands and search results. When the search term is more than 2 characters it will search the documentation using Algolia search and selecting a search result will open it in the default browser. #### Available commands - Restart the development server 🔄 - Reload the application 🔥 - Print the server URLs 🔗 - Clear the console 🧹 - Open application in the default browser 🌐 - Quit the development server 🚫 _This PR also decorates core development server messages with emojis to have more fun while using `@lazarv/react-server`!_
- Loading branch information
Showing
8 changed files
with
651 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,209 @@ | ||
| import readline from "node:readline"; | ||
| import { PassThrough } from "node:stream"; | ||
| import { setTimeout } from "node:timers/promises"; | ||
|
|
||
| import { search } from "@inquirer/prompts"; | ||
| import { algoliasearch } from "algoliasearch"; | ||
| import open from "open"; | ||
| import colors from "picocolors"; | ||
|
|
||
| const algolia = { | ||
| appId: "OVQLOZDOSH", | ||
| apiKey: "5a8224f70c312c69121f92482ff2df82", | ||
| indexName: "react-server", | ||
| }; | ||
|
|
||
| let algoliaClient; | ||
| let stdin; | ||
| export async function command({ logger, server, resolvedUrls, restartServer }) { | ||
| if (!process.stdin.isTTY) return; | ||
|
|
||
| if (!stdin) { | ||
| stdin = new PassThrough(); | ||
| process.stdin.pipe(stdin); | ||
|
|
||
| // catch SIGINT and exit | ||
| process.stdin.on("data", (key) => { | ||
| if (key == "\u0003") { | ||
| process.exit(0); | ||
| } | ||
| }); | ||
|
|
||
| readline.emitKeypressEvents(process.stdin); | ||
| process.stdin.setRawMode(true); | ||
|
|
||
| algoliaClient = algoliasearch(algolia.appId, algolia.apiKey); | ||
| } | ||
|
|
||
| const controller = new AbortController(); | ||
| const availableCommands = { | ||
| r: { | ||
| name: "Restart the development server 🔄", | ||
| async execute() { | ||
| logger?.warn?.(`Restarting server... 🚧`); | ||
| controller.abort(); | ||
| }, | ||
| }, | ||
| l: { | ||
| name: "Reload the application 🔥", | ||
| execute: () => { | ||
| server.environments.client.hot.send({ | ||
| type: "full-reload", | ||
| path: "*", | ||
| }); | ||
| }, | ||
| }, | ||
| u: { | ||
| name: "Print the server URLs 🔗", | ||
| execute: () => { | ||
| server.printUrls(resolvedUrls); | ||
| }, | ||
| }, | ||
| c: { | ||
| name: "Clear the console 🧹", | ||
| execute: () => { | ||
| console.clear(); | ||
| logger?.info?.(`${colors.green("✔")} Console cleared! 🧹`); | ||
| }, | ||
| }, | ||
| o: { | ||
| name: "Open application in the default browser 🌐", | ||
| execute: () => { | ||
| open(resolvedUrls[0].toString()); | ||
| }, | ||
| }, | ||
| q: { | ||
| name: "Quit the development server 🚫", | ||
| execute: () => { | ||
| process.exit(0); | ||
| }, | ||
| }, | ||
| }; | ||
| const timeFormatter = new Intl.DateTimeFormat(undefined, { | ||
| hour: "numeric", | ||
| minute: "numeric", | ||
| second: "numeric", | ||
| }); | ||
| let activeCommand = false; | ||
| let searchCommands = {}; | ||
| const command = async () => { | ||
| if (activeCommand) return; | ||
| try { | ||
| activeCommand = true; | ||
|
|
||
| const answer = await search( | ||
| { | ||
| message: "", | ||
| theme: { | ||
| prefix: { | ||
| idle: | ||
| colors.gray(timeFormatter.format(new Date())) + | ||
| colors.bold(colors.cyan(" [react-server]")), | ||
| done: | ||
| colors.gray(timeFormatter.format(new Date())) + | ||
| colors.bold(colors.cyan(" [react-server]")), | ||
| }, | ||
| style: { | ||
| answer: colors.white, | ||
| highlight: (message) => colors.bold(colors.magenta(message)), | ||
| message: () => colors.green("➜"), | ||
| }, | ||
| }, | ||
| source: async (input, { signal }) => { | ||
| if (!input) { | ||
| return Object.entries(availableCommands).map( | ||
| ([value, command]) => ({ ...command, value }) | ||
| ); | ||
| } | ||
|
|
||
| const term = input.toLowerCase().trim(); | ||
|
|
||
| let results = []; | ||
| if (term.length > 2) { | ||
| await setTimeout(300); | ||
| if (signal.aborted) return []; | ||
|
|
||
| const { hits } = await algoliaClient.searchSingleIndex({ | ||
| indexName: algolia.indexName, | ||
| searchParams: { | ||
| query: term, | ||
| }, | ||
| }); | ||
|
|
||
| searchCommands = {}; | ||
| results = hits.map((hit) => { | ||
| const command = { | ||
| value: hit.url, | ||
| name: `Open ${Object.values(hit.hierarchy).reduce( | ||
| (acc, value) => | ||
| value | ||
| ? acc.length > 0 | ||
| ? `${acc} > ${value}` | ||
| : colors.bold("https://react-server.dev") | ||
| : acc, | ||
| "" | ||
| )} 🔍`, | ||
| execute: () => { | ||
| open(hit.url); | ||
| }, | ||
| }; | ||
| searchCommands[command.value] = command; | ||
| return command; | ||
| }); | ||
| } | ||
|
|
||
| return [ | ||
| ...Object.entries(availableCommands) | ||
| .reduce((source, [value, command]) => { | ||
| const name = command.name.toLowerCase().trim(); | ||
| if (name.startsWith(term) || name.includes(term)) { | ||
| source.push({ ...command, value }); | ||
| } | ||
| return source; | ||
| }, []) | ||
| .toSorted((a, b) => { | ||
| // if the term is at the beginning of the name, it should be sorted first | ||
| if (a.name.toLowerCase().trim().startsWith(term)) { | ||
| return -1; | ||
| } | ||
| if (b.name.toLowerCase().trim().startsWith(term)) { | ||
| return 1; | ||
| } | ||
| return a.name.localeCompare(b.name); | ||
| }), | ||
| ...results, | ||
| ]; | ||
| }, | ||
| }, | ||
| { | ||
| input: stdin, | ||
| signal: controller.signal, | ||
| } | ||
| ); | ||
|
|
||
| const selectedCommand = | ||
| availableCommands[answer] ?? searchCommands[answer]; | ||
| if (selectedCommand) { | ||
| try { | ||
| await selectedCommand.execute(); | ||
| } catch { | ||
| logger?.error?.( | ||
| `✖︎ ${selectedCommand.name.slice(0, -3)} failed! 🚑` | ||
| ); | ||
| } | ||
| } | ||
| if (controller.signal.aborted) { | ||
| restartServer(); | ||
| } else { | ||
| process.stdin.once("keypress", command); | ||
| } | ||
| } catch { | ||
| // prompt was cancelled | ||
| } finally { | ||
| process.stdout.removeAllListeners(); | ||
| activeCommand = false; | ||
| } | ||
| }; | ||
|
|
||
| process.stdin.once("keypress", command); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.