carbon-design-system/carbon-components-angular:README に基づく導入ガイド
README、メタデータ、ライセンスに基づく carbon-design-system/carbon-components-angular の導入と確認ガイドです。
プロジェクトの範囲
carbon-design-system/carbon-components-angular の README はプロジェクトを「An Angular implementation of the Carbon Design System for IBM.」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「README」には次の説明があります。An Angular implementation of the Carbon Design System。これは範囲の説明であり、本番検証の結果ではありません。
向いている用途
README の「Support」にある内容から、用途が合うかを先に判断できます。For things that are broken or need enhancement, open an issue。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。For general usage questions, or other discussions visit our Github Discussions。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。
動作の考え方
動作の説明は「Getting started」など複数の箇所に分かれています。確認できる情報は次の通りです。Next, we need to include carbon styles in src/styles.scss:。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。
インストールと初回起動
初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 $ npx @angular/cli new my-project --style=scss $ cd my-project $ npm i --save carbon-components-angular @carbon/styles @carbon/icons 実行可能なコマンドがない場合は手順を作らず、「Support」で依存関係、待受ポート、初回設定を確認します。
設定と日常運用
日常運用は公式文書の範囲に限ります。「Getting started」にはThen we need to declare @carbon/icons as a module by creating a module.d.ts file (or use any existing declaration file - has .d.ts suffix) in your src directory:とあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料にはIBMers should use our #carbon-ng Slack channelともあります。
README で確認できる制約
制約も確認が必要です。現在の資料からは、carbon-design-system/carbon-components-angular の互換表、性能基準、サービス保証、長期サポートを確認できません。README の記載は「That's it! Now we can run npm start and start building out our application!」です。不明点は採用記録の検証項目として残し、断定に変えないでください。