OmegaEdit gRPC Client TypeScript Types
npm install omega-edit


!Build Status
!CodeQL



The goal of this project is to provide an open source library for building editors that can handle massive files, and multiple viewports.
User documentation is published to https://ctc-oss.github.io/omega-edit/.
The Ωedit project is built primarily using CLion. If using CLion everything should build seamlessly, though Visual
Studio Code also works well.
- C/C++ compiler (such as clang, gcc, mingw, or MSVC)
- CMake (https://cmake.org/download/)
- conan C/C++ package manager
- make or ninja for running the build scripts
- nvm or nodeenv for using specific versions of node.js
- doxygen to generate API documentation (https://www.doxygen.nl)
- sphinx to generate user documentation (https://www.sphinx-doc.org)
- sphinx RTD theme (https://github.com/readthedocs/sphinx_rtd_theme)
- breathe ReStructuredText and Sphinx bridge to Doxygen (https://github.com/michaeljones/breathe)
- scala/sbt/java
:exclamation: These commands should be executed at the root level of the repository :exclamation:
``bash`
pip install conan
Depending on your linking needs, Ωedit can be built as either as a static (e.g., libomega_edit.a) or shared (e.g., libomega_edit.so) library.
- #### Static:
`bash`
cmake -S . -B cmake-build-debug -DCMAKE_BUILD_TYPE=Debug
- #### Shared:
`bash`
cmake -S . -B cmake-build-debug -DCMAKE_BUILD_TYPE=Debug -DBUILD_SHARED_LIBS=YES
`bash`
cmake --build cmake-build-debug
`bash`
cmake -S src/tests -B cmake-build-tests -DCMAKE_BUILD_TYPE=Debug
pushd cmake-build-tests && ctest -C Debug --output-on-failure && popd
This package is normally uploaded to npmjs.com
:exclamation: Node needs to be installed but shouldn't matter what version you use. :exclamation:
- Create local .tgz file
`bash`
cd src/rpc/client/ts
yarn install # if not ran before
yarn package
- File will be at
`bash`
src/rpc/client/ts/omega-edit-v${VERSION}.tgz
- Publish .tgz file to npmjs -- requires auth
`bash`
yarn publish omega-edit-v${VERSION}.tgz
This publishes for Scala version 2.13 to GitHub packages.
- Requires the GITHUB_TOKEN environment variable to be set
`bash`
sbt publishAll
This packages the reference Scala server to a local zip folder
`bash`
cd src/rpc/server/scala
sbt universal:packageBin
Zip file will be located at
`bash``
src/rpc/server/scala/target/universal/omega-edit-grpc-server-${VERSION}.zip
Currently, the repo holds bindings for both Scala and node.
Binary releases for macOS (ARM and x86), Windows (x86), and Linux (ARM, and x86; glibc 2.31 or greater required) are built and published via GitHub CI workflows.
Ωedit follows Semantic Versioning.
