Costruisci il tuo primo modulo Fabled

Prerequisiti

• Node.js 20.20 o versione successiva. Il repository web Fabled stesso attualmente richiede ^20.20.0 o >=22.22.0.
• Un account favoloso. La pubblicazione richiede inoltre un servizio di abbinamento CLI del modulo disponibile e uno spazio dei nomi editore attivo.
• Bootstrap pubblico: @fabledgg/module-cli è disponibile da npm sotto il tag dist bootstrap mentre 0.1.0 rimane riservato per la versione post-unione.

Esegui il bootstrap pubblico

Prova l'attuale CLI pubblica direttamente da npm senza installarla a livello globale:

npx @fabledgg/module-cli@bootstrap module --help

Il resto di questa guida utilizza il comando binario installato fabled module. Se stai contribuendo al repository web Fabled stesso, puoi invece utilizzare npm run modules:cli -- module.

npx @fabledgg/module-cli@bootstrap module init my-dice \
  --publisher-id my-studio \
  --publisher-name \"My Studio\"

Scegli uno stile di installazione

Il modulo una tantum consigliato non richiede installazione globale:

npx @fabledgg/module-cli@bootstrap module --help

Per un progetto team, installa il bootstrap come dipendenza di sviluppo in modo che package-lock.json registri la versione risolta e la convalida locale e CI utilizzino la stessa build del contratto.

npm install --save-dev @fabledgg/module-cli@bootstrap
npx fabled module --help

L'installazione globale è facoltativa. Espone lo stesso leggendario binario, ma una versione bloccata a livello locale del progetto è più facile da riprodurre e controllare.

npm install --global @fabledgg/module-cli@bootstrap
fabled module --help

Impalcatura di un progetto

fabled module init my-dice \
  --publisher-id my-studio \
  --publisher-name "My Studio"

La directory non deve già esistere. L'impalcatura crea l'esempio Dice & Chat con un fabled.module.json canonico, un'azione di dadi rivista, un frame Dice Tray di proprietà dell'host e un file locale inglese. Modificare lo slug del modulo locale con --module-id e il nome visualizzato con --name.

my-dice/
├── fabled.module.json
├── actions/roll.json
├── frames/dice-tray.json
└── locales/en.json

Fai il primo controllo

fabled module validate my-dice
fabled module pack my-dice --output my-dice.zip
fabled module inspect my-dice.zip

Una convalida pulita dimostra che il pacchetto corrisponde al contratto v1 locale. Non approva, installa, attiva o esegue il modulo.