Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add links checker and add aliases #237

Merged
merged 9 commits into from
Jun 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/workflows/links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Check if all links are reachable
on:
push:
branches: main
pull_request:
branches: main
workflow_dispatch:

jobs:
check:
runs-on: ubuntu-latest
steps:
- name: Use Node.js
uses: actions/setup-node@v3
with:
node-version: '18'
- name: Checkout
uses: actions/checkout@v3
- name: Install
run: npm ci
- name: Check links
run: npm run check:links
6 changes: 3 additions & 3 deletions hugo/content/docs/introduction/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ In this chapter, you'll get a closer look at the requirements developers usually
- [Cross References and Linking](#cross-references-and-linking)
- [Workspace Management](#workspace-management)
- [Editing Support](#editing-support)
- [Try it out!](#try-it-out)
- [Try it out](#try-it-out)

Langium provides out-of-the-box solutions for these problems, with the ability to fine-tune every part of it to fit your domain requirements.

---

## Language Parsing

Programming languages and domain specific languages (DSLs) cannot be parsed using simple regular expressions (RegExp). Instead they require a more sophisticated parsing strategy. To define a custom language in Langium, you interact with a high level representation of your context-free grammar using the [Langium grammar language](/docs/grammar-language), in a similar fashion to EBNF.
Programming languages and domain specific languages (DSLs) cannot be parsed using simple regular expressions (RegExp). Instead they require a more sophisticated parsing strategy. To define a custom language in Langium, you interact with a high level representation of your context-free grammar using the [Langium grammar language](/docs/reference/grammar-language), in a similar fashion to EBNF.

Based on the grammar, Langium is then able to construct a parser which transforms an input string into a semantic model representation. Just as the name suggests, this model captures the essential structure to describe your language.

Expand Down Expand Up @@ -97,7 +97,7 @@ The Langium framework is deeply integrated with the [language server protocol](h

The LSP includes commonly used language features, such as code completion, custom validations/diagnostics, finding references, formatting and many more. This allows for deep IDE integration without binding your language to a single IDE. Langium offers out-of-the-box support for most of these language features, with additional extension points for your domain specific requirements.

## Try it out!
## Try it out

You can try out most of these features using our [showcase](/showcase/) and [playground](/playground/). The languages shown there are written using Langium and integrated in the monaco-editor.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "Building an Extension"
weight: 5
aliases:
- /tutorials/building_an_extension
---

{{< toc format=html >}}
Expand Down
2 changes: 2 additions & 0 deletions hugo/content/docs/learn/minilogo/customizing_cli.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "Customizing the CLI"
weight: 2
aliases:
- /tutorials/customizing_cli
---

{{< toc format=html >}}
Expand Down
2 changes: 2 additions & 0 deletions hugo/content/docs/learn/minilogo/generation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "Generation"
weight: 3
aliases:
- /tutorials/generation
---

{{< toc format=html >}}
Expand Down
2 changes: 2 additions & 0 deletions hugo/content/docs/learn/minilogo/generation_in_the_web.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "Generation in the Web"
weight: 7
aliases:
- /tutorials/generation_in_the_web
---

{{< toc format=html >}}
Expand Down
2 changes: 2 additions & 0 deletions hugo/content/docs/learn/minilogo/langium_and_monaco.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "Langium + Monaco Editor"
weight: 6
aliases:
- /tutorials/langium_and_monaco
---

{{< toc format=html >}}
Expand Down
2 changes: 2 additions & 0 deletions hugo/content/docs/learn/minilogo/validation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "Validation"
weight: 1
aliases:
- /tutorials/validation
---

{{< toc format=html >}}
Expand Down
3 changes: 3 additions & 0 deletions hugo/content/docs/learn/minilogo/writing_a_grammar.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: "Writing a Grammar"
weight: 0
aliases:
- /tutorials/writing_a_grammar
- /writing_a_grammar
---

{{< toc format=html >}}
Expand Down
4 changes: 3 additions & 1 deletion hugo/content/docs/learn/workflow/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: "Langium's workflow"
weight: 0
url: /docs/learn/workflow/
url: /docs/learn/workflow
aliases:
- /docs/getting-started
---

Langium's workflow can be expressed as a flow chart diagram, which boils down to the following steps in the diagram.
Expand Down
2 changes: 1 addition & 1 deletion hugo/content/docs/recipes/builtin-library.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ For example, TypeScript provides users with typings for globally accessible vari
They are part of the JavaScript runtime, and not defined by any user or a package they might import.
Instead, these features are contributed through what we call builtin libraries.

Loading a builtin library in Langium is very simple. We first start off with defining the source code of the library using the *hello world* language from the [getting started guide](/docs/getting-started):
Loading a builtin library in Langium is very simple. We first start off with defining the source code of the library using the *hello world* language from the [getting started guide](/docs/learn/workflow):

```ts
export const builtinHelloWorld = `
Expand Down
4 changes: 3 additions & 1 deletion hugo/content/docs/recipes/code-bundling.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: "Code Bundling"
weight: 900
aliases:
- /guides/code-bundling
---

When you first create a Langium project using the [Yeoman generator](/docs/learn/workflow/install), it will only contain a plain TypeScript configuration, without any additional build processes.
When you first create a Langium project using the [Yeoman generator](/docs/learn/workflow/scaffold#your-first-example-language), it will only contain a plain TypeScript configuration, without any additional build processes.
However, if you want to make your language available for consumption in a non-development context, you'll want to create a bundle.
It is not absolutely necessary in a Node.js context, since you can always resolve local `node_modules` but it's still recommended [for vscode extensions](https://code.visualstudio.com/api/working-with-extensions/bundling-extension).
It improves performance and decreases file size by minifying your code and only including what you actually need.
Expand Down
2 changes: 1 addition & 1 deletion hugo/content/docs/recipes/multiple-languages.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The entire change touches several files. Let's summarize what needs to be done:

## Our scenario

To keep this guide easy, I will use the `hello-world` project from the [learning section](/docs/learn/workflow).
To keep this guide easy, I will use the [`hello-world` project](/docs/learn/workflow) of the learning section.

Let’s imagine that we have three languages:

Expand Down
4 changes: 2 additions & 2 deletions hugo/content/docs/recipes/scoping/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ In general, the way we resolve references is split into three phases of the docu

In this guide, we'll look at different scoping kinds and styles and see how we can achieve them using Langium:

1. [Qualified Name Scoping](./qualified-name)
2. [Class Member Scoping](./class-member)
1. [Qualified Name Scoping](/docs/recipes/scoping/qualified-name)
2. [Class Member Scoping](/docs/recipes/scoping/class-member)

Note that these are just example implementations for commonly used scoping methods.
The scoping API of Langium is designed to be flexible and extensible for any kind of use case.
2 changes: 2 additions & 0 deletions hugo/content/docs/recipes/scoping/class-member.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "Class Member Scoping"
weight: 200
aliases:
- /class-member
---

In this guide we will take a look at member based scoping. It's a mechanism you are likely familiar with from object oriented languages such as Java, C# and JavaScript:
Expand Down
4 changes: 3 additions & 1 deletion hugo/content/docs/recipes/scoping/qualified-name.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "Qualified Name Scoping"
weight: 100
aliases:
- /qualified-name
---

Qualified name scoping refers to a style of referencing elements using a fully qualified name.
Expand All @@ -21,7 +23,7 @@ void main() {

As can be seen, using qualified name scoping is quite helpful in this case. It allows us to reference the `getDocumentation` function through the scope computed & made available by the `Langium` namespace, even though it's not directly accessible within the scope of `main` by itself.

Note that such behavior can also be accomplished using [class member scoping](./class-member).
Note that such behavior can also be accomplished using [class member scoping](/docs/recipes/scoping/class-member).
However, there is one core advantage to using globally available elements:
Compared to member scoping, this type of scoping requires few resources.
The lookup required for qualified name scoping can be done in near constant time with just a bit of additional computation on a **per-document** basis, whereas member scoping needs to do a lot of computation on a **per-reference** basis.
Expand Down
2 changes: 2 additions & 0 deletions hugo/content/docs/reference/document-lifecycle.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: 'Document Lifecycle'
weight: 300
aliases:
- /docs/document-lifecycle
---

`LangiumDocument` is the central data structure in Langium that represents a text file of your DSL. Its main purpose is to hold the parsed Abstract Syntax Tree (AST) plus additional information derived from it. After its creation, a `LangiumDocument` must be "built" before it can be used in any way. The service responsible for building documents is called `DocumentBuilder`.
Expand Down
7 changes: 6 additions & 1 deletion hugo/content/docs/reference/grammar-language.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
---
title: "Grammar Language"
weight: 100
aliases:
- /grammar-language
- /docs/grammar-language
---

{{< toc format=html >}}

The grammar language describes the syntax and structure of your language. The [Langium grammar language](https://github.com/eclipse-langium/langium/blob/main/packages/langium/src/grammar/langium-grammar.langium) is implemented using Langium itself and therefore follows the same syntactic rules as any language created with Langium. The grammar language will define the structure of the *abstract syntax tree* (AST) which in Langium is a collection of *TypeScript types* describing the content of a parsed document and organized hierarchically. The individual nodes of the tree are then represented with JavaScript objects at runtime.

In the following, we describe the Langium syntax and document structure.

## Language Declaration

An *entry* Langium grammar file (i.e. a grammar which contains an [entry rule](#the-entry-rule)) always starts with a header which declares the name of the language. For example, a language named `MyLanguage` would be declared with:

```langium
Expand Down Expand Up @@ -77,7 +82,7 @@ Person:
```
In this example, the parser will create an object of type `Person`. This object will have a property `name` which value and type must match the terminal rule `ID` (i.e. the property `name` is of type `string` and cannot start with a digit or special character).

By default, the parser will create an object with an inferred type corresponding to the parser rule name. It is possible to override this behavior by explicitly defining the type of the object to be created. This is done by adding the keyword `returns` followed by a separately declared type, or the keyword `infers` followed by the name of the type to be inferred for this rule (more about this [in the next chapter](../sematic-model)):
By default, the parser will create an object with an inferred type corresponding to the parser rule name. It is possible to override this behavior by explicitly defining the type of the object to be created. This is done by adding the keyword `returns` followed by a separately declared type, or the keyword `infers` followed by the name of the type to be inferred for this rule (more about this [in the next chapter](/docs/reference/semantic-model)):
```langium
Person infers OtherType:
'person' name=ID;
Expand Down
5 changes: 4 additions & 1 deletion hugo/content/docs/reference/semantic-model.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: "Semantic Model Inference"
weight: 400
aliases:
- /sematic-model
- /semantic-model
---

When AST nodes are created during the parsing of a document, they are given a type. The language grammar dictates the shape of those types and how they might be related to each other. All types form the *semantic model* of your language. There are two ways by which Langium derives semantic model types from the grammar, by **[inference](#inferred-types)** and by **[declaration](#declared-types)**.
Expand Down Expand Up @@ -89,7 +92,7 @@ interface X extends AstNode {
```

### Assignments
There are three available kinds of [assignments](../grammar-language/#assignments) in a parser rule:
There are three available kinds of [assignments](/docs/reference/grammar-language/#assignments) in a parser rule:

1. `=` for assigning a **single value** to a property, resulting in the property's type to be derived from the right hand side of the assignment.
2. `+=` for assigning **multiple values** to a property, resulting in the property's type to be an array of the right hand side of the assignment.
Expand Down
Loading
Loading