NativeScript / NativeScript/nx

Outdated CLI Flags in Documentation for @nativescript/nx Version 20

Aperta
#80 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
TypeScript
Stelle
68
Fork
15
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

After updating @nativescript/nx from version 18 to version 20, I noticed that the executor interface has changed, and some command-line flags are no longer recognized as before. Specifically, options like --aab, --key-store-path, and --provision are now nested under platform-specific objects (android, ios, etc.) and require a different syntax when used in build commands.

However, the current documentation still reflects the old interface, which can lead to confusion and build failures for developers upgrading to version 20.

Current Documentation Examples (Outdated):

For Android:

npx nx build <app-name> android --c=prod \
  --aab \
  --key-store-path=<path-to-your-keystore> \
  --key-store-password=<your-key-store-password> \
  --key-store-alias=<your-alias-name> \
  --key-store-alias-password=<your-alias-password> \
  --copyTo=./dist/build.aab

For IOS:

npx nx build <app-name> ios --c=prod \
  --provision <provisioning-profile-name> \
  --copy-to ./dist/build.ipa
Issue:

With the updated executor schema in version 20, these flags are nested inside of android and IOS object:

export interface ExecutorSchema extends BaseSchema, BuildSchema, DebugSchema, PrepareSchema, RunSchema, TestSchema {
    android: AndroidSchema;
    ios: IosSchema;
    visionos: visionOSSchema;
}

export interface AndroidSchema {
    aab: boolean;
    keyStoreAlias: string;
    keyStoreAliasPassword: string;
    keyStorePassword: string;
    keyStorePath: string;
    xmlUpdates: Record<string, any>;
}

export interface IosSchema {
    plistUpdates: Record<string, any>;
    provision: string;
}

Proposed Documentation Update:

For Android:

npx nx build <app-name> android --c=prod \
  --android.aab=true \
  --android.keyStorePath=<path-to-your-keystore> \
  --android.keyStorePassword=<your-key-store-password> \
  --android.keyStoreAlias=<your-alias-name> \
  --android.keyStoreAliasPassword=<your-alias-password> \
  --copyTo=./dist/build.aab

For iOS:

npx nx build <app-name> ios --c=prod \
  --ios.provision=<provisioning-profile-name> \
  --copyTo=./dist/build.ipa

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Individua la pagina della documentazione che contiene gli esempi di build per Android e iOS e confrontali con ExecutorSchema, AndroidSchema e IosSchema della versione 20 mostrati nell’issue. Aggiorna gli esempi in modo che utilizzino la sintassi delle opzioni annidate, quindi verifica che entrambi i comandi riflettano lo schema documentato e utilizzino una grafia coerente per copyTo.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.