Sakura Editor

• Sakura Editor
  • Hot topic
  • Web Site
  • 開発参加ポリシー
  • Build Requirements
    • Visual Studio Install options required
    • Visual Studio 2019 以降の対応に関して
    • .vsconfig に関して
      • 全対応バージョン共通
      • Visual Studio 2019 以降のみ
      • 参照
  • How to build
    • 詳細情報
  • CI Buildおよびローカルビルドの環境変数
  • PR(Pull Request) を簡単にローカルに取得する方法
  • CI Build (Azure Pipelines)
    • ビルドの仕組み (Azure Pipelines)
  • CI Build (AppVeyor)
    • ビルドの仕組み (AppVeyor)
    • ビルド成果物を利用する上での注意事項
    • ビルド成果物のダウンロード(バイナリ、インストーラなど)
      • master の 最新
      • master の 最新以外
  • 開発情報
    • 単体テスト
    • デバッグ方法
  • 変更履歴
  • マクロのサンプル
  • 静的コード解析

A free Japanese text editor for Windows

Hot topic

Project(カンバン)運用を始めます。

• Projects
• カンバン運用

Web Site

• Sakura Editor Portal

開発参加ポリシー

開発ポリシーを以下にまとめていきます。開発にご参加いただける方はこちらご参照ください。
https://github.com/sakura-editor/sakura/wiki

Build Requirements

Sakura Editor をコンパイルするためには、 最新のVisual Studio または 以前のバージョンのVisual Studio（Visual Studio 2017 以降。ただし Express 2017 for Windows Desktop は除く）が必要です。

Sakura Editor は、Open Source Initiative (OSI) 認定ライセンスである zlib ライセンスに基づいているため、通常 Community エディションの対象外であるエンタープライズ組織でも、特例で Community エディションを利用しての開発・テストができます。もちろん、Professional・Enterprise エディションも利用できます。

正式バイナリは Visual Studio Community 2017 でビルドされます。

Visual Studio Install options required

• Windows 10 SDK

Visual Studio 2019 以降の対応に関して

Visual Studioバージョン	対応済みIssue/PR
2022	#1872（コミット）
2017/2019同時	#866

仕組みに関してはこちらを参照

.vsconfig に関して

Sakura Editor のコンパイルに必要なコンポーネントを Visual Studio にインストールするために .vsconfig という設定ファイルを用意しています。

#1162 で .vsconfig というファイルを sakura.sln と同じディレクトリに配置しています。

全対応バージョン共通

vs_community__XXXXX.exe でインストールする際に、--config オプションをつけてインストールする。 あるいは構成変更することにより、必要なコンポーネントを自動的にインストールします。

vs_community__XXXXX.exe --config <.vsconfig のファイルパス>

Visual Studio 2019 以降のみ

最新のVisual Studio(Visual Studio 2019 以降)で sakura.sln を開くと、同じディレクトリにある .vsconfig から必要なコンポーネントのリストが読み込まれます。インストールされていないコンポーネントがある場合、インストールボタンが表示されます。インストールをクリックすると不足しているコンポーネントが自動的にインストールされます。

参照

• How to extract currently installed Visual Studio component IDs?
• Configure Visual Studio across your organization with .vsconfig
• インストール構成をインポートまたはエクスポートする
• コマンド ライン パラメーターを使用して Visual Studio をインストールする
• 不足しているコンポーネントを自動的にインストールする

How to build

• 7-Zip をインストールして 7z.exe へのパスを通します。
• Visual Studio で sakura.sln を開いてビルドします。

詳細情報

詳しくは こちら を参照

CI Buildおよびローカルビルドの環境変数

こちら を参照してください。

PR(Pull Request) を簡単にローカルに取得する方法

• PR(Pull Request) を簡単にローカルに取得する方法

CI Build (Azure Pipelines)

ビルドの仕組み (Azure Pipelines)

azure-pipelines.md でビルドの仕組みを説明しています。

CI Build (AppVeyor)

ビルドの仕組み (AppVeyor)

AppVeyor では、 build-all.bat を使用してビルドを行っています。 ビルドに使用されるバッチファイルについては build-batchfiles.md を参照してください。

ビルド成果物を利用する上での注意事項

これ を読んでからご利用ください。

x64 版は alpha 版です。
対応中のため予期せぬ不具合がある可能性があります。

ビルド成果物のダウンロード(バイナリ、インストーラなど)

master の 最新

1. https://ci.appveyor.com/project/sakuraeditor/sakura/branch/master にアクセスする
2. 右端にある Jobs をクリックします。
3. 自分がダウンロードしたいビルド構成 (例: Configuration: Release; Platform: Win32) をクリックします。
4. 右端にある ARTIFACTS をクリックします。
5. 自分がダウンロードしたいものをクリックしてダウンロードします。
   • (ユーザー用) 末尾に Exe がついてるのが実行ファイルのセットです。
   • (ユーザー用) 末尾に Installer がついてるのがインストーラのセットです。
   • (すべて欲しい人向け) All がついてるのがバイナリ、インストーラ、ビルドログ、アセンブラ出力のフルセットです。 (#514 の軽減のため無効化中)
   • (開発者用) 末尾に Log がついてるのがビルドログのセットです。
   • (開発者用) 末尾に Asm がついてるのがアセンブラ出力セットです。

master の 最新以外

以下から取得したいビルドを選択後、同様にしてダウンロードできます。
https://ci.appveyor.com/project/sakuraeditor/sakura/history

開発情報

単体テスト

こちら を参照してください。

デバッグ方法

• タスクトレイのメニュー項目をデバッグする方法 を参照
• 大きなファイルの作成方法

変更履歴

• 変更履歴は CHANGELOG.md を参照してください。
• 最新の CHANGELOG.md は ここからダウンロード できます(Markdown をローカルで確認する方法 で説明している手順でローカルで確認できます)。
• CHANGELOG.md は PullRequest から自動的に生成しています。
  • 具体的には github-changelog-generator というソフトを使用して changelog-sakura のリポジトリで appveyor で生成しています。
  • 詳細は wiki の CHANGELOG.mdについて をご覧ください。

マクロのサンプル

こちらでマクロのサンプルを提供してます。
もしサンプルを作ってもいいよ～という方がおられましたら PR の作成お願いします。

静的コード解析

• CodeFactor を利用しています。
  • cpplint.py で cpp のスタイルのチェックを行っています。