Open2

「Copier」を試す

kun432kun432

GitHubレポジトリ

https://github.com/copier-org/copier

Copier


referred from https://github.com/copier-org/copier

プロジェクトテンプレートをレンダリングするためのライブラリおよびCLIアプリ。

  • ローカルパスおよびGit URLに対応。
  • プロジェクトには任意のファイルを含めることができ、Copierはあらゆる種類のテキストファイル内の値を動的に置き換えることが可能。
  • 美しい出力を生成し、指示がない限り既存ファイルを上書きしないよう配慮。


referred from https://github.com/copier-org/copier

基本概念

Copier は以下の主要な概念で構成されています:

  1. テンプレート:サブプロジェクトをどのように生成するかの設計図。
  2. 質問票:テンプレート内で設定され、回答がプロジェクト生成に使用される。
  3. プロジェクト:実際のプログラムが存在する場所。通常テンプレートから生成または更新される。

Copier は以下のようなユーザーを対象としています:

  1. テンプレート作成者:コードの繰り返しを減らしたい開発者。
    ヒント: Copier は DRY 原則の代わりにはなりませんが、時には「DRYするための機械」が必要です。
  2. テンプレート利用者:新規プロジェクトをすばやく始めたい、または快適に発展させたい開発者。

人間以外も CLI や API を通じて Copier を使って満足できるでしょう。人間と同じ期待を持ち、感情がある限り。

テンプレートの目的は以下のとおりです:

  1. コードスキャフォールディング:利用者がすぐに作業可能なコード構成を得る手助け。すべてのテンプレートはスキャフォールディングをサポート。
  2. コードライフサイクル管理:テンプレートの変更に応じてプロジェクトを更新可能にする。すべてのテンプレートが更新をサポートしているとは限らない。

Copier は、単純なテンプレートから複雑なテンプレートへと進化できる、滑らかな学習曲線を目指しています。

公開テンプレートを閲覧・タグ付け

GitHub 上で copier-template トピック を使って公開テンプレートを閲覧できます。インスピレーションに活用しましょう!

自作テンプレートをその一覧に載せたい場合は、トピックを追加するだけでOKです! 🏷