openvox-editor-services 3.0.0

data/README.md

@@ -0,0 +1,305 @@
+# OpenVox Editor Services
+
+A Ruby implementation of a [Language Server](https://github.com/Microsoft/language-server-protocol) and [Debug Server](https://github.com/microsoft/debug-adapter-protocol) for OpenVox. The internal `Puppet` Ruby namespace and `puppet/*` protocol methods are retained for compatibility.
+
+## Requirements
+
+* OpenVox 8 or above
+
+* Ruby 3.1 or above
+
+## Setting up editor services for development
+
+* Ensure a modern ruby is installed (3.1+)
+
+  The editor services support OpenVox 8.0.0 and above.
+
+* Clone this repository
+
+```bash
+> git clone https://github.com/voxpupuli/openvox-editor-services.git
+
+> cd openvox-editor-services
+```
+
+* Bundle the development gems
+
+```bash
+> bundle install
+
+  ... < lots of text >
+```
+
+* Installed vendored gems
+
+```bash
+> bundle exec rake gem_revendor
+
+  ... < lots of text >
+```
+
+# Language Server
+
+## How to run the Language Server for Development
+
+By default the language server will stop if no connection is made within 10 seconds and will also stop after a client disconnects.  Adding `--debug=stdout` will log messages to the console
+
+```bash
+> bundle exec ruby ./puppet-languageserver --debug=stdout
+I, [2018-12-05T15:19:51.853802 #28756]  INFO -- : Language Server is v0.16.0
+I, [2018-12-05T15:19:51.854809 #28756]  INFO -- : Using Puppet v5.5.8
+D, [2018-12-05T15:19:51.856726 #28756] DEBUG -- : Detected additional puppet settings []
+I, [2018-12-05T15:19:51.867798 #28756]  INFO -- : Initializing Puppet Helper...
+D, [2018-12-05T15:19:51.867798 #28756] DEBUG -- : Initializing Document Store...
+I, [2018-12-05T15:19:51.868726 #28756]  INFO -- : Initializing settings...
+I, [2018-12-05T15:19:51.870728 #28756]  INFO -- : Starting RPC Server...
+D, [2018-12-05T15:19:51.870728 #28756] DEBUG -- : Using Simple TCP
+I, [2018-12-05T15:19:51.871729 #28756]  INFO -- : Using Facter v2.5.1
+I, [2018-12-05T15:19:51.871729 #28756]  INFO -- : Preloading Puppet Types (Async)...
+I, [2018-12-05T15:19:51.872728 #28756]  INFO -- : Preloading Facter (Async)...
+I, [2018-12-05T15:19:51.873727 #28756]  INFO -- : Preloading Functions (Async)...
+I, [2018-12-05T15:19:51.876727 #28756]  INFO -- : Preloading Classes (Async)...
+D, [2018-12-05T15:19:51.876727 #28756] DEBUG -- : SidecarQueue Thread: Running sidecar ["ruby", "C:/Source/puppet-editor-services/puppet-languageserver-sidecar", "--action", "default_types", "--feature-flags="]
+D, [2018-12-05T15:19:51.899795 #28756] DEBUG -- : SidecarQueue Thread: Running sidecar ["ruby", "C:/Source/puppet-editor-services/puppet-languageserver-sidecar", "--action", "default_functions", "--feature-flags="]
+D, [2018-12-05T15:19:51.919794 #28756] DEBUG -- : TCPSRV: Services running. Press ^C to stop
+D, [2018-12-05T15:19:51.920795 #28756] DEBUG -- : TCPSRV: Will stop the server in 10 seconds if no connection is made.
+D, [2018-12-05T15:19:51.921809 #28756] DEBUG -- : TCPSRV: Will stop the server when client disconnects
+LANGUAGE SERVER RUNNING localhost:55087
+D, [2018-12-05T15:19:51.923800 #28756] DEBUG -- : TCPSRV: Started listening on localhost:55087.
+A, [2018-12-05T15:19:54.520501 #28756]   ANY -- : SidecarQueue Thread: Calling sidecar with --action default_functions --feature-flags= returned exitcode 0,
+D, [2018-12-05T15:19:54.532525 #28756] DEBUG -- : SidecarQueue Thread: default_functions returned 270 items
+D, [2018-12-05T15:19:54.533522 #28756] DEBUG -- : SidecarQueue Thread: Running sidecar ["ruby", "C:/Source/puppet-editor-services/puppet-languageserver-sidecar", "--action", "default_classes", "--feature-flags="]
+A, [2018-12-05T15:19:54.576503 #28756]   ANY -- : SidecarQueue Thread: Calling sidecar with --action default_types --feature-flags= returned exitcode 0,
+D, [2018-12-05T15:19:54.638503 #28756] DEBUG -- : SidecarQueue Thread: default_types returned 81 items
+A, [2018-12-05T15:19:56.732112 #28756]   ANY -- : SidecarQueue Thread: Calling sidecar with --action default_classes --feature-flags= returned exitcode 0,
+D, [2018-12-05T15:19:56.732112 #28756] DEBUG -- : SidecarQueue Thread: default_classes returned 0 items
+...
+D, [2018-12-05T15:20:03.319045 #28756] DEBUG -- : TCPSRV: No connection has been received in 10 seconds.  Shutting down server.
+D, [2018-12-05T15:20:03.320049 #28756] DEBUG -- : TCPSRV: Stopping services
+D, [2018-12-05T15:20:03.377052 #28756] DEBUG -- : TCPSRV: Stopped listening on localhost:55087
+D, [2018-12-05T15:20:03.377052 #28756] DEBUG -- : TCPSRV: Started shutdown process. Press ^C to force quit.
+D, [2018-12-05T15:20:03.378052 #28756] DEBUG -- : TCPSRV: Stopping services
+D, [2018-12-05T15:20:03.379050 #28756] DEBUG -- : TCPSRV: Waiting for workers to cycle down
+I, [2018-12-05T15:20:03.632011 #28756]  INFO -- : Language Server exited.
+```
+
+To make the server run continuously add `--timeout=0` and `--no-stop` to the command line. For example;
+
+```bash
+> bundle exec ruby ./puppet-languageserver --debug=stdout --timeout=0 --no-stop
+I, [2018-12-05T15:20:56.302414 #29752]  INFO -- : Language Server is v0.16.0
+I, [2018-12-05T15:20:56.303391 #29752]  INFO -- : Using Puppet v5.5.8
+D, [2018-12-05T15:20:56.306343 #29752] DEBUG -- : Detected additional puppet settings []
+I, [2018-12-05T15:20:56.318333 #29752]  INFO -- : Initializing Puppet Helper...
+D, [2018-12-05T15:20:56.318333 #29752] DEBUG -- : Initializing Document Store...
+I, [2018-12-05T15:20:56.319346 #29752]  INFO -- : Initializing settings...
+I, [2018-12-05T15:20:56.321337 #29752]  INFO -- : Starting RPC Server...
+D, [2018-12-05T15:20:56.321337 #29752] DEBUG -- : Using Simple TCP
+I, [2018-12-05T15:20:56.322332 #29752]  INFO -- : Using Facter v2.5.1
+I, [2018-12-05T15:20:56.323335 #29752]  INFO -- : Preloading Puppet Types (Async)...
+I, [2018-12-05T15:20:56.325337 #29752]  INFO -- : Preloading Facter (Async)...
+I, [2018-12-05T15:20:56.326335 #29752]  INFO -- : Preloading Functions (Async)...
+I, [2018-12-05T15:20:56.327333 #29752]  INFO -- : Preloading Classes (Async)...
+...
+D, [2018-12-05T15:20:56.365334 #29752] DEBUG -- : TCPSRV: Services running. Press ^C to stop
+LANGUAGE SERVER RUNNING localhost:55180
+D, [2018-12-05T15:20:56.374333 #29752] DEBUG -- : TCPSRV: Started listening on localhost:55180.
+...
+```
+
+## How to run the Language Server in Production
+
+* Ensure that Puppet Agent is installed
+  * [Linux](https://puppet.com/docs/puppet/latest/install_agents.html#install_nix_agents)
+  * [Windows](https://puppet.com/docs/puppet/latest/install_agents.html#install_windows_agents)
+  * [macOS](https://puppet.com/docs/puppet/latest/install_agents.html#install_mac_agents)
+
+* Run the `puppet-languageserver` with ruby
+
+> On Windows you need to run ruby with the `Puppet Command Prompt` which can be found in the Start Menu.  This enables the Puppet Agent ruby environment.
+
+```bash
+> ruby puppet-languageserver
+LANGUAGE SERVER RUNNING 127.0.0.1:55086
+```
+
+> Note the language server will stop after 10 seconds if no client connection is made.
+
+Note that the Language Server will use TCP as the default transport on `localhost` at a random port.  The IP Address and Port can be changed using the `--ip` and `--port` arguments respectively.  For example to listen on all interfaces on port 9000;
+
+```bash
+> ruby ./puppet-languageserver --ip=0.0.0.0 --port=9000
+```
+
+To change the protocol to STDIO, that is using STDOUT and STDIN, use the `--stdio` argument.
+
+## Command line arguments
+
+```bash
+Usage: puppet-languageserver.rb [options]
+    -p, --port=PORT                  TCP Port to listen on.  Default is random port
+    -i, --ip=ADDRESS                 IP Address to listen on (0.0.0.0 for all interfaces).  Default is localhost
+    -c, --no-stop                    Do not stop the language server once a client disconnects.  Default is to stop
+    -t, --timeout=TIMEOUT            Stop the language server if a client does not connection within TIMEOUT seconds.  A value of zero will not timeout.  Default is 10 seconds
+    -d, --no-preload                 ** DEPRECATED ** Do not preload Puppet information when the language server starts.  Default is to preload
+        --debug=DEBUG                Output debug information.  Either specify a filename or 'STDOUT'.  Default is no debug output
+    -s, --slow-start                 Delay starting the Language Server until Puppet initialisation has completed.  Default is to start fast
+        --stdio                      Runs the server in stdio mode, without a TCP listener
+        --enable-file-cache          ** DEPRECATED ** Enables the file system cache for Puppet Objects (types, class etc.)
+        --[no-]cache                 Enable or disable all caching inside the sidecar. By default caching is enabled.
+        --feature-flags=FLAGS        A list of comma delimited feature flags
+        --openvox-version=TEXT       The OpenVox Gem version to use
+        --puppet-settings=TEXT       Comma delimited list of settings to pass into Puppet e.g. --vardir,/opt/test-fixture
+        --local-workspace=PATH       The workspace or file path that will be used to provide module-specific functionality. Default is no workspace path.
+    -h, --help                       Prints this help
+    -v, --version                    Prints the Langauge Server version
+```
+
+# Language Server Sidecar
+
+## How to run the Language Server for Development
+
+The Language Server Sidecar is a process used by the Language Server to get information about Puppet's environment, for example, all available functions, classes, and custom types. This tool is typically only run by the Language Server itself, but it can be used to diagnose issues.
+
+The sidecar is told to perform an action (using the `action`) parameter and then, by default, outputs the JSON encoded result to STDOUT.  This can be changed to a text file using the `--output=PATH` argument.
+
+Note that using the `--debug=STDOUT` option without directing the output to a text file will generate output on STDOUT which cannot be deserialized correctly. Typically this only used by a developer to inspect what the Sidecar is doing.
+
+### Example usage
+
+#### Confirm that the Sidecar loads correctly
+
+The `noop` action just outputs an empty JSON array but can be used to confirm that the Sidecar does not error while loading Puppet.
+
+```bash
+> bundle exec ruby ./puppet-languageserver-sidecar --action=noop
+[]
+```
+
+#### Output all default Puppet Types
+
+```bash
+> bundle exec ruby ./puppet-languageserver-sidecar --action=default_types
+[{"key":"anchor","calling_source":"puppet/cache/lib/puppet/type/anchor.rb","sou ...
+```
+
+#### Output all default Puppet Functions with a different puppet configuration, and debug information
+
+```bash
+> bundle exec ruby ./puppet-languageserver-sidecar --action=default_types --puppet-settings=--vardir,./test/vardir,--confdir,./test/confdir --debug=STDOUT
+I, [2018-12-05T15:42:56.679837 #51864]  INFO -- : Language Server Sidecar is v0.16.0
+I, [2018-12-05T15:42:56.679837 #51864]  INFO -- : Using Puppet v5.5.8
+D, [2018-12-05T15:42:56.680820 #51864] DEBUG -- : Detected additional puppet settings ["--vardir", "./test/vardir", "--confdir", "./test/confdir"]
+D, [2018-12-05T15:42:56.690876 #51864] DEBUG -- : [PuppetHelper::load_functions] Starting
+D, [2018-12-05T15:42:56.752804 #51864] DEBUG -- : [PuppetLanguageServerSidecar::load] Loading lib/puppet/parser/functions/assert_type.rb from cache
+...
+[{"key":"debug","calling_source":"lib/puppet/parser/functions.rb", ...
+```
+
+#### Output all Puppet Classes in a workspace directory
+
+```bash
+> bundle exec ruby ./puppet-languageserver-sidecar --action=workspace_classes --local-workspace=C:\source\puppetlabs-sqlserver
+[{"key":"sqlserver::config","calling_source":"C:/Source/puppetlabs-sqlserver/manifests/config.pp","source":"C:/Source/puppetlabs-sqlserver/manifests/config.pp","line":25,"ch...
+```
+
+## Command line arguments
+
+```bash
+Usage: puppet-languageserver-sidecar.rb [options]
+    -a, --action=NAME                The action for the sidecar to take. Expected ["noop", "default_classes", "default_functions", "default_types", "node_graph", "resource_list", "workspace_classes", "workspace_functions", "workspace_types"]
+    -c, --action-parameters=JSON     JSON Encoded string containing the parameters for the sidecar action
+    -w, --local-workspace=PATH       The workspace or file path that will be used to provide module-specific functionality. Default is no workspace path
+    -o, --output=PATH                The file to save the output from the sidecar. Default is output to STDOUT
+    -p, --puppet-settings=TEXT       Comma delimited list of settings to pass into Puppet e.g. --vardir,/opt/test-fixture
+    -f, --feature-flags=FLAGS        A list of comma delimited feature flags to pass the the sidecar
+    -n, --[no-]cache                 Enable or disable all caching inside the sidecar. By default caching is enabled.
+        --debug=DEBUG                Output debug information.  Either specify a filename or 'STDOUT'. Default is no debug output
+    -h, --help                       Prints this help
+    -v, --version                    Prints the Langauge Server version
+```
+
+# Debug Server
+
+## How to run the Debug Server for Development
+
+By default the debug server will stop if no connection is made within 10 seconds and will also stop after a client disconnects.  Adding `--debug=stdout` will log messages to the console
+
+```bash
+> bundle exec ruby ./puppet-debugserver --debug=stdout
+I, [2018-04-17T14:19:24.131869 #6940]  INFO -- : Debug Server is v0.10.0
+I, [2018-04-17T14:19:24.132871 #6940]  INFO -- : Starting RPC Server...
+D, [2018-04-17T14:19:24.135373 #6940] DEBUG -- : TCPSRV: Services running. Press ^C to stop
+D, [2018-04-17T14:19:24.135870 #6940] DEBUG -- : TCPSRV: Will stop the server in 10 seconds if no connection is made.
+D, [2018-04-17T14:19:24.135870 #6940] DEBUG -- : TCPSRV: Will stop the server when client disconnects
+DEBUG SERVER RUNNING 127.0.0.1:8082
+D, [2018-04-17T14:19:24.136871 #6940] DEBUG -- : TCPSRV: Started listening on 127.0.0.1:8082.
+D, [2018-04-17T14:19:34.140900 #6940] DEBUG -- : TCPSRV: No connection has been received in 10 seconds.  Shutting down server.
+D, [2018-04-17T14:19:34.140900 #6940] DEBUG -- : TCPSRV: Stopping services
+D, [2018-04-17T14:19:34.141400 #6940] DEBUG -- : TCPSRV: Stopped listening on 127.0.0.1:8082
+D, [2018-04-17T14:19:34.141900 #6940] DEBUG -- : TCPSRV: Started shutdown process. Press ^C to force quit.
+D, [2018-04-17T14:19:34.141900 #6940] DEBUG -- : TCPSRV: Stopping services
+D, [2018-04-17T14:19:34.142401 #6940] DEBUG -- : TCPSRV: Waiting for workers to cycle down
+I, [2018-04-17T14:19:34.150402 #6940]  INFO -- : Debug Server exited.
+```
+
+To make the server run continuously add `--timeout=0` to the command line. For example;
+
+```bash
+> bundle exec ruby ./puppet-debugserver --debug=stdout --timeout=0
+I, [2018-04-17T14:21:10.542332 #12424]  INFO -- : Debug Server is v0.10.0
+I, [2018-04-17T14:21:10.543334 #12424]  INFO -- : Starting RPC Server...
+D, [2018-04-17T14:21:10.545836 #12424] DEBUG -- : TCPSRV: Services running. Press ^C to stop
+D, [2018-04-17T14:21:10.546336 #12424] DEBUG -- : TCPSRV: Will stop the server when client disconnects
+DEBUG SERVER RUNNING 127.0.0.1:8082
+D, [2018-04-17T14:21:10.546834 #12424] DEBUG -- : TCPSRV: Started listening on 127.0.0.1:8082.
+...
+```
+
+## How to run the Debug Server for Production
+
+* Ensure that Puppet Agent is installed
+  * [Linux](https://puppet.com/docs/puppet/latest/install_agents.html#install_nix_agents)
+  * [Windows](https://puppet.com/docs/puppet/latest/install_agents.html#install_windows_agents)
+  * [macOS](https://puppet.com/docs/puppet/latest/install_agents.html#install_mac_agents)
+
+* Run the `puppet-debugserver` with ruby
+
+> On Windows you need to run ruby with the `Puppet Command Prompt` which can be found in the Start Menu.  This enables the Puppet Agent ruby environment.
+
+```bash
+> ruby puppet-debugserver
+DEBUG SERVER RUNNING 127.0.0.1:8082
+```
+
+Note the debug server will stop after 10 seconds if no client connection is made.
+
+## Command line arguments
+
+```bash
+Usage: puppet-debugserver.rb [options]
+    -p, --port=PORT                  TCP Port to listen on.  Default is random port}
+    -i, --ip=ADDRESS                 IP Address to listen on (0.0.0.0 for all interfaces).  Default is localhost
+    -t, --timeout=TIMEOUT            Stop the Debug Server if a client does not connection within TIMEOUT seconds.  A value of zero will not timeout.  Default is 10 seconds
+        --debug=DEBUG                Output debug information.  Either specify a filename or 'STDOUT'.  Default is no debug output
+    -h, --help                       Prints this help
+    -v, --version                    Prints the Debug Server version
+```
+
+## License
+
+This codebase is licensed under Apache 2.0. However, the open source dependencies included in this codebase might be subject to other software licenses such as AGPL, GPL2.0, and MIT.
+
+# Other information
+
+## Reporting bugs
+
+If you find a bug in puppet-editor-services or its results, please create an issue in the [repo issues tracker](https://github.com/puppetlabs/puppet-editor-services/issues). Bonus points will be awarded if you also include a patch that fixes the issue.
+
+## Development
+
+If you run into an issue with this tool or would like to request a feature you can raise a PR with your suggested changes. Alternatively, you can raise a Github issue with a feature request or to report any bugs. Every other Tuesday the DevX team holds office hours in the Puppet Community Slack, where you can ask questions about this and any other supported tools. This session runs at 15:00 (GMT) for about an hour.
+
+## Why are there vendored gems and why only native ruby
+
+When used by editors this language server will be running using the Ruby runtime provided by Puppet Agent.  That means no native extensions and no bundler.  Also, only the gems provided by Puppet Agent would be available by default.  To work around this limitation all runtime dependencies should be re-vendored and then the load path modified appropriately.

data/Rakefile

@@ -0,0 +1,260 @@
+require 'rspec/core/rake_task'
+
+rubocop_available = Gem::Specification::find_all_by_name('rubocop').any?
+require 'rubocop/rake_task' if rubocop_available
+
+namespace :test do
+  desc 'Run tests with code coverage'
+  task :coverage do
+    ENV['COVERAGE'] = 'yes'
+    Rake::Task['test_languageserver'].execute
+    Rake::Task['test_languageserver_sidecar'].execute
+    Rake::Task['test_debugserver'].execute
+  end
+end
+
+desc 'Run rspec tests for the Language Server with coloring.'
+RSpec::Core::RakeTask.new(:test_languageserver) do |t|
+  t.rspec_opts = %w[--color --format documentation --default-path spec/languageserver]
+  t.pattern    = ['spec/languageserver/unit/**/*_spec.rb', 'spec/languageserver/integration/**/*_spec.rb']
+end
+
+desc 'Run acceptance tests for the Language Server with coloring.'
+RSpec::Core::RakeTask.new(:acceptance_languageserver) do |t|
+  t.rspec_opts = %w[--color --format documentation --default-path spec/languageserver]
+  t.pattern    = ['spec/languageserver/acceptance/**/*_spec.rb']
+end
+
+desc 'Run rspec tests for the Language Server Sidecar with coloring.'
+RSpec::Core::RakeTask.new(:test_languageserver_sidecar) do |t|
+  t.rspec_opts = %w[--color --format documentation --default-path spec/languageserver-sidecar]
+  t.pattern    = 'spec/languageserver-sidecar'
+end
+
+desc 'Run rspec tests for the Debug Server with coloring.'
+RSpec::Core::RakeTask.new(:test_debugserver) do |t|
+  t.rspec_opts = %w[--color --format documentation --default-path spec/debugserver]
+  t.pattern    = 'spec/debugserver'
+end
+
+if rubocop_available
+  desc 'Run RuboCop'
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.options << '--display-cop-names'
+    task.options << '--config'
+    task.options << '.rubocop.yml'
+  end
+end
+
+namespace :rubocop do
+  desc "Generate the Rubocop Todo file"
+  task :generate do
+    begin
+      sh "rubocop --auto-gen-config"
+    rescue => exception
+      # Ignore any errors
+    end
+  end
+end
+
+desc "Download and vendor required gems"
+task :gem_revendor do
+  require 'fileutils'
+  require 'rubygems/package'
+  require 'tmpdir'
+
+  gem_list = [
+    {
+      :directory => 'hiera-eyaml',
+      :github_repo => 'https://github.com/voxpupuli/hiera-eyaml',
+      :github_ref => 'v2.1.0',
+    },
+    {
+      :directory => 'puppetfile-resolver',
+      :github_repo => 'https://github.com/puppetlabs/puppetfile-resolver.git',
+      :github_ref => 'v0.6.3',
+    },
+    {
+      :directory => 'molinillo',
+      :github_repo => 'https://github.com/CocoaPods/Molinillo.git',
+      :github_ref => '0.6.6',
+    },
+    {
+      :directory => 'openvox-strings',
+      :github_repo => 'https://github.com/voxpupuli/openvox-strings.git',
+      :github_ref => 'v7.1.0',
+    },
+    {
+      :directory => 'rgen',
+      :github_repo => 'https://github.com/mthiede/rgen.git',
+      :github_ref => 'v0.10.2',
+    },
+    {
+      :directory => 'yard',
+      :github_repo => 'https://github.com/lsegal/yard.git',
+      :github_ref => 'v0.9.24',
+    },
+  ]
+
+  # voxpupuli-puppet-lint-plugins 7.0.0 is a metadata-only gem. Its complete runtime
+  # dependency set must be vendored explicitly because the packaged language
+  # server runs without Bundler or access to installed gems.
+  puppet_lint_gems = {
+    'puppet-lint' => '5.1.1',
+    'puppet-lint-absolute_classname-check' => '5.0.0',
+    'puppet-lint-anchor-check' => '3.0.0',
+    'puppet-lint-exec_idempotency-check' => '2.0.0',
+    'puppet-lint-file_ensure-check' => '3.0.0',
+    'puppet-lint-leading_zero-check' => '3.0.0',
+    'puppet-lint-lookup_in_parameter-check' => '3.0.0',
+    'puppet-lint-manifest_whitespace-check' => '2.0.0',
+    'puppet-lint-optional_default-check' => '3.0.0',
+    'puppet-lint-package_ensure-check' => '0.2.0',
+    'puppet-lint-param-docs' => '3.0.0',
+    'puppet-lint-param-types' => '3.0.0',
+    'puppet-lint-params_empty_string-check' => '3.0.0',
+    'puppet-lint-params_not_optional_with_undef-check' => '1.0.0',
+    'puppet-lint-resource_reference_syntax' => '3.0.0',
+    'puppet-lint-strict_indent-check' => '5.0.0',
+    'puppet-lint-topscope-variable-check' => '3.0.0',
+    'puppet-lint-trailing_comma-check' => '3.0.1',
+    'puppet-lint-unquoted_string-check' => '4.1.0',
+    'puppet-lint-variable_contains_upcase' => '3.0.0',
+    'puppet-lint-version_comparison-check' => '3.0.0',
+  }
+
+  # Clean out the vendor directory first
+  puts "Clearing the vendor directory..."
+  vendor_dir = File.join(File.dirname(__FILE__),'vendor')
+  FileUtils.rm_rf(File.join(vendor_dir, 'puppet-strings'))
+  gem_list.each do |vendor|
+    gem_dir = File.join(vendor_dir,vendor[:directory])
+    FileUtils.rm_rf(gem_dir) if Dir.exist?(gem_dir)
+  end
+  puppet_lint_gems.each_key do |gem_name|
+    gem_dir = File.join(vendor_dir, gem_name)
+    FileUtils.rm_rf(gem_dir) if Dir.exist?(gem_dir)
+  end
+  Dir.mkdir(vendor_dir) unless Dir.exist?(vendor_dir)
+
+  gem_list.each do |vendor|
+    puts "Vendoring #{vendor[:directory]}..."
+    gem_dir = File.join(vendor_dir,vendor[:directory])
+
+    sh "git clone #{vendor[:github_repo]} #{gem_dir}"
+    Dir.chdir(gem_dir) do
+      sh 'git fetch origin'
+      sh "git reset --hard #{vendor[:github_ref]}"
+    end
+
+    # Cleanup the gem directory...
+    FileUtils.rm_rf(File.join(gem_dir,'.git'))
+    FileUtils.rm_rf(File.join(gem_dir,'spec'))
+    FileUtils.rm_rf(File.join(gem_dir,'features'))
+    FileUtils.rm_rf(File.join(gem_dir,'docs'))
+  end
+
+  Dir.mktmpdir('openvox-editor-services-gems') do |download_dir|
+    puppet_lint_gems.each do |gem_name, gem_version|
+      puts "Vendoring #{gem_name} #{gem_version}..."
+      gem_filename = "#{gem_name}-#{gem_version}.gem"
+
+      Dir.chdir(download_dir) do
+        sh Gem.ruby, '-S', 'gem', 'fetch', gem_name,
+           '--version', gem_version,
+           '--clear-sources',
+           '--source', 'https://rubygems.org'
+      end
+
+      gem_dir = File.join(vendor_dir, gem_name)
+      Gem::Package.new(File.join(download_dir, gem_filename)).extract_files(gem_dir)
+      FileUtils.rm_rf(File.join(gem_dir, 'spec'))
+      FileUtils.rm_rf(File.join(gem_dir, 'features'))
+      FileUtils.rm_rf(File.join(gem_dir, 'docs'))
+    end
+  end
+
+  # Generate the README
+  readme = <<-HEREDOC
+# Vendored Gems
+
+The OpenVox Puppet DSL server is designed to run within the OpenVox Agent Ruby environment, which means no access to native extensions or Gem bundling.
+
+This means any Gems required outside of the OpenVox runtime for the language server must be vendored in this directory and the load path modified in the `openvox-languageserver` file.
+
+Note - To comply with Licensing, the Gem source should be MIT licensed or even more unrestricted.
+
+Note - To improve the packaging size, test files etc. were stripped from the Gems prior to committing.
+
+Gem List
+--------
+
+* voxpupuli-puppet-lint-plugins (metadata dependency version 7.0.0)
+HEREDOC
+  gem_list.each { |vendor| readme += "* #{vendor[:directory]} (#{vendor[:github_repo]} ref #{vendor[:github_ref]})\n"}
+  puppet_lint_gems.each { |gem_name, gem_version| readme += "* #{gem_name} (RubyGems version #{gem_version})\n" }
+  File.open(File.join(vendor_dir,'README.md'), 'wb') { |file| file.write(readme) }
+end
+
+desc "Create compressed files of the language and debug servers for release"
+task build: [:gem_revendor] do
+  require 'fileutils'
+  require 'archive/zip'
+  require 'zlib'
+  require 'minitar'
+  require 'digest'
+
+  project_dir = File.dirname(__FILE__)
+  output_dir = File.join(project_dir, './pkg/')
+
+  file_list = ['lib', 'vendor', 'openvox-languageserver', 'openvox-debugserver', 'openvox-languageserver-sidecar', 'LICENSE']
+  # Remove files in the list that do not exist.
+  file_list.reject! { |filepath| !File.exist?(filepath) }
+
+  puts "Cleaning output directory..."
+  FileUtils.rm_rf Dir.glob("#{output_dir}/*") if Dir.exist?(output_dir)
+  Dir.mkdir(output_dir) unless Dir.exist?(output_dir)
+
+  puts "Fetch editor services version..."
+  require_relative 'lib/puppet_editor_services/version'
+  version = PuppetEditorServices.version
+  puts "Editor services is v#{version}"
+
+  puts "Creating zip file..."
+  zip_archive_file = File.join(output_dir,"openvox_editor_services_v#{version}.zip")
+  Archive::Zip.archive(zip_archive_file, file_list)
+  puts "Created #{zip_archive_file}"
+
+  puts "Creating tar file..."
+  tar_archive_file = File.join(output_dir,"openvox_editor_services_v#{version}.tar.gz")
+  Minitar.pack(file_list, Zlib::GzipWriter.new(File.open(tar_archive_file, 'wb')))
+  puts "Created #{tar_archive_file}"
+
+  puts "Creating checksums..."
+  [zip_archive_file, tar_archive_file].each do |filepath|
+    sha = Digest::SHA256.hexdigest(File.open(filepath, 'rb') { |file| file.read })
+    File.open(filepath + '.sha256', 'wb') { |file| file.write(sha) }
+  end
+  puts "Created checksums"
+
+  puts 'Building gem..'
+  require 'bundler/gem_tasks'
+  Rake::Task['build'].invoke
+  puts 'Gem built'
+end
+
+task :default => [:test]
+
+begin
+  require 'rubygems'
+  require 'github_changelog_generator/task'
+rescue LoadError
+else
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog dependencies]
+    config.user = 'voxpupuli'
+    config.project = 'openvox-editor-services'
+    gem_version = Gem::Specification.load("#{config.project}.gemspec").version
+    config.future_release = "#{gem_version}"
+  end
+end

data/bin/openvox-debugserver

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'puppet_debugserver'
+
+options = PuppetDebugServer::CommandLineParser.parse(ARGV)
+PuppetDebugServer.init_puppet(options)
+PuppetDebugServer.execute(PuppetDebugServer.rpc_server_async(options))

data/bin/openvox-languageserver

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'puppet_languageserver'
+
+options = PuppetLanguageServer::CommandLineParser.parse(ARGV)
+PuppetLanguageServer.init_puppet(options)
+PuppetLanguageServer.rpc_server(options)

data/bin/openvox-languageserver-sidecar

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'puppet_languageserver_sidecar'
+
+options = PuppetLanguageServerSidecar::CommandLineParser.parse(ARGV)
+PuppetLanguageServerSidecar.init_puppet_sidecar(options)
+PuppetLanguageServerSidecar.execute_and_output(options)

data/bin/puppet-debugserver

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'puppet_debugserver'
+
+PuppetDebugServer.init_puppet(PuppetDebugServer::CommandLineParser.parse(ARGV))
+rpc_thread = PuppetDebugServer.rpc_server_async(PuppetDebugServer::CommandLineParser.parse(ARGV))
+PuppetDebugServer.execute(rpc_thread)

data/bin/puppet-languageserver

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'puppet_languageserver'
+
+PuppetLanguageServer.init_puppet(PuppetLanguageServer::CommandLineParser.parse(ARGV))
+PuppetLanguageServer.rpc_server(PuppetLanguageServer::CommandLineParser.parse(ARGV))

data/bin/puppet-languageserver-sidecar

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'puppet_languageserver_sidecar'
+
+PuppetLanguageServerSidecar.init_puppet_sidecar(PuppetLanguageServerSidecar::CommandLineParser.parse(ARGV))
+PuppetLanguageServerSidecar.execute_and_output(PuppetLanguageServerSidecar::CommandLineParser.parse(ARGV))

data/lib/dsp/dsp.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+%w[dsp_base dsp_protocol].each do |lib|
+  require "dsp/#{lib}"
+rescue LoadError
+  require File.expand_path(File.join(__dir__, lib))
+end