Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eclipse-langium/langium

Next-gen language engineering / DSL framework
https://github.com/eclipse-langium/langium

domain-specific-language dsl language-engineering language-server-protocol typescript vscode

Last synced: 5 days ago
JSON representation

Next-gen language engineering / DSL framework

Host: GitHub
URL: https://github.com/eclipse-langium/langium
Owner: eclipse-langium
License: mit
Created: 2021-02-22T13:23:40.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-10-25T13:31:13.000Z (17 days ago)
Last Synced: 2024-10-27T07:35:41.891Z (15 days ago)
Topics: domain-specific-language, dsl, language-engineering, language-server-protocol, typescript, vscode
Language: TypeScript
Homepage: https://langium.org/
Size: 5.34 MB
Stars: 738
Watchers: 23
Forks: 66
Open Issues: 99
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        


  

    

  

  

    Next-gen language engineering framework

  





  [![npm](https://img.shields.io/npm/v/langium)](https://www.npmjs.com/package/langium)

  [![Build](https://github.com/eclipse-langium/langium/actions/workflows/actions.yml/badge.svg)](https://github.com/eclipse-langium/langium/actions/workflows/actions.yml)

  [![Gitter Chat](https://img.shields.io/badge/chat-on%20gitter-0DBD8B?logo=gitter)](https://app.gitter.im/#/room/#langium:gitter.im)

  [![Github Discussions](https://img.shields.io/badge/github-discussions-blue?logo=github)](https://github.com/eclipse-langium/langium/discussions)

  [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-FFAE33?logo=gitpod)](https://gitpod.io/#https://github.com/eclipse-langium/langium)



---

Eclipse Langium (IPA: /ˈlæŋɡiəm/, like **lang**uage and equilibr**ium**) is a language engineering tool for [TypeScript](https://www.typescriptlang.org/) with built-in support for the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/). The framework is an all-in-one solution for building programming languages, domain specific languages, code generators, interpreters and compilers. It serves as a spiritual successor to the [Eclipse Xtext framework](https://www.eclipse.org/Xtext/).

* **Semantics First:** Building on top of a [grammar declaration language](https://langium.org/docs/reference/grammar-language/), Langium enables you to build the abstract model of your language in parallel to its syntax. Langium parsers are powered by [Chevrotain](https://chevrotain.io).

* **Lean by Default, Customizable by Design:** Langium offers the infrastructure you need to build languages purely by defining their grammar. If that is not enough, you can fine tune every detail of your language using our [dependency injection system](https://langium.org/docs/reference/configuration-services/).

* **Write Once, Run Everywhere:** By leveraging the flexibility of JavaScript and the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/), a language written using Langium can run in all kinds of IDEs and browsers or be embedded in CLIs and server applications.

## Installation

Build your first language with Langium in our [online playground](https://langium.org/playground/).

Once you're ready to set up a project, you can use yeoman to generate a [sample Langium project](https://langium.org/docs/learn/workflow/):

```sh

npm i -g yo generator-langium

yo langium

```

## Documentation

You can find the Langium documentation on [the website](https://langium.org/).

If you're new to building programming language, take a look at [our overview to see what Langium offers](https://langium.org/docs/features/). 

The documentation is divided into several sections:

* [Learning Langium](https://langium.org/docs/learn/workflow/)

* [Referece](https://langium.org/docs/reference/)

* [Recipes](https://langium.org/docs/recipes/)

* [Playground](https://langium.org/playground/)

The documentation website is hosted in [this repository](https://github.com/langium/langium-website).

## Examples

We host a number of simple examples in our [main repo](https://github.com/eclipse-langium/langium/tree/main/examples):

* **[arithmetics](https://github.com/eclipse-langium/langium/tree/main/examples/arithmetics)**: How to create an expression language + interpreter.

* **[domainmodel](https://github.com/eclipse-langium/langium/tree/main/examples/domainmodel)**: How to create a language with fully qualified name identifiers.

* **[requirements](https://github.com/eclipse-langium/langium/tree/main/examples/requirements)**: How to create a Langium project with multiple languages.

* **[statemachine](https://github.com/eclipse-langium/langium/tree/main/examples/statemachine)**: How to create a code generator.

More complex examples are available as separate repositories in [our GitHub organization](https://github.com/langium):

* **[lox](https://github.com/langium/langium-lox)**: Implementation of the Lox language from the popular book [Crafting Interpreters](https://craftinginterpreters.com/the-lox-language.html).

* **[minilogo](https://github.com/langium/langium-minilogo)**: Implementation of a [logo](https://el.media.mit.edu/logo-foundation/what_is_logo/logo_programming.html) language dialect. Shows how to integrate Langium in the browser.

## Contributing

If you want to contribute to Langium, please take a look at [our contributing guide](https://github.com/eclipse-langium/langium/blob/main/CONTRIBUTING.md).

Langium is fully [MIT licensed](https://github.com/eclipse-langium/langium/blob/main/LICENSE).