Repository files navigation

Collection of Operation Transformation Algorithms and their respective clients to integrate with any existing system.

Package	Version	Downloads	Third-party Dependency
ace
firebase-ace
firebase-monaco
firebase-plaintext
monaco
plaintext			-
plaintext-editor			-
state-machine			-
types	-	-	-
utils	-	-	-

Package	Version	Downloads
plaintext
plaintext-editor
state-machine

This repository uses monorepo architecture for hosting packages. We are usingLerna to manage workspaces and publishing of individual packages, where asPnpm is used as package manager to symlink and install External Dependencies.

• To install using Pnpm(recommended):

  pnpm install -r

• To install using Lerna:

  lerna bootstrap

We are usingJest extensively to form our Unit Test Suite as well as Integration Test Suites, along with test environment, stubs and test runner.Nyc(formerly known as Istanbul) is used for coverage reporting.

• To run all the unit test suites in local dev environment, run the following after dependencies have been installed:

  pnpmtest

• To run unit tests in CI environment, run:

  pnpm test:ci

• To run integration tests in CI environment, run:

  pnpm test:firebasepnpm test:monaco

• To merge all the individual code coverage report and generate final test coverage report, run:

  pnpm run coverage

• To convert generated final coverage report into more human readable form(such aslcov), run:

  pnpm run coverage:dev

This package only provides a functional layer on top of your existing dependencies and does not ship any additional bundle. To make sure our implementation and integrations are up-to-date, we have a comprehensive set of Integration Test Suite living intests directory.

Most of the popular editors and IDEs have extensions to help with Code Coverage details. These tools often readlcov reports and notjson format. So one must convert them intolcov using last command described above to make it work with the editor of their choice.

We are usingcodecov.io to track progress over Code Coverage andCodeQL for Code Quality Analysis.

Head on toDiscussion section to report a bug or to ask for any feature. Use thistemplate to make it structural and helpful for the maintainer and the contributors. Feel to add your queries about using this library as well underQ & A section of it. Remember, do not create any Issues by yourself, maintainers of this repository will open one if deemed necessary.

SeeCHANGELOG for more details.

SeeContributing Guidelines.

This project is licensed under the terms of the MIT license, seeLICENSE for more details.