Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (50 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

73 lines (50 loc) · 3.37 KB
Raw

Contributing

Open VSX Version VS Marketplace Tests

📥 Install

npm i

🛠️ Development

Press F5 in VS Code (or use Run → Start Debugging) to launch the extension in a new Extension Development Host window.

Run tests

npm test

Format

npm run fmt

Upgrade dependencies

npm run upgrade

🏷️ Release

Bump the version in package.json: patch | minor | major

npm version patch

Note

This will automatically update the changelog, create a git tag, package, and publish.

Important

Get a VS Code Marketplace PAT from Azure DevOps, and an Open VSX token from open-vsx.org/user-settings/tokens.

📝 Notes

To do:

  • Support qlue-ls.toml: If present at root of project, load settings from there instead of VSCode. In setting panel add link to VSCode settings or qlue-ls.toml file depending what is used.
  • Make the fetch request sent for executing the SPARQL query configurable at the endpoint level (in backend config): GET/POST, headers, basic auth. It can all be configured in a new section inside the backend expand
  • Enable to have backend profiles with a set of pre-optimized completion queries for a given triplestore/ontology. For each backend users can load a profile (when expanding a backend conf in settings panel, there is a dropdown for loading profiles), then custom it further. For now just create 2: default profile, and skos profile (uses skos instead of rdfs)
  • When we store the class schema should we store it as a formatted string? So we can also easily support extracting and using SHACL/ShEx shapes without having to parse them. Migrate to SHACL shapes generated with with shapetrospection

Run tests:

  • Install the Extension Test Runner
  • Run the "watch" task via the Tasks: Run Task command. Make sure this is running, or tests might not be discovered.
  • Open the Testing view from the activity bar and click the Run Test" button, or use the hotkey Ctrl/Cmd + ; A
  • See the output of the test result in the Test Results view.
  • Make changes to src/test/extension.test.ts or create new test files inside the test folder.
    • The provided test runner will only consider files matching the name pattern **.test.ts.
    • You can create folders inside the test folder to structure your tests any way you want.

Go further: