Merge pull request #58 from mikoto2000/langium-firststep

Langium firststep

Author: mikoto2000

Langium/firststep/firststep/.eslintrc.json

@@ -0,0 +1,13 @@
+{
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 6,
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+    }
+}

Langium/firststep/firststep/.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+    // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+
+    // List of extensions which should be recommended for users of this workspace.
+    "recommendations": [
+        "langium.langium-vscode"
+    ]
+}

Langium/firststep/firststep/.vscode/launch.json

@@ -0,0 +1,30 @@
+// A launch configuration that launches the extension inside a new window
+// Use IntelliSense to learn about possible attributes.
+// Hover to view descriptions of existing attributes.
+// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Run Extension",
+            "type": "extensionHost",
+            "request": "launch",
+            "args": [
+                "--extensionDevelopmentPath=${workspaceFolder}"
+            ]
+        },
+        {
+            "name": "Attach to Language Server",
+            "type": "pwa-node",
+            "port": 6009,
+            "request": "attach",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "sourceMaps": true,
+            "outFiles": [
+                "${workspaceFolder}/out/**/*.js"
+            ]
+        }
+    ]
+}

Langium/firststep/firststep/.vscodeignore

@@ -0,0 +1,4 @@
+.vscode/**
+.vscode-test/**
+.gitignore
+langium-quickstart.md

Langium/firststep/firststep/bin/cli

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require("../out/cli").default();

Langium/firststep/firststep/langium-config.json

@@ -0,0 +1,12 @@
+{
+    "projectName": "Firststep",
+    "languages": [{
+        "id": "firststep",
+        "grammar": "src/language-server/firststep.langium",
+        "fileExtensions": [".firststep"],
+        "textMate": {
+            "out": "syntaxes/firststep.tmLanguage.json"
+        }
+    }],
+    "out": "src/language-server/generated"
+}

Langium/firststep/firststep/langium-quickstart.md

@@ -0,0 +1,40 @@
+# Welcome to your Langium VS Code Extension
+
+## What's in the folder
+
+This folder contains all necessary files for your language extension.
+ * `package.json` - the manifest file in which you declare your language support.
+ * `language-configuration.json` - the language configuration used in the VS Code editor, defining the tokens that are used for comments and brackets.
+ * `src/extension.ts` - the main code of the extension, which is responsible for launching a language server and client.
+ * `src/language-server/firststep.langium` -  the grammar definition of your language.
+ * `src/language-server/main.ts` - the entry point of the language server process.
+ * `src/language-server/firststep-module.ts` - the dependency injection module of your language implementation. Use this to register overridden and added services.
+ * `src/language-server/firststep-validator.ts` - an example validator. You should change it to reflect the semantics of your language.
+ * `src/cli/index.ts` - the entry point of the command line interface (CLI) of your language.
+ * `src/cli/generator.ts` - the code generator used by the CLI to write output files from DSL documents.
+ * `src/cli/cli-util.ts` - utility code for the CLI.
+
+## Get up and running straight away
+
+ * Run `npm run langium:generate` to generate TypeScript code from the grammar definition.
+ * Run `npm run build` to compile all TypeScript code.
+ * Press `F5` to open a new window with your extension loaded.
+ * Create a new file with a file name suffix matching your language.
+ * Verify that syntax highlighting, validation, completion etc. are working as expected.
+ * Run `./bin/cli` to see options for the CLI; `./bin/cli generate <file>` generates code for a given DSL file.
+
+## Make changes
+
+ * Run `npm run watch` to have the TypeScript compiler run automatically after every change of the source files.
+ * Run `npm run langium:watch` to have the Langium generator run automatically afer every change of the grammar declaration.
+ * You can relaunch the extension from the debug toolbar after making changes to the files listed above.
+ * You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes.
+
+## Install your extension
+
+* To start using your extension with VS Code, copy it into the `<user home>/.vscode/extensions` folder and restart Code.
+* To share your extension with the world, read the [VS Code documentation](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) about publishing an extension.
+
+## To Go Further
+
+Documentation about the Langium framework is available at https://langium.org

Langium/firststep/firststep/language-configuration.json

@@ -0,0 +1,30 @@
+{
+    "comments": {
+        // symbol used for single line comment. Remove this entry if your language does not support line comments
+        "lineComment": "//",
+        // symbols used for start and end a block comment. Remove this entry if your language does not support block comments
+        "blockComment": [ "/*", "*/" ]
+    },
+    // symbols used as brackets
+    "brackets": [
+        ["{", "}"],
+        ["[", "]"],
+        ["(", ")"]
+    ],
+    // symbols that are auto closed when typing
+    "autoClosingPairs": [
+        ["{", "}"],
+        ["[", "]"],
+        ["(", ")"],
+        ["\"", "\""],
+        ["'", "'"]
+    ],
+    // symbols that can be used to surround a selection
+    "surroundingPairs": [
+        ["{", "}"],
+        ["[", "]"],
+        ["(", ")"],
+        ["\"", "\""],
+        ["'", "'"]
+    ]
+}