VS Code/Codium extension for flux

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{gradle,yml}]
+indent_size = 2

.gitignore

@@ -0,0 +1,12 @@
+.gradle/
+bin/
+build/
+generated/
+xtext-gen/
+xtend-gen/
+.project
+.classpath
+out/
+node_modules/
+xtext-server/
+package-lock.json

.settings/org.eclipse.buildship.core.prefs

@@ -0,0 +1,7 @@
+connection.arguments=
+connection.gradle.user.home=null
+connection.java.home=null
+connection.jvm.arguments=
+connection.project.dir=
+eclipse.preferences.version=1
+project.path=\:

.settings/org.eclipse.core.resources.prefs

@@ -0,0 +1,2 @@
+eclipse.preferences.version=1
+encoding/<project>=UTF-8

.travis.yml

@@ -0,0 +1,7 @@
+language: java
+
+before_script:
+  - ./gradlew installServer
+  - cd org.metafacture.flux.vsc/
+  - npm install
+  - cd ..

README.md

@@ -1,2 +1,22 @@
 # metafacture-flux
 Xtext-based tool support for the Metafacture Flux language
+
+Visual Studio Code/Codium Extension
+---------------------------
+The project `org.metafacture.flux.vsc` provides an extension for Visual Studio Code for `flux` via the language server protocol (LSP). In the current state the extension supports auto completion, simple syntax highlighting and auto closing brackets and quotes. This project was created using the [tutorial](https://www.typefox.io/blog/building-a-vs-code-extension-with-xtext-and-the-language-server-protocol) and the corrresponding [example](https://github.com/TypeFox/languageserver-example).
+
+Start extension:
+
+1. Install Visual Studio Code / alternative: VS Codium
+2. Install Node.js (including npm)
+3. Clone metafacture-flux project and change directory
+`git clone https://github.com/metafacture/metafacture-flux.git`
+`cd metafacture-flux`
+4. In metafacture-flux execute:
+Unix: `./gradlew installServer`
+Windows: `.\gradlew.bat installServer`
+5. In org.metafacture.flux.vsc execute (tip: if you use windows, install cygwin to execute npm commands):
+`npm install`
+6. Open org.metafacture.flux.vsc in Visual Studio Code
+7. Launch extension by pressing F5 (opens new window of Visual Studio Code)
+8. Open new file (file-ending .flux) or open existing fix-file

build.gradle

@@ -0,0 +1,64 @@
+buildscript {
+	repositories {
+		mavenCentral()
+	}
+	dependencies {
+		classpath 'org.xtext:xtext-gradle-plugin:2.0.8'
+	}
+}
+
+plugins {
+  id 'org.ec4j.editorconfig' version '0.0.3'
+  id 'org.xtext.builder' version '2.0.8'
+}
+
+editorconfig {
+  excludes = [
+    '**/generated',
+    '**/xtext-gen',
+    '**/bin',
+    '**/.*',
+    'gradlew*',
+    '**/out',
+    '**/node_modules'
+  ]
+}
+
+check.dependsOn(editorconfigCheck)
+
+subprojects {
+	ext.xtextVersion = '2.23.0'
+	repositories {
+		mavenCentral()
+	}
+
+	apply plugin: 'java'
+	dependencies {
+		compile platform("org.eclipse.xtext:xtext-dev-bom:${xtextVersion}")
+	}
+
+	apply plugin: 'org.xtext.builder'
+	apply from: "${rootDir}/gradle/source-layout.gradle"
+	apply plugin: 'eclipse'
+    apply plugin: 'checkstyle'
+
+	group = 'org.metafacture.flux'
+	version = '1.0.0-SNAPSHOT'
+
+  sourceCompatibility = '1.8'
+  targetCompatibility = '1.8'
+
+	configurations.all {
+		exclude group: 'asm'
+	}
+
+  checkstyle {
+    toolVersion '8.30'
+  }
+}
+
+task installServer(type: Copy) {
+	dependsOn(':org.metafacture.flux.ide:installDist')
+    from "org.metafacture.flux.ide/build/install/xtext-server"
+    into "org.metafacture.flux.vsc/xtext-server"
+}

config/checkstyle/checkstyle.xml

@@ -0,0 +1,165 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE module PUBLIC
+    "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+    "https://checkstyle.org/dtds/configuration_1_3.dtd">
+<module name="Checker">
+    <module name="SuppressionSingleFilter">
+        <property name="checks" value=".*"/>
+        <property name="files" value="xtext-gen"/>
+    </module>
+    <module name="TreeWalker">
+        <module name="AbstractClassName"/>
+        <module name="AnnotationUseStyle"/>
+        <module name="AnonInnerLength"/>
+        <module name="ArrayTypeStyle"/>
+        <module name="AvoidNestedBlocks"/>
+        <module name="AvoidNoArgumentSuperConstructorCall"/>
+        <module name="AvoidStarImport"/>
+        <module name="AvoidStaticImport"/>
+        <module name="BooleanExpressionComplexity"/>
+        <module name="CatchParameterName">
+            <property name="format" value="^e$"/>
+        </module>
+        <module name="ClassDataAbstractionCoupling"/>
+        <module name="ClassFanOutComplexity"/>
+        <module name="ClassTypeParameterName"/>
+        <module name="ConstantName"/>
+        <module name="CovariantEquals"/>
+        <module name="CustomImportOrder">
+            <property name="customImportOrderRules" value="SAME_PACKAGE(2)###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###STATIC"/>
+            <property name="separateLineBetweenGroups" value="true"/>
+        </module>
+        <module name="CyclomaticComplexity"/>
+        <module name="DeclarationOrder"/>
+        <module name="DefaultComesLast"/>
+        <module name="EmptyLineSeparator">
+            <property name="allowMultipleEmptyLines" value="false"/>
+            <property name="allowMultipleEmptyLinesInsideClassMembers" value="false"/>
+            <property name="allowNoEmptyLineBetweenFields" value="true"/>
+        </module>
+        <module name="EmptyStatement"/>
+        <module name="EqualsAvoidNull"/>
+        <module name="EqualsHashCode"/>
+        <module name="ExecutableStatementCount"/>
+        <module name="ExplicitInitialization"/>
+        <module name="FallThrough"/>
+        <module name="FinalLocalVariable">
+            <property name="validateEnhancedForLoopVariable" value="true"/>
+        </module>
+        <module name="FinalParameters">
+            <property name="tokens" value="CTOR_DEF,LITERAL_CATCH,METHOD_DEF"/>
+        </module>
+        <module name="GenericWhitespace"/>
+        <module name="HiddenField">
+            <property name="ignoreConstructorParameter" value="true"/>
+            <property name="ignoreSetter" value="true"/>
+        </module>
+        <module name="HideUtilityClassConstructor"/>
+        <module name="IllegalCatch"/>
+        <module name="IllegalThrows"/>
+        <module name="IllegalToken">
+            <property name="tokens" value="POST_INC,POST_DEC"/>
+        </module>
+        <module name="IllegalType"/>
+        <module name="Indentation"/>
+        <module name="InnerAssignment"/>
+        <module name="InnerTypeLast"/>
+        <module name="InterfaceIsType"/>
+        <module name="InterfaceTypeParameterName"/>
+        <module name="JavaNCSS"/>
+        <module name="JavadocType"/>
+        <module name="LambdaParameterName"/>
+        <module name="LeftCurly"/>
+        <module name="LocalFinalVariableName"/>
+        <module name="LocalVariableName"/>
+        <module name="MagicNumber"/>
+        <module name="MemberName"/>
+        <module name="MethodLength"/>
+        <module name="MethodName"/>
+        <module name="MethodParamPad"/>
+        <module name="MethodTypeParameterName"/>
+        <module name="MissingCtor"/>
+        <module name="MissingDeprecated"/>
+        <module name="MissingOverride"/>
+        <module name="MissingSwitchDefault"/>
+        <module name="ModifiedControlVariable"/>
+        <module name="ModifierOrder"/>
+        <module name="MultipleStringLiterals">
+            <property name="allowedDuplicates" value="2"/>
+            <property name="ignoreStringsRegexp" value="^&quot;.?.?&quot;$"/>
+        </module>
+        <module name="MultipleVariableDeclarations"/>
+        <module name="MutableException"/>
+        <module name="NeedBraces"/>
+        <module name="NPathComplexity"/>
+        <module name="NoArrayTrailingComma"/>
+        <module name="NoClone"/>
+        <module name="NoEnumTrailingComma"/>
+        <module name="NoFinalizer"/>
+        <module name="NoWhitespaceAfter"/>
+        <module name="NoWhitespaceBefore"/>
+        <module name="OneStatementPerLine">
+            <property name="treatTryResourcesAsStatement" value="true"/>
+        </module>
+        <module name="OneTopLevelClass"/>
+        <module name="OperatorWrap">
+            <property name="option" value="eol"/>
+        </module>
+        <module name="OuterTypeFilename"/>
+        <module name="OuterTypeNumber"/>
+        <module name="OverloadMethodsDeclarationOrder"/>
+        <module name="PackageDeclaration"/>
+        <module name="PackageName"/>
+        <module name="ParameterAssignment"/>
+        <module name="ParameterName"/>
+        <module name="ParameterNumber">
+            <property name="max" value="5"/>
+        </module>
+        <module name="ParenPad"/>
+        <module name="RedundantImport"/>
+        <module name="RedundantModifier"/>
+        <module name="RequireThis"/>
+        <module name="ReturnCount"/>
+        <module name="RightCurly">
+            <property name="option" value="alone"/>
+        </module>
+        <module name="SeparatorWrap">
+            <property name="tokens" value="COMMA,SEMI,ELLIPSIS,ARRAY_DECLARATOR"/>
+            <property name="option" value="eol"/>
+        </module>
+        <module name="SeparatorWrap">
+            <property name="tokens" value="DOT,AT,METHOD_REF"/>
+            <property name="option" value="nl"/>
+        </module>
+        <module name="SimplifyBooleanExpression"/>
+        <module name="SimplifyBooleanReturn"/>
+        <module name="StaticVariableName"/>
+        <module name="StringLiteralEquality"/>
+        <module name="SuperClone"/>
+        <module name="SuperFinalize"/>
+        <module name="SuppressWarnings">
+            <!-- allow: fallthrough, unchecked (cf. https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javac.html#BHCJBHDF) -->
+            <property name="format" value="^\s*(?:all|cast|classfile|deprecation|dep-ann|divzero|empty|finally|options|overrides|path|processing|rawtypes|Serial|static|try|varargs)\s*$"/>
+        </module>
+        <module name="SuppressWithNearbyCommentFilter">
+            <property name="checkFormat" value="$1"/>
+            <property name="commentFormat" value="checkstyle-disable-line (\w+(?:\|\w+)?)"/>
+        </module>
+        <module name="ThrowsCount">
+            <property name="max" value="2"/>
+        </module>
+        <module name="TypecastParenPad"/>
+        <module name="TypeName"/>
+        <module name="UnnecessaryParentheses"/>
+        <module name="UnnecessarySemicolonAfterTypeMemberDeclaration"/>
+        <module name="UnnecessarySemicolonInEnumeration"/>
+        <module name="UnnecessarySemicolonInTryWithResources">
+            <property name="allowWhenNoBraceAfterSemicolon" value="false"/>
+        </module>
+        <module name="UnusedImports"/>
+        <module name="UpperEll"/>
+        <module name="VisibilityModifier"/>
+        <module name="WhitespaceAfter"/>
+        <module name="WhitespaceAround"/>
+    </module>
+</module>

gradle/source-layout.gradle

@@ -0,0 +1,26 @@
+sourceSets {
+	main {
+		java.srcDirs = ['src/main/java', 'src/main/xtext-gen']
+		resources.srcDirs = ['src/main/resources', 'src/main/xtext-gen']
+	}
+	test {
+		java.srcDirs = ['src/test/java', 'src/test/xtext-gen']
+		resources.srcDirs = ['src/test/resources', 'src/test/xtext-gen']
+	}
+}
+
+jar {
+	from('model') {
+		into('model')
+	}
+	from(sourceSets.main.allSource) {
+		include '**/*.xtext'
+	}
+	manifest {
+		attributes 'Bundle-SymbolicName': project.name
+	}
+}
+
+plugins.withId('war') {
+	webAppDirName = "src/main/webapp"
+}

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.3-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists