puppet-editor-services 2.0.4

data/Gemfile

@@ -0,0 +1,53 @@
+source ENV['GEM_SOURCE'] || "https://rubygems.org"
+
+# -=-=-=-=-=- WARNING -=-=-=-=-=-
+# There should be NO runtime gem dependencies here.  In production this code will be running using the Ruby
+# runtime provided by Puppet.  That means no native extensions and NO BUNDLER.  All runtime dependences should
+# be re-vendored and then the load path modified appropriately.
+#
+# This gemfile only exists to help when developing the language server and running tests
+# -=-=-=-=-=- WARNING -=-=-=-=-=-
+
+group :development do
+  gem 'rake', '>= 10.4',                  :require => false
+  gem 'rspec', '>= 3.2',                  :require => false
+  gem 'puppet-lint', '~> 4.0',            :require => false
+  gem 'puppetfile-resolver', '~> 0.6.2',  :require => false
+  gem 'yard', '~> 0.9.28',                :require => false
+  gem "rubocop", '~> 1.64.0',             :require => false
+  gem "rubocop-performance", '~> 1.16',   :require => false
+  gem "rubocop-rspec", '~> 3.0',         :require => false
+  gem 'simplecov',                        :require => false
+  gem 'simplecov-console',                :require => false
+
+  if ENV['PUPPET_GEM_VERSION']
+    gem 'puppet', ENV['PUPPET_GEM_VERSION'], :require => false
+  else
+    gem 'puppet',                            :require => false
+  end
+
+  case RUBY_PLATFORM
+  when /darwin/
+    gem 'CFPropertyList'
+  end
+
+  gem "win32-dir", "<= 0.4.9",      :require => false, :platforms => ["mswin", "mingw", "x64_mingw"]
+  gem "win32-eventlog", "<= 0.6.5", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"]
+  gem "win32-process", "<= 0.7.5",  :require => false, :platforms => ["mswin", "mingw", "x64_mingw"]
+  gem "win32-security", "<= 0.2.5", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"]
+  gem "win32-service", "<= 0.8.8",  :require => false, :platforms => ["mswin", "mingw", "x64_mingw"]
+
+  # Gems for building release tarballs etc.
+  gem "archive-zip", :require => false
+  gem "minitar"    , :require => false
+end
+
+# Evaluate Gemfile.local if it exists
+if File.exist? "#{__FILE__}.local"
+  eval(File.read("#{__FILE__}.local"), binding)
+end
+
+# Evaluate ~/.gemfile if it exists
+if File.exist?(File.join(Dir.home, '.gemfile'))
+  eval(File.read(File.join(Dir.home, '.gemfile')), binding)
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2017 Glenn Sarti, James Pogran
+
+   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
+
+       http://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.

data/README.md

@@ -0,0 +1,308 @@
+# Puppet Editor Services
+
+[![Code Owners](https://img.shields.io/badge/owners-DevX--team-blue)](https://github.com/puppetlabs/puppet-editor-services/blob/main/CODEOWNERS)
+![ci](https://github.com/puppetlabs/puppet-editor-services/actions/workflows/ci.yml/badge.svg)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/puppetlabs/puppet-editor-services)
+
+A ruby based implementation of a [Language Server](https://github.com/Microsoft/language-server-protocol) and [Debug Server](https://github.com/microsoft/debug-adapter-protocol) for the Puppet Language. Integrate this into your editor to benefit from full Puppet Language support, such as syntax hightlighting, linting, hover support and more.
+
+## Requirements
+
+* Puppet 7 or above
+
+* Ruby 2.7 or above
+
+## Setting up editor services for development
+
+* Ensure a modern ruby is installed (2.7+)
+
+  The editor services support Puppet 7.0.0 and above
+
+* Clone this repository
+
+```bash
+> git clone https://github.com/puppetlabs/puppet-editor-services.git
+
+> cd puppet-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
+        --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.