# @otjs/ace

> Plain Text Editor Adapter for Ace Editor.

Latest version **0.2.2** (published 2024-02-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @otjs/ace
pnpm add @otjs/ace
yarn add @otjs/ace
bun add @otjs/ace
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2024-02-22 |
| First published | 2021-10-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 962.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 89 |
| Author | Progyan Bhattacharya |
| Maintainers | bprogyan |
| Keywords | ace, collaborative, editor, eventual-consistency, operational-transformation, typescript |

## Links

- npm: https://www.npmjs.com/package/@otjs/ace
- Repository: https://github.com/0xTheProDev/Operational-Transformation
- Homepage: https://github.com/0xTheProDev/Operational-Transformation/tree/main/packages/ace#readme
- Issues: https://github.com/0xTheProDev/Operational-Transformation/discussions
- npm.io page: https://npm.io/package/@otjs/ace

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.2.2 (latest) — 2024-02-22
- 0.2.1 — 2022-04-05
- 0.2.0 — 2021-10-14

## README

# `@otjs/ace`

[![Sponsor](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#white)](https://github.com/sponsors/0xTheProDev)
[![Npm Version](https://img.shields.io/npm/v/@otjs/ace?style=for-the-badge)](https://www.npmjs.com/package/@otjs/ace)
[![Weekly Downloads](https://img.shields.io/npm/dw/@otjs/ace?style=for-the-badge)](https://www.npmjs.com/package/@otjs/ace)
[![Minified Zipped Size](https://img.shields.io/bundlephobia/minzip/@otjs/ace?style=for-the-badge)](https://www.npmjs.com/package/@otjs/ace)
[![Types](https://img.shields.io/npm/types/@otjs/ace?style=for-the-badge)](https://www.npmjs.com/package/@otjs/ace)
[![License](https://img.shields.io/npm/l/@otjs/ace?style=for-the-badge)](https://github.com/0xTheProDev/Operational-Transformation/blob/main/packages/ace/LICENSE)
[![Dependencies](https://img.shields.io/librariesio/release/npm/@otjs/ace?style=for-the-badge)](https://www.npmjs.com/package/@otjs/ace)
[![Dependents](https://img.shields.io/librariesio/dependents/npm/@otjs/ace?style=for-the-badge)](https://www.npmjs.com/package/@otjs/ace)
[![Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/@otjs/ace?style=for-the-badge)](https://github.com/0xTheProDev/Operational-Transformation/blob/main/.github/SECURITY.md)
[![Stars](https://img.shields.io/github/stars/0xTheProDev/Operational-Transformation?style=for-the-badge)](https://github.com/0xTheProDev/Operational-Transformation/stargazers)
[![Forks](https://img.shields.io/github/forks/0xTheProDev/Operational-Transformation?style=for-the-badge)](https://github.com/0xTheProDev/Operational-Transformation/network/members)
[![Discussions](https://img.shields.io/github/discussions/0xTheProDev/Operational-Transformation?style=for-the-badge)](https://github.com/0xTheProDev/Operational-Transformation/discussions)

## Description

> Editor Adapter implementation for Ace.

## Installation

- To install using [Pnpm](https://pnpm.io) _(recommended)_:

  ```sh
  pnpm add @otjs/ace
  ```

- To install using [Yarn](https://yarnpkg.com):

  ```sh
  yarn add @otjs/ace
  ```

- To install using [Npm](https://www.npmjs.com):

  ```sh
  npm i @otjs/ace --save
  ```

### Peer Dependencies

Make sure to install all the peer dependencies beforehand:

[![Ace Editor](https://img.shields.io/npm/dependency-version/@otjs/ace/peer/ace-builds?style=for-the-badge)](https://ace.c9.io)

## Usage

---

```ts
import { AceAdapter } from "@otjs/ace";

const aceAdapter = new AceAdapter({
  editor:                   // Ace Editor Instance
  announcementDuration:     // Duration (in ms) of User Name Announcement beside Cursor (optional)
  bindEvents:               // Boolean on whether or not to emit events from Adapter (optional)
});
```

**Note**: An API documentation will be shipped along with the package. This will power intellisense in the editor of your choice.

## Testing

We don't have any Unit Test Suite for `@otjs/ace`. Please refer to root [README](https://github.com/0xTheProDev/Operational-Transformation/blob/main/README.md) for details regarding Integration Test Suite that concerns ace.

## Reporting a Bug

Head on to [**Discussion**](https://github.com/0xTheProDev/Operational-Transformation/discussions) section to report a bug or to ask for any feature. Use this [template](https://github.com/0xTheProDev/Operational-Transformation/discussions/30) to make it structural and helpful for the maintainer and the contributors. Feel to add your queries about using this library as well under _Q & A_ section of it. Remember, do not create any Issues by yourself, maintainers of this repository will open one if deemed necessary.

## Changelog

See [CHANGELOG](https://github.com/0xTheProDev/Operational-Transformation/blob/main/CHANGELOG.md) for more details on what has been changed in the latest release.

## Contributing

See [Contributing Guidelines](https://github.com/0xTheProDev/Operational-Transformation/blob/main/.github/CONTRIBUTING.md).

## License

This project is licensed under the terms of the MIT license, see [LICENSE](https://github.com/0xTheProDev/Operational-Transformation/blob/main/packages/ace/LICENSE) for more details.

---
_Source: https://npm.io/package/@otjs/ace · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._