{"id":29981671,"url":"https://github.com/roock/nixos-vscode-puppet","last_synced_at":"2026-05-17T11:33:16.075Z","repository":{"id":307719934,"uuid":"1030452638","full_name":"roock/nixos-vscode-puppet","owner":"roock","description":"How to run the puppet VSCode plugin on NixOS","archived":false,"fork":false,"pushed_at":"2026-03-18T14:09:39.000Z","size":144,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-19T04:34:23.467Z","etag":null,"topics":["nixos","puppet","vscode"],"latest_commit_sha":null,"homepage":"","language":"Nix","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/roock.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-01T17:01:49.000Z","updated_at":"2026-03-18T14:09:44.000Z","dependencies_parsed_at":"2025-08-01T20:42:21.067Z","dependency_job_id":"889428ca-8dd6-4296-b6a3-7c1fec07aabd","html_url":"https://github.com/roock/nixos-vscode-puppet","commit_stats":null,"previous_names":["roock/nixos-vscode-puppet"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/roock/nixos-vscode-puppet","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roock%2Fnixos-vscode-puppet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roock%2Fnixos-vscode-puppet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roock%2Fnixos-vscode-puppet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roock%2Fnixos-vscode-puppet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/roock","download_url":"https://codeload.github.com/roock/nixos-vscode-puppet/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roock%2Fnixos-vscode-puppet/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33136750,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-17T09:28:26.183Z","status":"ssl_error","status_checked_at":"2026-05-17T09:27:52.702Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nixos","puppet","vscode"],"created_at":"2025-08-04T17:01:23.229Z","updated_at":"2026-05-17T11:33:16.070Z","avatar_url":"https://github.com/roock.png","language":"Nix","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Using Puppet VSCode plugin on NixOS\n\n## The problem to solve\n\nThe full functionality of the Puppet VSCode plugin requires a proper installation\nof the PDK or the puppet agent. Unforuntaly the way how NixOS installs the PDK or\nthe puppet agent is not compatilbe with the VSCode plugin.\n\n## Using devenv to emulate an puppet agent installation\n\nUsing [devenv](https://devenv.sh) we can create an environment suiteable for the plugin\nto regognize it aa puppet installation.\n\nCaveats:\n\n- You need to specify an absolute path for the puppet agent installation in the vscode settings.\n- We need to pin ruby json library because the language server is not compatible with recent versions.\n\n## vsocde settings\n\n```json\n{\n    \"puppet.installType\": \"agent\",\n    \"puppet.installDirectory\": \"/full/path/to/repo/.devenv/state/.bundle/ruby/3.2.0\",\n    // only required for debugging\n    //\"puppet.editorService.loglevel\": \"debug\",\n    //\"puppet.editorService.debugFilePath\": \"puppet-debug.log\"\n}\n```\n\nWhen opening the [example file](example/init.pp), you should something similar like this.\n(Notice the tooltip when you hover over a property, e.g. ensure).\n\n![Screenshot](img/screenshot.png)\n\nHappy Coding!\n\n## Recommandations\n\nThis repository provides a full setup for running puppet bolt. Some dependencies might not be strictly\nrequired just for using the VSCode plugin. It's recommended to install `direnv` for automatic activiation\nof the devenv.\n\nInstall the [devenv vscode plugin](https://marketplace.visualstudio.com/items?itemName=mkhl.direnv) and the [Nix IDE vscode plugin](https://marketplace.visualstudio.com/items?itemName=jnoortheen.nix-ide).\n\n## Usage\n\n```shell\n# clone this repo\ngit clone git@github.com:roock/nixos-vscode-puppet.git\ncd nixos-vscode-puppet\n# allow direnv in this directory\ndirenv allow .\n# setup vscode settingsd\necho \"{\n    \"puppet.installType\": \"agent\",\n    \"puppet.installDirectory\": \"$PWD/.devenv/state/.bundle/ruby/3.2.0\",\n}\" | tee .vscode/settings.json\ncode .\n```\n\n## Open Issues\n\n- This has been tested with the `vscode-fhs` NixOS package. Testing with the `vscode`, `vscodium` or `vscodium-fhs` is still outstanding.\n- There's an open pull request in puppet-langage service to fix [Ruby 3.4 compatibility for JSON.generate](https://github.com/puppetlabs/puppet-editor-services/pull/401/changes)\n  which seems to be nescassary for ruby-3.3 as well","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froock%2Fnixos-vscode-puppet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froock%2Fnixos-vscode-puppet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froock%2Fnixos-vscode-puppet/lists"}