|
5 | 5 | [](https://github.com/psf/black) |
6 | 6 | [](https://opensource.org/licenses/MIT) |
7 | 7 |
|
8 | | -`CEDARScript Editor (Python)` is a Python library for interpreting `CEDARScript` scripts and |
9 | | -performing code analysis and modification operations on a codebase. |
| 8 | +`CEDARScript Editor (Python)` is a [CEDARScript](https://github.com/CEDARScript/cedarscript-grammar#readme) runtime |
| 9 | +for interpreting `CEDARScript` scripts and performing code analysis and modification operations on a codebase. |
| 10 | + |
| 11 | +CEDARScript enables offloading _low-level code syntax and structure concerns_, such as indentation and line counting, |
| 12 | +from the LLMs. |
| 13 | +The CEDARScript runtime _bears the brunt of file editing_ by locating the exact line numbers and characters to change, |
| 14 | +which indentation levels to apply to each line and so on, allowing the _CEDARScript commands_ to focus instead on |
| 15 | +**higher levels of abstraction**, like identifier names, line markers, relative indentations and positions |
| 16 | +(`AFTER`, `BEFORE`, `INSIDE` a function, its `BODY`, at the `TOP` or `BOTTOM` of it...) |
10 | 17 |
|
11 | 18 | ## What is CEDARScript? |
12 | 19 |
|
13 | 20 | [CEDARScript](https://github.com/CEDARScript/cedarscript-grammar#readme) (_Concise Examination, Development, And Refactoring Script_) |
14 | | -is a domain-specific language that aims to improve how AI coding assistants interact with codebases and communicate their code modification intentions. |
| 21 | +is a domain-specific language that aims to improve how AI coding assistants interact with codebases and communicate |
| 22 | +their code modification intentions. |
| 23 | + |
15 | 24 | It provides a standardized way to express complex code modification and analysis operations, making it easier for |
16 | 25 | AI-assisted development tools to understand and execute these tasks. |
17 | 26 |
|
18 | 27 | ## Features |
19 | 28 |
|
20 | | -- Given a `CEDARScript` script and a base direcotry, executes the script commands on files inside the base directory; |
| 29 | +- Given a `CEDARScript` script and a base directory, executes the script commands on files inside the base directory; |
21 | 30 | - Return results in `XML` format for easier parsing and processing by LLM systems |
22 | 31 |
|
23 | 32 | ## Installation |
24 | 33 |
|
25 | 34 | You can install `CEDARScript` Editor using pip: |
26 | 35 |
|
27 | 36 | ``` |
28 | | -pip install cedarscript_editor |
| 37 | +pip install cedarscript-editor |
29 | 38 | ``` |
30 | 39 |
|
31 | 40 | ## Usage |
|
0 commit comments