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

オープン
#80 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
typescript
領域
documentation

調査の方向性

Android および iOS のビルド例が記載されているドキュメントページを見つけ、issue に示されている version 20 の ExecutorSchema、AndroidSchema、IosSchema と比較してください。例をネストされたオプション構文を使用するように更新し、その後、両方のコマンドがドキュメント化されたスキーマを反映し、copyTo の表記が一貫していることを確認してください。

索引モデルが issue の本文から書いたものです。

説明

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
主要言語
TypeScript
スター
68
フォーク
15
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

NativeScript/nx のほかの issue

NativeScript/nx の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。