0Pricing
Dart Academy · レッスン

公開可能なライブラリの構成

lib、src、パブリック API を配置します

「公開可能なライブラリの構成」はCoddyKit上の無料Dart Academyレッスンです。 これはレッスン1/4です。 下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。 これはDart Academy学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 Dart Academyコースには全4レッスンが含まれています。

パッケージは単なるフォルダー

公開可能な Dart package は、ルートに pubspec.yaml を置いたフォルダーにすぎません。この1つのファイルによって、単なるコードが pub.dev でホストできるパッケージになります。📦

lib フォルダーが公開部分の場所

ユーザーに import してもらうものはすべて lib 以下に置きます。lib 直下のファイルはパッケージの公開 API の一部になるため、配置は慎重に決めてください。

lib/src に内部実装を隠す

公開したくないコードは lib/src に置きます。慣例上、これらのファイルは非公開の実装詳細であり、ユーザーが直接 import するものではありません。

lib/
  my_package.dart
  src/
    helper.dart

エントリーポイントファイル

多くのパッケージでは、パッケージ名に合わせた名前のメインファイルを lib に1つ配置します。この entry point を import すると、ライブラリ全体をまとめて利用できます。

import 'package:my_package/my_package.dart';

export キーワードで再エクスポートする

エントリーポイントでは export を使って、ユーザーに必要な lib/src の要素だけを公開します。意図が明確で整理された公開 API を1つ用意できます。

export 'src/calculator.dart';
export 'src/parser.dart';

公開 API を慎重に決める

エクスポートする名前の集合が public API です。エクスポートしたシンボルはそれぞれユーザーへの約束になるため、小さく安定したものに保ちます。

アンダースコアは非公開を示す

Dart では、アンダースコアで始まる名前は library-private です。lib/src 内であっても、外部に公開したくないヘルパーには先頭にアンダースコアを1つ付けます。

int _internalCount = 0;

example フォルダー

小さく実行可能なプログラムを入れた example フォルダーを追加します。パッケージの使い方をユーザーに示せるうえ、pub.dev での評価向上にもつながります。✨

テストは test に置く

自動テストは lib の外にある test フォルダーに置きます。ユーザーには配布されませんが、パッケージが約束どおり動作することを証明します。

トップレベルのファイルも重要

適切なパッケージルートには README、CHANGELOG、LICENSE も含めます。pub.dev で訪問者が最初に目にするのは、これら3つのファイルです。

整理された構成を一目で確認する

全体をまとめると、structure は地図のようになります。API 用の lib、内部実装用の src に加え、example、test、メタデータファイルを配置します。

my_package/
  lib/
  example/
  test/
  pubspec.yaml

確認問題

内部実装の詳細として非公開にしたいコードは、どこに置きますか?

まとめ:整ったライブラリ

layout について学びました。lib に公開 API を置き、lib/src に内部実装を隠し、export でユーザーに見せるものを整理します。まず構成を整え、それから公開しましょう。🚀

よくある質問

「公開可能なライブラリの構成」レッスンは無料ですか?

はい。「公開可能なライブラリの構成」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し(組み込みコードエディタと24時間対応のAIチューター)、Dart Academyコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 Dart Academyコースには全4レッスンが含まれています。

「公開可能なライブラリの構成」で何を学びますか?

lib、src、パブリック API を配置します ブラウザで直接実行するハンズオンコードでDart Academyを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

Dart Academyを始めるのに経験は必要ですか?

事前経験は必要ありません。CoddyKitのDart Academyは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。 これはレッスン1/4です。

「公開可能なライブラリの構成」レッスンにはどのくらい時間がかかりますか?

ほとんどのCoddyKitレッスンは約5~10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。

このDart Academyレッスンでコードを書いて実行できますか?

はい。すべてのDart Academyレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。

このコースのすべてのレッスン

  1. 公開可能なライブラリの構成
  2. dartdoc コメントによるドキュメント作成
  3. Lint、フォーマット、pana スコア
  4. dart pub publish で pub.dev に公開
← Dart Academyに戻る