Vai al contenuto
Verificata

Riferimento della CLI

Ogni comando di xuda-cli, ogni campo di xuda.config.js e che cosa può fare oggi la sincronizzazione cloud.

xuda-cli è composta da tre comandi, più l'aiuto. Nessuno di essi accetta flag: qualsiasi argomento in più è un errore bloccante, e ogni impostazione sta in xuda.config.js.

Comandi

bash
xuda-cli dev
xuda-cli sync
xuda-cli clean-readmes
xuda-cli --help

dev esegue l'app senza alcuna connessione al cloud: risponde da sé a una manciata di endpoint locali in modo che l'app abbia tutto ciò che le serve, e in quella modalità isolata gestisce in locale anche le quattro operazioni di lettura e scrittura delle tabelle. Qualsiasi altra cosa viene inoltrata a monte quando è configurata una chiave API, e rifiutata con un messaggio chiaro quando non lo è.

xuda.config.js

Rendering lato server

Imposta ssr su first_page per renderizzare sul server il programma di ingresso e passare da lì al client, oppure su full per renderizzare sul server l'app e idratarla lato client. Lascialo su none per renderizzare interamente nel browser.

Imposta la modalità

Modifica ssr in xuda.config.js.

Riavvia dev

npm run dev richiede un riavvio dopo una modifica di SSR.

Controlla il payload

La CLI renderizza il programma di ingresso in una stringa in un contesto isolato, inietta il markup nella shell e consegna al client un payload di rendering da cui proseguire.

Chiavi API

Apri Sviluppatori, poi la scheda Chiavi API nella dashboard, e premi Crea chiave. Dai un nome alla chiave, limita facoltativamente i Domini consentiti e scegli una modalità di accesso.

Una chiave con l'accesso giusto può chiamare oggi direttamente via HTTP i metodi dei dati dell'app: dbs_read, dbs_create, dbs_update e dbs_delete. Vedi JavaScript Framework per la forma della richiesta.

Sincronizzazione cloud

L'intento di sync è scaricare i documenti di un progetto cloud in file sorgente locali e rimandare indietro le modifiche locali. Esegue un controllo preliminare che conferma che quattro metodi della piattaforma siano richiamabili prima di fare qualsiasi altra cosa:

get_app_system_api_methods, get_app_api_keys, get_project_docs, update_app_info_doc_to_db_couch.

Due di questi sono metodi di sessione della dashboard che per progetto non compaiono mai nell'elenco del catalogo letto dal controllo, e gli altri due non sono affatto registrati come metodi della piattaforma richiamabili, quindi il controllo non viene superato con l'attuale catalogo dei metodi. Inoltre, tutto ciò che nella CLI richiede api_key, compresi l'inoltro a monte e sync stesso, carica dal disco moduli della piattaforma che un'installazione npm pubblicata della CLI non include.

Che cosa raggiunge davvero il cloud oggi

Considera dev la toolchain locale e usa Studio per portare il lavoro di progetto nel progetto cloud. Nulla di tutto ciò riguarda lo sviluppo locale: dev, il live reload, l'SSR e i plugin funzionano tutti senza alcuna connessione al cloud.

Quando sync esegue la sua sequenza completa, verifica che l'app esponga i metodi CPI richiesti, verifica che la chiave API corrente possa usarli, scarica i documenti remoti in node_modules/.project_data/, crea i file sorgente locali mancanti a partire da quei documenti (i file locali esistenti non vengono mai sovrascritti), ricompila il sorgente locale in node_modules/.project_data/ e carica nel cloud i documenti modificati.

Risoluzione dei problemi

Piani e limiti

Il framework in sé è gratuito: lo sviluppo locale con uno qualsiasi dei due percorsi di scrittura non chiama mai un metodo vincolato a un piano, i pacchetti della CLI sono pubblicati apertamente su npm e le chiavi API sono gratuite a prescindere dalla modalità di accesso. Ciò che un piano dell'account offre è la distribuzione, che non è disponibile nel piano Free ed è disponibile da Pro in su.