Maintaining this fork (Xed-Editor)

soraX is a mirror of Rosemoe/sora-editor that is consumed by Xed-Editor. main is upstream main plus a small number of local commits.

How Xed-Editor consumes this repo

Xed-Editor declares dependencies on the soraX modules (soraX:editor, soraX:editor-lsp, soraX:language-textmate, soraX:oniguruma-native) in its version catalog, and its settings.gradle.kts uses an included build with dependency substitution:

includeBuild("soraX") {
    dependencySubstitution {
        substitute(module("soraX:editor")).using(project(":editor"))
        substitute(module("soraX:editor-lsp")).using(project(":editor-lsp"))
        substitute(module("soraX:language-textmate")).using(project(":language-textmate"))
        substitute(module("soraX:oniguruma-native")).using(project(":oniguruma-native"))
    }
}

The soraX:* coordinates are placeholders - they are not published anywhere and are replaced by the matching project in the soraX build. So every Xed-Editor build compiles these modules directly from the checked-out soraX submodule. Whatever commit is checked out in soraX/ is exactly what gets built.

Adding a patch

1. Make sure your local commits on top of upstream stay small and few so syncs stay easy. Prefer touching files that upstream does not rewrite often.

2. Edit the code in the soraX checkout and rebuild Xed-Editor to test it, changes take effect immediately, no extra step.

3. When it works, commit it on a branch and open a PR back to main:

   git checkout main
   git checkout -b my-patch
   # ...edit the editor code...
   git add -A
   git commit -m "patch: describe the change"
   git push -u origin my-patch   # then open/merge a PR on GitHub

4. Update the soraX submodule pointer in Xed-Editor to the new commit and commit that change there.

Staying synced with upstream

Never re-create main from upstream once it contains local commits (git reset --hard upstream/main deletes them). Instead merge upstream in:

git remote add upstream https://github.com/Rosemoe/sora-editor.git   # once
git fetch upstream
git checkout main
git merge upstream/main

Because main is based on upstream with only a few local commits, this is usually a clean fast-forward. A conflict can only appear in a file that both you and upstream changed, resolve it by keeping your patch's intent, commit the merge, and push:

git push origin main

Then update the soraX submodule pointer in Xed-Editor so builds use the new commit.

Note: the AGP version used by this repo must match the one in Xed-Editor's gradle/libs.versions.toml, because Gradle does not allow two Android Gradle plugin versions in one build.

Contributors

License

sora-editor - the awesome code editor for Android
https://github.com/Rosemoe/sora-editor
Copyright (C) 2020-2026  Rosemoe

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
USA

Please contact Rosemoe by email 2073412493@qq.com if you need
additional information or have any questions

Acknowledgements

Thanks to JetBrains for allocating free open-source licences for IDEs such as IntelliJ IDEA.