Dart

SimpleGWTのバージョン007を公開

Dart/FlutterのテストでGiven When Thenスタイルのテストをシンプルに書けるライブラリsimple_gwtの最新バージョン0.0.7を公開しました。 変更はand関数の単独使用で例外を発生させる修正と、pub.devのPub Points減点項目の対応です。 Pub Pointsは満点の130になりました。 もしよかったら使ってみ、さらにもしよかったらLikeしてください。

Dartのドキュメントコメントの書き方

ドキュメントコメントを記述するためにその書き方を調べた。 Effective Dart: Documentation dart docがドキュメントコメントをパースしてdoc pageを生成してくれる。 パッケージをpub.devで公開する場合、ドキュメントコメントがあると利用者が迷わず利用することができる。またpub.devがPub Pointsをつけるが、評価内容にドキュメントコメントが書かれているかが含まれている。 文法ドキュメントコメントは///か/** */で記述する。///が好まれる。 /// Document comment title /// /// ... libraryディレクティブにライブラリの包括的なコメントを書くlibraryディレクティブにライブラリのドキュメントコメントを付けると良い。libraryディレクティブが無い場合はドキュメントコメントを書くためだけにlibraryディレクティブを記述するのも良い。libraryディレクティブのドキュメントコメントとして以下を記述するとよい。 このライブラリは何のためにあるのか、一文で要約する。ライブラリ全体で使用される用語の説明。API の使い方を説明した完全なコードサンプル。最も重要な、あるいは最も一般的に使用されるクラスや関数へのリンク。ライブラリが関係しているドメインに関する外部参照へのリンク。プライベートAPIのコメントプライベートAPIのドキュメントコメントは利用者ではなく開発者に役立つ。

FlutterのテストでGiven When Thenスタイルを使えるようにするライブラリを公開

FlutterのテストでGiven When Thenスタイルのテストを書くためのライブラリはいくつか存在しますが、シンプルに書けるライブラリが無いので作成しました。 simple_gwt | Flutter Package void main() { String? a; String? b; aIsNull() => a = null; bIsNull() => b = null; test('Test1', gwt(() { given('', aIsNull); and('', bIsNull); when('set

Dartのパッケージをpub.devに登録する方法を調査した

pubspecフォーマットとパッケージレイアウトの規約に従うLICENSEファイルが必要。DartとFlutterが使用しているBSD 3-clauseライセンスが推奨だがパッケージに適した別のライセンスでも良い。パッケージをgzip圧縮して100MBより小さくなければならない。大きい場合は複数パッケージに分割するか、.pubignoreファイルにより不要なコンテンツを削除する。パッケージはホストされた依存関係とSDKの依存関係にのみ依存する必要がある。パッケージのアップロードにはGoogleアカウントが必要。Pubがパッケージを作成するために必要なファイルを作成するREADME.md - Markdownとしてレンダリングされる。Writing package pages | Dartを参考にして記述する。CHANGELOG.md - CHANGELOG.mdが存在するとpub.devのパッケージページのタブに表示される。pubspec.yaml - パッケージページの右側の説明やホームページなどの詳細情報。認証済みパブリッシャーパッケージの公開に認証済みパブリッシャーか独立したGoogleアカウントを使用できる。認証済みパブリッシャーには以下の利点がある。 パブリッシャードメインが認証されていることがわかる。pub.devに個人のメールアドレスを表示させないようにでき、代わりにパブリッシャーのドメインと連絡先アドレスを表示できる。検索ページと個別パッケージページに検証済みバッジが表示される。

Visual Studio CodeでDartのクラス名を変更したときにファイル名も同時に変更されるように設定する

VSCodeでDartのクラス名を変更するときは、たいていファイル名も変更することになる。これを半自動的・自動的に行えるように設定することができる。 VSCodeの設定で"dart.renameFilesWithClasses"を"prompt"か"always"に設定すると、VSCodeのリネーム機能でクラス名を変更したときにファイル名も自動的に変更されるようになる。 変更前のクラス名とファイル名が対応している場合に適用されるので、たとえばファイル内のプライベートクラス名を変更するときには適用されないので、意図しない変更は発生しないはず。