https://github.com/ohmjs/ohm-editor

An IDE for the Ohm language (JavaScript edition)
https://github.com/ohmjs/ohm-editor

editor grammars ohm parsing peg

Last synced: 6 days ago
JSON representation

An IDE for the Ohm language (JavaScript edition)

• Host: GitHub
• URL: https://github.com/ohmjs/ohm-editor
• Owner: ohmjs
• License: mit
• Created: 2016-05-16T22:24:07.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2023-05-02T13:06:20.000Z (over 1 year ago)
• Last Synced: 2024-04-14T17:21:55.447Z (7 months ago)
• Topics: editor, grammars, ohm, parsing, peg
• Language: JavaScript
• Size: 50 MB
• Stars: 94
• Watchers: 23
• Forks: 15
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Ohm Editor

[![Build Status](https://github.com/ohmjs/ohm-editor/actions/workflows/node.js.yml/badge.svg)](https://github.com/ohmjs/ohm-editor/actions/workflows/node.js.yml)

[![Live demo](https://img.shields.io/badge/Live%20demo-%E2%86%92-9D6EB3.svg)](https://ohmlang.github.io/editor/)

A standalone editor for the [Ohm](https://github.com/cdglabs/ohm) language.

## Usage

Clone this repository and run `npm install` in the project root.

To run the editor in the browser:

    npm start

## Development Notes

- To deploy from your local repository to https://ohmlang.github.io/editor/, use `bin/deploy-gh-pages.sh`. When the script shows the following prompt:

        Do you want to deploy to ohmlang.github.io (y/n)?

  ...you can test things locally by switching to your clone of ohmlang.github.io and running the following command in the repository root:

        python -c "import SimpleHTTPServer; m = SimpleHTTPServer.SimpleHTTPRequestHandler.extensions_map; m[''] = 'text/plain'; m.update(dict([(k, v + ';charset=UTF-8') for k, v in m.items()])); SimpleHTTPServer.test();"

  This will serve the contents of the ohmlang.github.io site locally.

### Playwright tests

E2E tests are configured to run on every commit to `main` and each pull request. They can also be run locally via `npm run test:e2e`.

**To update snapshots:** create a pull request on a branch whose name begins with the prefix `update-snapshots/`. This will trigger the Playwright workflow (see `playwright.yml`) to run with the `--update-snapshots` option and then commit the results to the original branch. If all looks good, you can then merge the PR to main.