1.0.0 • Published 7 months ago

@yuri2/codemirror-ai-enhancer v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

codemirror-ai-enhancer

A CodeMirror extension that leverages AI to perform localized text modifications and continuations.

demo.gif

Demo

Features

  • Guide AI to edit your content
  • Customizable LLM invocation
  • Customizable styles
  • Shortcut key triggered

Use Cases

  • Auto-completion
  • Grammar and spelling correction
  • Tone adjustment
  • Text length adjustment
  • Answer questions based on the context

Installation

npm i @yuri2/codemirror-ai-enhancer

Usage

import "@yuri2/codemirror-ai-enhancer/styles.css";
import CodeMirror from "@uiw/react-codemirror";
import { aiEnhancer } from "@yuri2/codemirror-ai-enhancer";
import { aiEnhancerConfig } from "./aiEnhancerConfig";

export default function MyCodemirror() {
  return <CodeMirror extensions={[aiEnhancer(aiEnhancerConfig)]} />;
}

See aiEnhancerConfig.ts for more details.

Styles

import "@yuri2/codemirror-ai-enhancer/styles.css";

Or, you can customize the styles by yourself.

.cm-enhancer-inline-suggestion {
  opacity: 0.5;
}
.cm-enhancer-inline-answer {
  opacity: 0.5;
}
.cm-enhancer-composer-command input,
.cm-enhancer-assistant-command input {
  outline: none;
  background-color: transparent;
  opacity: 0.5;
  width: 100%;
}

Local Development

In one terminal, build the library itself by running:

cd packages/codemirror-ai-enhancer
npm ci
npm run build

In another terminal, run the demo website:

cd website
npm ci
npm run dev

Changelog

1.0.0

  • Ensure that the extension prevents MOD + J/K/L from propagating.

0.1.0

  • Initial release

Acknowledgements

Inspired by codemirror-copilot.

License

MIT

1.0.0

7 months ago

0.1.0

7 months ago