DEVEL.md

Development notes

This is the VSCode language extension for Ciao Prolog.

Useful links:

• VSCode Extension API: https://code.visualstudio.com/api

Status

Language extension:

• Syntax highlighting: Info: https://code.visualstudio.com/api/language-extensions/syntax-highlight-guide

• Snippet completion: snippets.json Info: https://code.visualstudio.com/api/language-extensions/snippet-guide

• Language configuration: language-configuration.json Info: https://code.visualstudio.com/api/language-extensions/language-configuration-guide

  • Bracket matching:
  • Bracket autoclosing
  • Bracket autosurrounding
  • Comment toggling
  • Folding (by markers)

Mark errors/warnings on source?

• TBD

Toplevels:

• Plain terminal? TBD

Status (advanced)

Verifly?

• Requires LSP? TBD (Adaptor based?)

Source debugger?

• TBD

Installing the Extension

1. Install dependencies:

   npm install

2. Package the extension:

   npm run package

   This command will bundle and package the extension in a .vsix file.

3. Insall the extension in VSCode:

   From VSCode go to Extensions and click on the three dot button in the explorer bar. Then click install from vsix and select the .vsix file located in the root of the project.

Publishing the Extension

VSCode Marketplace

1. Generate a personal access token in Dev Azure to publish an extension to the marketplace:

Generate token.

2. Using vsce, login with ciao-lang publisher id:

   vsce login ciao-lang

   Provide the previously generated token when prompted so.

3. Using vsce, publish the extension:

   vsce publish

OpenVSX Registry

1. Generate a personal access token in OpenVSX registry:

Generate token.

2. Package the extension:

   npm run package

3. Using ovsx, publish the .vsix file generated after packaging the extension:

   npx ovsx publish <file> -p <token>

Bundling and installing the extension

(Only bundled extensions can be used in VS Code for Web environments like github.dev and vscode.dev)

TBD https://code.visualstudio.com/api/working-with-extensions/bundling-extension

Automatic testing the extension

TBD https://code.visualstudio.com/api/working-with-extensions/testing-extension

Publishing the extension

TBD https://code.visualstudio.com/api/working-with-extensions/publishing-extension

Automated publishing from CI

TBD https://code.visualstudio.com/api/working-with-extensions/continuous-integration