[Request] Prompts global settings
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- node.js, typescript
- Ambito
- cli
Direzione di ricerca
Inizia dalla definizione di CommonOptions in packages/prompts/src/common.ts e analizza come sono collegati gli export dei prompt e le opzioni di output; l’issue mostra anche l’utilizzo del wrapper di bin/index.ts. Il lavoro è completato quando il progetto dispone di un’API di configurazione globale concordata per la formattazione, l’indentazione dell’output e, facoltativamente, i simboli, con un comportamento corrispondente agli esempi richiesti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
version:
"@clack/prompts": "1.0.0-alpha.4",
Is your feature request related to a problem? Please describe.
I'd like to introduce a simple manageable way of overriding default config values (CommonOptions) for consistent formatting changes.
For example i'm not very happy with the indentation of the symbol bars, because they appear far too close to the terminal edge and I'd like to add an extra whitespace before the console lines. i.e.
# before:
┌ Unfortunately we encountered the following error:
│
■ Directory ./x does not exist. Either cd to a valid directory or correct the --path option
# after:
┌ Unfortunately we encountered the following error:
│
■ Directory ./x does not exist. Either cd to a valid directory or correct the --path option
Describe the solution you'd like
I'd like a single settings that allows for a builder-like approach to ideally re-export the individual prompts:
i.e.
const { log, intro, outro } = prompts({
output: (buffer: Uint8Array | string) => ` ${buffer}`
})
Describe alternatives you've considered
Right now I've sort of hackishly created a folder named /prompts where I'm re-exporting individual exports from @clack/prompts in a following manner:
Here's a select for example:
// output.ts
import { Writable } from "node:stream"
export const output = new Writable({
write: (chunk, encoding, callback) => {
process.stdout.write(` ${chunk}`)
callback()
},
})
And then let's say in my outro (to keep it simple):
import { outro as cOutro } from "@clack/prompts"
import { output } from "./output"
export const outro = (msg: string) => cOutro(msg, { output })
That's fairly straightforward, here's a bit more annoying example:
import { log as cLog } from "@clack/prompts"
import type { LogMessageOptions } from "@clack/prompts"
import { output } from "./output"
export const log = {
message: (message?: string | string[], opts?: LogMessageOptions) =>
cLog.message(message, { ...opts, output }),
info: (message: string, opts?: LogMessageOptions) =>
cLog.info(message, { ...opts, output }),
success: (message: string, opts?: LogMessageOptions) =>
cLog.success(message, { ...opts, output }),
step: (message: string, opts?: LogMessageOptions) =>
cLog.step(message, { ...opts, output }),
warn: (message: string, opts?: LogMessageOptions) =>
cLog.warn(message, { ...opts, output }),
warning: (message: string, opts?: LogMessageOptions) =>
cLog.warning(message, { ...opts, output }),
error: (message: string, opts?: LogMessageOptions) =>
cLog.error(message, { ...opts, output }),
} satisfies typeof cLog
Then I've introduced the following eslint rule to block direct imports from @clack/promtps (technically this step is optional, but I want to illiustrate poignantly just how cumbersome this can be to setup in a codebase that's shared across multiple people and is supposed to scale)
// eslint.config.mjs
{
// ... rest of config
{
rules: {
"@typescript-eslint/no-restricted-imports": [
"error",
{
paths: [
{
name: "@clack/prompts",
message:
"Direct imports from @clack/prompts are only allowed in src/prompts directory. Use the wrapper functions from src/prompts instead.",
},
],
},
],
},
},
{
files: ["src/prompts/**/*"],
rules: {
"@typescript-eslint/no-restricted-imports": "off",
},
}
}
And then finally - let's say in my bin/index.ts file
import { intro } from "@/prompts/intro"
intro("example")
Additional context
Now this works somewhat nicely, but even with this you quick run into issues like newlines, i.e.:
Maybe for the sake of simplicity it would be nice to expose something different like indent: number and let @clack/prompts take care of the formatting
Also it would be nice to be able to customize the bars/symbols directly from the prompts({}) config directly for advanced users
PS: Thank you very much for all the hard work you guys are putting in, really looking forward to the v1. Keep up the great work! ❤️
- Lingua principale
- TypeScript
- Stelle
- 8.1k
- Fork
- 217
- Merge medio
- 1g 11h
- PR unite (30g)
- 5
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di bombshell-dev/clack
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 30/100
bombshell-dev/clack#597 ·
-
rfc: accessible mode Apertaenhancement
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
bombshell-dev/clack#585 · 1 commento · 1 reazione ·
-
bug
Difficoltà 3/5 1-2 giorni Idoneità per principianti 68/100
bombshell-dev/clack#573 · 1 commento · 2 reazioni ·
-
enhancement
Difficoltà 3/5 1-2 giorni Idoneità per principianti 62/100
bombshell-dev/clack#565 · 1 commento · 1 reazione ·
-
enhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
bombshell-dev/clack#564 · 1 reazione ·
Tutte le issue di bombshell-dev/clack
Issue simili
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
Crush Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
ElementsProject/cln-application#167 · 1 commento · 1 reazione ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
Quantco/pnpm-licenses#17 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100