@sourceacademy/sharedb-ace

Sharedb-ace

This is a fork of the original sharedb-ace repository.

Sharedb-ace provides two-way bindings between ShareDB and Ace Editor.

Installation

Using npm:

npm install @sourceacademy/sharedb-ace

Using pre-compiled js from unpkg CDN:

<script src="https://unpkg.com/sharedb-ace@latest/dist/sharedb-ace.min.js"></script>

Documentation

Single Ace-editor Instance

Setup the ShareDB document as a string:

ShareAce.on('ready', function() {
  ShareAce.add(editor, [], [ Plugins, Here ]);
});

Multiple Ace-editor Instances

Your setup may be more complex, and requires the use of multiple ace-instances synchronized over one connection. Setup the ShareDB document to be a JSON object.

For example:

{
  "foo": "",
  "bar": ""
}

Next, connect the two paths to two separate ace editor instances:

ShareAce.on('ready', function() {
  ShareAce.add(editor1, ["foo"], []);
  ShareAce.add(editor2, ["bar"], []);
});

Developing sharedb-ace

• Fork or clone this repo:

git clone https://github.com/jethrokuan/sharedb-ace.git

cd sharedb-ace && yarn install

To test the package locally, run the following on this sharedb-ace repository:

yarn build
yarn link

Then, run the following on the frontend repository:

yarn link @sourceacademy/sharedb-ace

Now, whenever you want to update the ShareDB Ace binding, simply run yarn build.

Generating JS Docs

We generate javascript documentation using inline documentation.

jsdoc source/*.js --destination ./docs/

License

Copyright 2019 Jethro Kuan

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.