Skip to content

Commit

Permalink
(maint) - README Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jordanbreen28 committed Sep 28, 2023
1 parent 119d9d0 commit 4150c93
Showing 1 changed file with 4 additions and 11 deletions.
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,19 @@
![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](TODO) for the Puppet Language.

## Requirements

* Puppet 5 or above

* Ruby 2.4 or above
* Puppet 7 or above

**Note** that Puppet 4 (Ruby 2.1) is not supported
* Ruby 2.7 or above

## Setting up editor services for development

* Ensure a modern ruby is installed (2.4+)
* Ensure a modern ruby is installed (2.7+)

The editor services support Puppet 5.0.0 and above
The editor services support Puppet 7.0.0 and above

* Clone this repository

Expand Down Expand Up @@ -299,7 +296,3 @@ Usage: puppet-debugserver.rb [options]
## 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.

## Known Issues

* [PUP-7668](https://tickets.puppetlabs.com/browse/PUP-7668) Due to incorrect offsets, hover documentation can be displayed when the user is not actually hovering over the resource that the documentation is for.

0 comments on commit 4150c93

Please sign in to comment.