Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
mamadshni opened this issue Nov 8, 2024 · 0 comments
Open

Comments

@mamadshni
Copy link

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant