Merge pull request #84 from jpogran/language-server-feature

Language server feature

Author: jpogran

.gitignore

@@ -0,0 +1,43 @@
+language: node_js
+node_js:
+  - "node"
+
+environment:
+  ELECTRON_RUN_AS_NODE: 1
+  VSCODE_BUILD_VERBOSE: true
+
+sudo: false
+
+os:
+  - linux
+
+addons:
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+    packages:
+      - gcc-4.9
+      - g++-4.9
+      - gcc-4.9-multilib
+      - g++-4.9-multilib
+      - zip
+      - libgtk2.0-0
+      - libx11-dev
+      - libxkbfile-dev
+
+before_install:
+  - if [ $TRAVIS_OS_NAME == "linux" ]; then
+      export CXX="g++-4.9" CC="gcc-4.9" DISPLAY=:99.0;
+      sh -e /etc/init.d/xvfb start;
+      sleep 3;
+    fi
+
+install:
+  - cd client
+  - npm install
+  - npm install gulp
+  - npm run vscode:prepublish
+
+script:
+  - npm test --silent
+  - gulp build

.travis.yml

@@ -1,20 +1,3 @@
 # Change Log
-All notable changes to the "vscode-puppet" extension will be documented in this file.
 
-Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
-
-## [Unreleased]
-- Initial release
-
-
-## [0.0.1] - 2017-04-10
-## Added
-- Initial release of the puppet extension.
-
-## [0.0.2] - 2017-05-04
-## Added
-- Puppet Resource and Puppet Module commands.
-
-## [0.0.3] - 2017-05-08
-## Added
-- Puppet Parser validate linter added
+All change information is kept in [client/CHANGELOG.md](client/CHANGELOG.md)

CHANGELOG.md

@@ -1,55 +1,58 @@
-# puppet-vscode
+<!--
+TODO: Need correct marketplace ID
+[![Version](https://vsmarketplacebadge.apphb.com/version/jpogran.Puppet.svg)](https://marketplace.visualstudio.com/items?itemName=jpogran.Puppet)
+[![Installs](https://vsmarketplacebadge.apphb.com/installs-short/jpogran.Puppet.svg)](https://marketplace.visualstudio.com/items?itemName=jpogran.Puppet)
+-->
 
-## Features
+# Puppet Language Support for Visual Studio Code
 
-## Syntax Highlighting
+This extension provides Puppet Language support for [Visual Studio Code](https://code.visualstudio.com/)
 
-- Puppet DSL
-- Puppet grammar
+The extension is composed of the VS Code Extension in the [`client/`](client) directory and the Puppet Language Server in the [`server/`](server) directory
 
-\!\[syntax\]\(images/syntax.png\)
 
-## Snippet support
+## How to run the client and server for development
 
-\!\[feature X\]\(images/snippets.png\)
+### Run the language server
 
-## Puppet Linting support
+Follow the instructions in the server documentation - [How to run the Language Server for Develoment](server/READMEmd#How_to_run_the_Language_Server_for_Development). Ensure you use the `--timeout=0` and `--no-stop` arguments so the server does not stop.
 
-On document save, puppet-lint will be run on the open file.
+### Run the client
 
-\!\[feature X\]\(images/puppet-lint.png\)
+* Ensure nodejs is installed
 
-## Requirements
+* Clone this repository
 
-- puppet-lint installed and available on the PATH or path to binary set in extension settings.
+```
+> git clone https://github.com/jpogran/puppet-vscode.git
 
-## Extension Settings
+> cd puppet-vscode
+> cd client
+```
 
-This extension contributes the following settings:
+* Install the node modules and start VS Code
 
-* `puppetLint.enable`: enable/disable this extension
-* `puppetLint.path`: set to the path to puppet-lint
+```
+> npm install
+...
 
-## Known Issues
+> [email protected] postinstall C:\Source\puppet-vscode\client
+> node ./node_modules/vscode/bin/install
 
-None yet.
+Detected VS Code engine version: ^1.10.0
+Found minimal version that qualifies engine range: 1.10.0
+Fetching vscode.d.ts from: https://raw.githubusercontent.com/Microsoft/vscode/1.10.0/src/vs/vscode.d.ts
+vscode.d.ts successfully installed!
 
-## Release Notes
+> code .
+```
 
-**Note** Not released yet. WIP
+* Once VS Code is running, press `F5` to start a build and a new VS Code development instance should start
 
-- syntax
-- grammar
-- linter
+* Open a Puppet file (.pp) and the client will start and connect to the Puppet Server
 
-### 0.0.1
+> Other Puppet VS Code extensions may cause issues with the development instance.  Ensure that you either uninstall or disable the other Puppet extensions prior.
 
-Initial release of the puppet extension.
+## Issues
 
-### 0.0.2
-
-Puppet Resource and Puppet Module commands.
-
-### 0.0.3
-
-Puppet Parser validate linter added
+Please raise issues for the Language Server or Extension using the GitHub issue tracker.

README.md

@@ -0,0 +1,93 @@
+version: 0.0.4-appv.{build}
+branches:
+  only:
+  - add-travis-appveyor
+  - language-server-feature
+clone_depth: 10
+init:
+- SET
+
+environment:
+  matrix:
+  # Language Server testing
+  # LTS Agent
+  - PUPPET_GEM_VERSION: "~> 4.7.0"
+    RUBY_VER: 21-x64
+    RAKE_TASK: test
+  # Latest 4.x branch
+  - PUPPET_GEM_VERSION: "~> 4.0"
+    RUBY_VER: 21-x64
+    RAKE_TASK: test
+  # Latest Puppet
+  - PUPPET_GEM_VERSION: "> 4.0.0"
+    RUBY_VER: 23-x64
+    RAKE_TASK: test
+  # Ruby style
+  - PUPPET_GEM_VERSION: "> 4.0.0"
+    RUBY_VER: 23-x64
+    RAKE_TASK: rubocop
+
+  # Extension testing
+  # Package it up to a VSIX
+  - nodejs_version: "7.4.0"
+    nodejs_arch: "x64"
+    GULP_BUILD_TASK: build
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    # Ruby style
+    - PUPPET_GEM_VERSION: "> 4.0.0"
+      RUBY_VER: 23-x64
+      RAKE_TASK: rubocop
+
+install:
+- ps: |
+     Write-Host "Setting build version..."
+     $ENV:APPVEYOR_BUILD_VERSION | Out-File -FilePath 'server\lib\puppet-languageserver\VERSION' -Encoding ASCII -Confirm:$false -Force
+
+     if ($ENV:RUBY_VER -ne $null) {
+       Set-Location -Path ".\server"
+       $ENV:Path = 'C:\Ruby' + $ENV:RUBY_VER + '\bin;' + $ENV:Path
+
+       Write-Host "Ruby Version..."
+       & ruby -v
+       Write-Host "Gem Version..."
+       & gem -v
+       Write-Host "Bundle Version..."
+       & bundle -v
+       & bundle install
+
+       type Gemfile.lock
+     }
+
+     if ($ENV:nodejs_version -ne $null) {
+       Install-Product node $env:nodejs_version $env:nodejs_arch
+       Set-Location -Path ".\client"
+
+       Write-Host "Node Version..."
+       & node --version
+
+       Write-Host "Updating npm..."
+       & npm install -g npm@4 --silent
+
+       Write-Host "npm Version..."
+       & npm --version
+
+       Write-Host "Installing modules..."
+       & npm install --silent
+
+       Write-Host "Set the package.json version..."
+       & node node_modules\gulp\bin\gulp.js bump --version $ENV:APPVEYOR_BUILD_VERSION
+     }
+
+build_script:
+- cmd: IF NOT [%GULP_BUILD_TASK%] == [] node node_modules\gulp\bin\gulp.js %GULP_BUILD_TASK%
+
+test_script:
+- cmd: IF NOT [%RAKE_TASK%] == [] bundle exec rake %RAKE_TASK%
+- cmd: IF NOT [%NPM_TASK%] == [] npm run %NPM_TASK%
+- cmd: IF NOT [%GULP_TASK%] == [] node node_modules\gulp\bin\gulp.js %GULP_TASK%
+
+artifacts:
+- path: client/*.vsix

appveyor.yml

@@ -0,0 +1,7 @@
+out/
+node_modules/
+vendor/
+tmp/
+
+// Ignore generated module output
+*.vsix

client/.gitignore

@@ -6,25 +6,25 @@
 // ${fileExtname}: the current opened file's extension
 // ${cwd}: the current working directory of the spawned process
 
-// A task runner that calls a custom npm script that compiles the extension.
 {
-    "version": "0.1.0",
-
-    // we want to run npm
-    "command": "npm",
-
-    // the command is a shell script
-    "isShellCommand": true,
-
-    // show the output window only if unrecognized errors occur.
-    "showOutput": "silent",
-
-    // we run the custom script "compile" as defined in package.json
-    "args": ["run", "compile", "--loglevel", "silent"],
-
-    // The tsc compiler is started in watching mode
-    "isWatching": true,
-
-    // use the standard tsc in watch mode problem matcher to find compile problems in the output.
-    "problemMatcher": "$tsc-watch"
-}
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "taskName": "npm",
+      "command": "npm",
+      "isShellCommand":true,
+      "showOutput": "silent",
+      "args": ["run", "compile-watch"],
+      "isBackground": true,
+      "problemMatcher": "$tsc-watch"
+    },
+    {
+      "taskName": "gulp",
+      "command": "gulp",
+      "isBuildCommand": true,
+      "showOutput": "always",
+      "isBackground": true,
+      "suppressTaskName": true
+    }
+  ]
+}

client/.vscode/tasks.json

@@ -6,4 +6,7 @@ src/**
 **/*.map
 .gitignore
 tsconfig.json
-vsc-extension-quickstart.md
+tmp/**
+logs/**
+sessions/**
+gulpfile.js

client/.vscodeignore

@@ -0,0 +1,20 @@
+# Change Log
+All notable changes to the "vscode-puppet" extension will be documented in this file.
+
+Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
+
+## [Unreleased]
+- Initial release
+
+
+## [0.0.1] - 2017-04-10
+## Added
+- Initial release of the puppet extension.
+
+## [0.0.2] - 2017-05-04
+## Added
+- Puppet Resource and Puppet Module commands.
+
+## [0.0.3] - 2017-05-08
+## Added
+- Puppet Parser validate linter added