sakura

Sakura Editor

• Sakura Editor
  • Hot topic
  • Web site
  • Development participation policy
  • Build Requirements
    • Visual Studio Install options required
    • Regarding support for Visual Studio 2019 and later
    • Regarding .vsconfig
      • Common to all compatible versions
      • Visual Studio 2019 and later only
      • reference
  • How to build
    • Detailed information
  • Environment variables for CI Build and local builds
  • How to easily get a PR (Pull Request) locally
  • CI Build (Azure Pipelines)
    • How builds work (Azure Pipelines)
  • CI Build (AppVeyor)
    • Build mechanism (AppVeyor)
    • Notes on using build artifacts
    • Download build artifacts (binaries, installers, etc.)
      • master latest
      • Other than the latest in master
  • Development information
    • unit test
    • How to debug
  • Change history
  • macro sample
  • static code analysis

A free Japanese text editor for Windows

Hot topic

We will start using Project (Kanban).

• Projects
• Kanban operation

Web site

• Sakura Editor Portal

Development participation policy

The development policy is summarized below. If you would like to participate in the development, please click here.
https://github.com/sakura-editor/sakura/wiki

Build Requirements

To compile Sakura Editor, you need the latest version of Visual Studio or an earlier version of Visual Studio (Visual Studio 2017 or later, excluding Express 2017 for Windows Desktop).

Sakura Editor is based on the zlib license, which is an Open Source Initiative (OSI) certified license, so even enterprise organizations that are normally not eligible for the Community edition can use the Community edition for development and testing. Of course, Professional and Enterprise editions are also available.

Official binaries are built with Visual Studio Community 2017.

Visual Studio Install options required

• Windows 10 SDK

Regarding support for Visual Studio 2019 and later

Visual Studio version	Addressed Issue/PR
2022	#1872 (commit)
2017/2019 simultaneous	#866

See here for details on how it works.

Regarding .vsconfig

A configuration file called .vsconfig is provided to install the components necessary for compiling Sakura Editor into Visual Studio.

In #1162, a file called .vsconfig is placed in the same directory as sakura.sln.

Common to all compatible versions

When installing with vs_community__XXXXX.exe , add the --config option. Or change the configuration to automatically install the required components.

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

Visual Studio 2019 and later only

When you open sakura.sln in the latest Visual Studio (Visual Studio 2019 or newer), it loads the list of required components from .vsconfig located in the same directory. If there are components that are not installed, an install button will be displayed. Click Install to automatically install the missing components.

reference

• How to extract currently installed Visual Studio component IDs?
• Configure Visual Studio across your organization with .vsconfig
• Import or export installation configurations
• Install Visual Studio using command line parameters
• Install missing components automatically

How to build

• Install 7-Zip and pass the path to 7z.exe.
• Open sakura.sln in Visual Studio and build it.

Detailed information

See here for details

Environment variables for CI Build and local builds

See here.

How to easily get a PR (Pull Request) locally

• How to easily get a PR (Pull Request) locally

CI Build (Azure Pipelines)

How builds work (Azure Pipelines)

azure-pipelines.md explains how the build works.

CI Build (AppVeyor)

Build mechanism (AppVeyor)

AppVeyor uses build-all.bat to build. See build-batchfiles.md for batch files used for builds.

Notes on using build artifacts

Please readこれbefore using.

x64 版は alpha 版.
We are currently working on this issue, so there may be unexpected issues.

Download build artifacts (binaries, installers, etc.)

master latest

1. Visit https://ci.appveyor.com/project/sakuraeditor/sakura/branch/master
2. Click Jobs on the far right.
3. Click on the build configuration you want to download (for example, Configuration: Release; Platform: Win32 ).
4. Click ARTIFACTS on the far right.
5. Click on the one you want to download.
   • (For users) Those with Exe at the end are a set of executable files.
   • (For users) The set with Installer at the end is a set of installers.
   • (For those who want everything) All is the full set of binaries, installer, build log, and assembler output. (Currently disabled to alleviate #514)
   • (For developers) The one with Log at the end is a set of build logs.
   • (For developers) The one with Asm at the end is the assembler output set.

Other than the latest in master

You can download it in the same way after selecting the build you want from below.
https://ci.appveyor.com/project/sakuraeditor/sakura/history

Development information

unit test

See here.

How to debug

• See How to debug task tray menu items
• How to create large files

Change history

• See CHANGELOG.md for changelog.
• You can download the latest CHANGELOG.md here (you can check it locally using the steps described in How to check Markdown locally).
• CHANGELOG.md is automatically generated from PullRequest.
  • Specifically, it is generated using appveyor in the changelog-sakura repository using software called github-changelog-generator.
  • For more information, see About CHANGELOG.md on the wiki.

macro sample

A sample macro is provided here.
If you are interested in making a sample, please create a PR.

static code analysis

• I am using CodeFactor.
  • cpplint.py checks cpp style.