Skip to content

Commit

Permalink
Language server and client (#30)
Browse files Browse the repository at this point in the history
---------

Signed-off-by: Ben Sherman <[email protected]>
  • Loading branch information
bentsherman authored Oct 28, 2024
1 parent efc410e commit 9f77dfa
Show file tree
Hide file tree
Showing 20 changed files with 3,942 additions and 1,151 deletions.
7 changes: 5 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
node_modules
.vsix
.gradle
.vscode
.vsix
build/
language-server
node_modules
4 changes: 2 additions & 2 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
// A launch configuration that launches the extension inside a new window
{
"version": "0.1.0",
"version": "1.0.0",
"configurations": [
{
"name": "Extension",
"type": "extensionHost",
"request": "launch",
"runtimeExecutable": "${execPath}",
"args": ["--extensionDevelopmentPath=${workspaceRoot}" ]
"args": ["--extensionDevelopmentPath=${workspaceRoot}/build" ]
}
]
}
38 changes: 22 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,45 @@
# Nextflow language extension for Visual Studio Code
# Nextflow extension for Visual Studio Code

This extension adds the [Nextflow](https://www.nextflow.io/) language support
to Visual Studio Code editor.
This extension provides [Nextflow](https://www.nextflow.io/) language support for Visual Studio Code.

## Features

It provides syntax highlighting for the Nextflow language and quick shortcuts for common code snippets.

![Nextflow syntax highlighting](images/vscode-nextflow.png)


## Local development

Clone the project repository in your computer:
Clone the project repository:

```bash
git clone https://github.com/nextflow-io/vscode-language-nextflow
```

Change to the project directory and launch VS Code:

git clone https://github.com/nextflow-io/vscode-language-nextflow
```bash
cd vscode-language-nextflow
code .
```

Change in project directory and launch VS code:
Build the extension:

cd vscode-language-nextflow
code .
```bash
./gradlew build
```

Hack the grammar and the snippet definition files. To quickly test changes use the `F5` key.
You can press `F5` to launch a new VS Code window with the extension loaded. Alternatively, you can execute "Extension: Install from VSIX..." from the command pallete to install the extension into your environment (reload required).

## Publishing

Update the extension version number in the `package.json` file,
then use the command:
Update the extension version number in the `package.json` file, then use the command:

```
```bash
vsce publish
```

Read more at [this link](https://code.visualstudio.com/docs/extensions/publish-extension).
Refer to the VS Code [documentation](https://code.visualstudio.com/docs/extensions/publish-extension) for more information.

## Contribution

Expand All @@ -45,5 +52,4 @@ Contributions are greatly appreciated. Please fork [this repository](https://git
* https://code.visualstudio.com/docs/extensionAPI/extension-manifest
* https://marketplace.visualstudio.com/items?itemName=nextflow.nextflow


**Enjoy!**
**Enjoy!**
52 changes: 52 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
plugins {
id "com.moowork.node" version "1.3.1"
}

task copyJar(type: Copy) {
dependsOn ':language-server:build'
from "$projectDir/language-server/build/libs/language-server-all.jar"
into "$buildDir/bin"
}

task copyLocal(type: Copy) {
from "$projectDir"
include "images/**"
include "snippets/**"
include "syntaxes/**"
include "LICENSE.md"
include "language-configuration.json"
include "package.json"
into "$buildDir"
}

task webpack(type: Exec, dependsOn: [npmInstall]) {
inputs.file("package.json")
inputs.file("package-lock.json")
inputs.file("tsconfig.json")
inputs.file("webpack.config.js")
inputs.dir("src")
outputs.file("$buildDir/extension.js")
outputs.file("$buildDir/extension.js.map")

def webpack = "$projectDir/node_modules/.bin/webpack"
if (System.getProperty("os.name").toLowerCase(Locale.ROOT).contains("windows")) {
webpack += ".cmd"
}
commandLine "$webpack", "--mode", "development"
}

task vsce(type: Exec, dependsOn: [copyJar, copyLocal, webpack]) {
inputs.dir("$buildDir")
outputs.file("$buildDir/nextflow-0.4.0.vsix")

def vsce = "$projectDir/node_modules/.bin/vsce"
if (System.getProperty("os.name").toLowerCase(Locale.ROOT).contains("windows")) {
vsce += ".cmd"
}
workingDir "$buildDir"
commandLine "$vsce", "package"
}

task build {
dependsOn vsce
}
Binary file added gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
5 changes: 5 additions & 0 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
183 changes: 183 additions & 0 deletions gradlew
Original file line number Diff line number Diff line change
@@ -0,0 +1,183 @@
#!/usr/bin/env sh

#
# Copyright 2015 the original author or authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################

# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null

APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`

# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'

# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"

warn () {
echo "$*"
}

die () {
echo
echo "$*"
echo
exit 1
}

# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac

CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar

# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi

# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi

# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi

# For Cygwin or MSYS, switch paths to Windows format before running java
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`

# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option

if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=`expr $i + 1`
done
case $i in
0) set -- ;;
1) set -- "$args0" ;;
2) set -- "$args0" "$args1" ;;
3) set -- "$args0" "$args1" "$args2" ;;
4) set -- "$args0" "$args1" "$args2" "$args3" ;;
5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi

# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=`save "$@"`

# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"

exec "$JAVACMD" "$@"
Loading

0 comments on commit 9f77dfa

Please sign in to comment.