code-peggy-language

KO | EN

gitlite — search

#react #ai #typescript #rust #linux #docker #java #windows #awesome #kubernetes #pytorch #ios #openai #open-source

code-peggy-language

(★ 20)

VSCode syntax highlighting and error reporting for Peggy

code-peggy-language Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Peggy Language Support
======================

Syntax highlighting and error reporting for [Peggy](http://peggyjs.org) in Visual Studio Code.

## Install

See the [Marketplace](https://marketplace.visualstudio.com/items?itemName=PeggyJS.peggy-language).

## Preferences

- `peggyLanguageServer.consoleInfo` [default: *false*]: Show info messages
  that don't have locations in the console.  Examples include diagnostics
  about which compiler passes have been run.  This is mostly useful for
  debugging the extension.
- `peggyLanguageServer.markInfo` [default: *true*]: Mark all diagnostics, even
  merely informative ones.  Some grammar compiler passes will give informative
  messages about optimizations.  Those may be more annoying to you than
  helpful, depending on your approach to grammar writing.
- `peggyLanguageServer.debounceMS` [default: *200*] Amount of time to wait
  after a file has changed before running.  Longer times use less CPU but are
  less responsive.
- `peggyLanguageServer.filePattern` [default: *%s/%s.js*] Convert a grammar
  name to a JS file to output, using this first `%s` as the directory and the
  second `%s` as the unsuffixed name of the grammar.  This is useful in a per-
  workspace configuration file so that `import` and `require` work from the
  correct output directory.

## Syntax Highlighting

![Syntax Highlighting](https://raw.githubusercontent.com/peggyjs/code-peggy-language/main/images/highlighting.png)

## Error Reporting

Errors in the grammar are highlighted.

![Error Reporting](https://raw.githubusercontent.com/peggyjs/code-peggy-language/main/images/error.png)

## Go to / Peek Definition

Right-click a rule name, and go to its definition.

![Go To Definition](https://raw.githubusercontent.com/peggyjs/code-peggy-language/main/images/GoToDefinition.png)

## Go to / Peek References

Right click a rule name, and see all of the places it is used.

![Go To References](https://raw.githubusercontent.com/peggyjs/code-peggy-language/main/images/GoToReferences.png)

## Rename Symbol

Rename a rule and all of the places that it is used.

![Rename Symbol](https://raw.githubusercontent.com/peggyjs/code-peggy-language/main/images/renameSymbol.png)

## Outline / Symbol Support

See the current rule in the breadcrumbs at the top of the editor, and a list
of all of the rules in the Outline view.

![Breadcrumbs](https://raw.githubusercontent.com/peggyjs/code-peggy-language/main/images/breadcrumbs.png)

![Outline](https://raw.githubusercontent.com/peggyjs/code-peggy-language/main/images/outline.png)

## Live Preview

Live edit and test your Grammars, optionally starting at the rule under cursor.

![Live Preview Menu](https://raw.githubusercontent.com/peggyjs/code-peggy-language/main/images/LivePreviewMenu.png)

![Live Preview](https://raw.githubusercontent.com/peggyjs/code-peggy-language/main/images/LivePreview.png)

## Problem Matchers

Report problems of your code in the Problems view when `peggy` is run in a task.
The extension provides two problem matchers: `$peggy` and `$peggy-watch`.

Configure them like the following in your `.vscode/tasks.json`:

```json
{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "npm: compile (peggy)",
      "type": "npm",
      "group": {
        "kind": "build",
        "isDefault": true
      },
      "script": "compile",
      "problemMatcher": "$peggy"
    },
    {
      "label": "npm: watch (peggy)",
      "type": "npm",
      "group": "build",
      "script": "watch",
      "isBackground": true,
      "problemMatcher": "$peggy-watch"
    }
  ]
}
```

and in your `package.json`:

```json
{
  "scripts": {
    "compile": "peggy grammar.peggy",
    "watch": "peggy --watch grammar.peggy"
  },
  "devDependencies": {
    "peggy": "^5.0.3"
  }
}
```

Then you can compile your grammar via the command palette with "Tasks: Run Task".
See [Task / VS Code Extension API](https://code.visualstudio.com/docs/debugtest/tasks) for more details.

### Tips

Name your grammar like this for optimal experience: grammar_name.language_extension.peggy. Where language_extension is the extension of the language you're parsing. This will provide syntax highlighting if you have a matching language server installed.

## Contributing

Feel free to contribute to this extension [here](https://github.com/peggyjs/code-peggy-language).
Please read the [CONTRIBUTING.md](/CONTRIBUTING.md).

## Origins

Based on [code-pegjs-language](https://github.com/SrTobi/code-pegjs-language) by [Tobias Kahlert](https://github.com/SrTobi)

code-peggy-language

code-peggy-language Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

code-peggy-language

code-peggy-language Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README