Skip to content

Commit

Permalink
Adapt links and readme for Eclipse Foundation (#1210)
Browse files Browse the repository at this point in the history
  • Loading branch information
msujew authored Sep 29, 2023
1 parent 3f6332a commit e1276a9
Show file tree
Hide file tree
Showing 15 changed files with 211 additions and 205 deletions.
18 changes: 9 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ We maintain separate change logs for the individual packages:

## Closed Issues and PRs

* [v2.0.0](https://github.com/langium/langium/milestone/9?closed=1)
* [v1.3.0](https://github.com/langium/langium/milestone/7?closed=1)
* [v1.2.0](https://github.com/langium/langium/milestone/8?closed=1)
* [v1.1.0](https://github.com/langium/langium/milestone/6?closed=1)
* [v1.0.0](https://github.com/langium/langium/milestone/5?closed=1)
* [v0.5.0](https://github.com/langium/langium/milestone/4?closed=1)
* [v0.4.0](https://github.com/langium/langium/milestone/3?closed=1)
* [v0.3.0](https://github.com/langium/langium/milestone/2?closed=1)
* [v0.2.0](https://github.com/langium/langium/milestone/1?closed=1)
* [v2.0.0](https://github.com/eclipse-langium/langium/milestone/9?closed=1)
* [v1.3.0](https://github.com/eclipse-langium/langium/milestone/7?closed=1)
* [v1.2.0](https://github.com/eclipse-langium/langium/milestone/8?closed=1)
* [v1.1.0](https://github.com/eclipse-langium/langium/milestone/6?closed=1)
* [v1.0.0](https://github.com/eclipse-langium/langium/milestone/5?closed=1)
* [v0.5.0](https://github.com/eclipse-langium/langium/milestone/4?closed=1)
* [v0.4.0](https://github.com/eclipse-langium/langium/milestone/3?closed=1)
* [v0.3.0](https://github.com/eclipse-langium/langium/milestone/2?closed=1)
* [v0.2.0](https://github.com/eclipse-langium/langium/milestone/1?closed=1)
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

Thank you for your interest in the Langium project! The following is a set of guidelines for contributing to Langium.

## Eclipse Contributor Agreement

If you're planning to contribute to this or any other repository in the [`eclipse-langium` GitHub organization](https://github.com/eclipse-langium), please sign the [Eclipse Contributor Agreement (ECA)](https://www.eclipse.org/legal/ECA.php).

By signing the ECA you promise that your contributions adhere to the license used in the repository of the corresponding Eclipse project. This ensures that Langium can be used by any adopter without any legal issues.

## Prerequisites

For developing Langium you require at least the Maintenance LTS version of Node.js (currently 16) and at least npm version 7.7.0 (`npm@^7.7.0`) to be able to use npm workspaces. With Node.js versions below 16 you have to install the correct version of npm with `npm install -g npm@7`.
Expand Down Expand Up @@ -53,7 +59,7 @@ When you add a dependency to a `package.json` npm resolves this from the configu

There is an npm build target available (`npm run dev-build`) linking all Langium packages to your global scope. It unlinks and uninstalls the Langium packages from the global scope, deletes any `node_modules` folders below the packages directory (see warning above), afterwards performs `npm install` and then links all packages to the global scope again. Then your are able to use `yo langium` or `langium generate` containing your local Langium adjustments from everywhere with your local user.

A project you created with `yo langium` contains a dependency to `langium` (e.g. `0.1.0`) and a dev-dependency to `langium-cli`) inside `package.json` by default. Now, you have to link your own global Langium build to your own language project.
A project you created with `yo langium` contains a dependency to `langium` (e.g. `2.0.0`) and a dev-dependency to `langium-cli`) inside `package.json` by default. Now, you have to link your own global Langium build to your own language project.
Issue the following commands in a shell from the root of your language project:

```shell
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div id="langium-logo" align="center">
<a href="https://github.com/langium/langium">
<a href="https://github.com/eclipse-langium/langium">
<img alt="Langium Logo" width="60%" src="https://user-images.githubusercontent.com/4377073/135283991-90ef7724-649d-440a-8720-df13c23bda82.png">
</a>
<h3>
Expand All @@ -10,16 +10,16 @@
<div id="badges" align="center">

[![npm](https://img.shields.io/npm/v/langium)](https://www.npmjs.com/package/langium)
[![Build](https://github.com/langium/langium/actions/workflows/build.yml/badge.svg)](https://github.com/langium/langium/actions/workflows/build.yml)
[![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/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/langium/langium)
[![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)

</div>

---

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/).
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/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/configuration-services/).
Expand Down Expand Up @@ -53,12 +53,12 @@ The documentation website is hosted in [this repository](https://github.com/lang

## Examples

We host a number of simple examples in our [main repo](https://github.com/langium/langium/tree/main/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/langium/langium/tree/main/examples/arithmetics)**: How to create an expression language + interpreter.
* **[domainmodel](https://github.com/langium/langium/tree/main/examples/domainmodel)**: How to create a language with fully qualified name identifiers.
* **[requirements](https://github.com/langium/langium/tree/main/examples/requirements)**: How to create a Langium project with multiple languages.
* **[statemachine](https://github.com/langium/langium/tree/main/examples/statemachine)**: How to create a code generator.
* **[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):

Expand All @@ -67,6 +67,6 @@ More complex examples are available as separate repositories in [our GitHub orga

## Contributing

If you want to contribute to Langium, please take a look at [our contributing guide](https://github.com/langium/langium/blob/main/CONTRIBUTING.md).
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/langium/langium/blob/main/LICENSE).
Langium is fully [MIT licensed](https://github.com/eclipse-langium/langium/blob/main/LICENSE).
6 changes: 3 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 10 additions & 10 deletions packages/generator-langium/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

## v2.0.0 (Aug. 2023)

* Added a bundle configuration using `esbuild` ([#1125](https://github.com/langium/langium/pull/1125)).
* Configured the project as an ESM project to adapt to the changes in Langium ([#1125](https://github.com/langium/langium/pull/1125)).
* Added a bundle configuration using `esbuild` ([#1125](https://github.com/eclipse-langium/langium/pull/1125)).
* Configured the project as an ESM project to adapt to the changes in Langium ([#1125](https://github.com/eclipse-langium/langium/pull/1125)).

## v1.3.0 (Aug. 2023)

* Fixed a few syntax highlighting related issues ([#1064](https://github.com/langium/langium/pull/1064), [#1079](https://github.com/langium/langium/pull/1079)).
* Fixed a few syntax highlighting related issues ([#1064](https://github.com/eclipse-langium/langium/pull/1064), [#1079](https://github.com/eclipse-langium/langium/pull/1079)).

## v1.2.0 (May. 2023)

Expand All @@ -18,11 +18,11 @@

## v1.1.0 (Feb. 2023)

* Users that have vscode installed in the environment will be asked whether they want to open the generated project in vscode ([#911](https://github.com/langium/langium/pull/911)).
* Users that have vscode installed in the environment will be asked whether they want to open the generated project in vscode ([#911](https://github.com/eclipse-langium/langium/pull/911)).

## v1.0.0 (Dec. 2022) 🎉

* Validation checks are registered in a plain function instead of a registry subclass ([#821](https://github.com/langium/langium/pull/821)).
* Validation checks are registered in a plain function instead of a registry subclass ([#821](https://github.com/eclipse-langium/langium/pull/821)).

---

Expand All @@ -38,9 +38,9 @@ This release updates the generated dependencies to Langium version `0.4.0`.

## v0.3.0 (Mar. 2022)

* The generated project is adapted to the new structure supporting multiple languages ([#311](https://github.com/langium/langium/pull/311)). This mainly affects the configuration format of the `langium` CLI and the separation of _shared services_ and _language-specific services_.
* The generator now prints descriptions of the requested values ([#373](https://github.com/langium/langium/pull/373)).
* Added an `attach` launch config for debugging the language server ([#380](https://github.com/langium/langium/pull/380)).
* The generated project is adapted to the new structure supporting multiple languages ([#311](https://github.com/eclipse-langium/langium/pull/311)). This mainly affects the configuration format of the `langium` CLI and the separation of _shared services_ and _language-specific services_.
* The generator now prints descriptions of the requested values ([#373](https://github.com/eclipse-langium/langium/pull/373)).
* Added an `attach` launch config for debugging the language server ([#380](https://github.com/eclipse-langium/langium/pull/380)).

---

Expand All @@ -54,10 +54,10 @@ This release updates the generated dependencies to Langium version `0.4.0`.

### Added CLI Example

The generated package now includes a Node.js CLI that can be adapted to generate code from your language ([#175](https://github.com/langium/langium/pull/175)). The executable entry point is in the `bin` subfolder.
The generated package now includes a Node.js CLI that can be adapted to generate code from your language ([#175](https://github.com/eclipse-langium/langium/pull/175)). The executable entry point is in the `bin` subfolder.

The initial generator example is based on the "Hello World" grammar; it generates JavaScript code that prints greetings to the console.

### Improved Debugging

By setting the environment variable `DEBUG_BREAK` to a non-empty value, the language server is started with the `--inspect-brk` option of Node.js during debugging ([#227](https://github.com/langium/langium/pull/227)). When active, the language server execution is halted at the start of the entry point (`main.ts`), enabling to debug the initialization phase.
By setting the environment variable `DEBUG_BREAK` to a non-empty value, the language server is started with the `--inspect-brk` option of Node.js during debugging ([#227](https://github.com/eclipse-langium/langium/pull/227)). When active, the language server execution is halted at the start of the entry point (`main.ts`), enabling to debug the initialization phase.
Loading

0 comments on commit e1276a9

Please sign in to comment.