From 2dd24b9832b0ec275d4b8c6466b6d57683002870 Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Mon, 11 Mar 2024 11:58:24 +0000 Subject: [PATCH] chore(release): 1.11.0 [skip ci] # [1.11.0](https://github.com/dev-cycles/contextive/compare/v1.10.5...v1.11.0) (2024-03-11) ### Features * **intellij:** Add IntelliJ plugin (closes [#32](https://github.com/dev-cycles/contextive/issues/32)) ([fad50b8](https://github.com/dev-cycles/contextive/commit/fad50b835c2003c02afd023f75ccf510f892c9ff)) * **intellij:** automatically download the language server if it's not found ([38db4b7](https://github.com/dev-cycles/contextive/commit/38db4b759a47b45d2d1b7e5a38b54c4bfdd57370)) ### Performance Improvements * **language-server:** reduce binary size (fixes [#61](https://github.com/dev-cycles/contextive/issues/61)) ([5658484](https://github.com/dev-cycles/contextive/commit/56584848fb9e4281092749212ab143690702f88c)) --- src/intellij/contextive/build.gradle.kts | 2 +- .../src/main/resources/META-INF/plugin.xml | 341 +++++++----------- .../Contextive.LanguageServer.fsproj | 2 +- src/vscode/contextive/CHANGELOG.md | 13 + src/vscode/contextive/package-lock.json | 4 +- src/vscode/contextive/package.json | 2 +- 6 files changed, 158 insertions(+), 206 deletions(-) diff --git a/src/intellij/contextive/build.gradle.kts b/src/intellij/contextive/build.gradle.kts index 1cd39ead..483c26ba 100644 --- a/src/intellij/contextive/build.gradle.kts +++ b/src/intellij/contextive/build.gradle.kts @@ -5,7 +5,7 @@ plugins { } group = "tech.contextive" -version = "1.10.5" +version = "1.11.0" repositories { mavenCentral() diff --git a/src/intellij/contextive/src/main/resources/META-INF/plugin.xml b/src/intellij/contextive/src/main/resources/META-INF/plugin.xml index f8fe74c9..b5148bc4 100644 --- a/src/intellij/contextive/src/main/resources/META-INF/plugin.xml +++ b/src/intellij/contextive/src/main/resources/META-INF/plugin.xml @@ -13,16 +13,14 @@ -

Contextive README

+ Contextive README

Contextive is an IntelliJ Platform Plugin to assist developers in environments with a complex domain or project specific language, where words have a special meaning in the context of the project.

It should help new team members get up to speed more quickly in understanding domain-specific terms. By storing the term definitions in your repository, and surfacing the definitions as you work on the code, it encourages the use of the domain-specific terms in your code, and regularly updating the definitions as the team's understanding evolves.

-

Example of Contextive in action.

-

Getting Started

+

Getting Started

Create a folder in your project root called .contextive. Create a file in that folder called definitions.yml.

Start defining your definitions following the schema specified in our usage guide. You might like to start by copying our default definitions file that defines the terms used in the definitions file itself.

-

Supported IDEs

-

The plugin uses the IntelliJ Language Server Protocol support, so it's only available in the IDEs where that feature is offered. See the JetBrains LSP Documentation for the latest list.

+

Supported IDEs

+

The plugin uses the IntelliJ Language Server Protocol support, so it's only available in the IDEs where that feature is offered. See the JetBrains LSP Documentation for the latest list.

At time of writing, it includes:

  • IntelliJ IDEA Ultimate
    • @@ -38,20 +36,22 @@
  • Rider
  • RustRover
-

Usage Guide

+

Usage Guide

See our usage guide for details on the definitions file format and available options.

-

Features

+

Features

    -
  • -Auto-complete from your Contextive Definitions +
  • Auto-complete from your Contextive Definitions
      -
    • Shows definitions in auto-complete details
      • +
    • Shows definitions in auto-complete details +
        +
      • Note: Press F1 while the auto-complete list is shown to see the definition, and choose Show Automatically During Completion from the documentation panel's '3-dots' menu to have it show every time.)
        • +
      +
  • Hover to show definitions from your Contextive Definitions -

    Coming Soon

    +

    Coming Soon

    • IDE command to initialize the definitions file
    • Configure different location for the definitions file
      • @@ -79,264 +77,205 @@
    • Support for multiple contexts in separate repositories
    • Better support for key word identification in different languages (e.g. different syntax delimiters)
    -

    Plugin Configuration

    +

    Plugin Configuration

    The plugin does not currently support configuration. The definitions file must be in ./contextive/definitions.yml in your current project folder.

    This is pending IntelliJ support for the LSP workspace/configuration feature.

    -

    Known Issues

    +

    Known Issues

      -
    • Not configurable - see Plugin Configuration -
      • +
    • Not configurable - see Plugin Configuration
      • +
    • Autocomplete list doesn't respect the case sensitive interpretation as described in the usage guide. IntelliJ does not yet respect the `isIncomplete' flag that forces re-computation of the list and is required to adjust the case of list items. See IDEA-348829 for details.
      • +
    • Documentation not shown on hover in some files (files treated as 'plaintext' by the specific IDE). Use F1 to show the hover documentation at the current cursor position. This is an IntelliJ bug, see IDEA-348497 for details.
      • +
    • Auto-completion does not work at certain positions. See Issue #63
    - ]]> +]]> -

    Change Log

    -

    -1.10.5 (2023-11-19)

    -

    Bug Fixes

    + Change Log +

    1.11.0 (2024-03-11)

    +

    Features

    +
      +
    • intellij: Add IntelliJ plugin (closes #32) (fad50b8)
      • +
    • intellij: automatically download the language server if it's not found (38db4b7)
      • +
    +

    Performance Improvements

    +
      +
    • language-server: reduce binary size (fixes #61) (5658484)
      • +
    +

    1.10.5 (2023-11-19)

    +

    Bug Fixes

    -

    -1.10.4 (2023-11-19)

    -

    Bug Fixes

    +

    1.10.4 (2023-11-19)

    +

    Bug Fixes

      -
    • -language-server: improve resilience when client doesn't support showMessageRequest (fixes #60) (8a1e684)
      • -
    • -language-server: language server now offers a custom lsp command to initialize the default definitions file (9c7e8a5)
      • +
    • language-server: improve resilience when client doesn't support showMessageRequest (fixes #60) (8a1e684)
      • +
    • language-server: language server now offers a custom lsp command to initialize the default definitions file (9c7e8a5)
    -

    -1.10.3 (2023-11-15)

    -

    Bug Fixes

    +

    1.10.3 (2023-11-15)

    +

    Bug Fixes

      -
    • -language-server: support LSP clients that only support workspace/configuration (#58) (7e06396)
      • -
    • -language-server: survey prompt more resilient to accidentally missing the first prompt (7acd140)
      • +
    • language-server: support LSP clients that only support workspace/configuration (#58) (7e06396)
      • +
    • language-server: survey prompt more resilient to accidentally missing the first prompt (7acd140)
    -

    -1.10.2 (2023-10-14)

    -

    Bug Fixes

    +

    1.10.2 (2023-10-14)

    +

    Bug Fixes

      -
    • -language-server: fix issue with survey prompt (7196e82)
      • +
    • language-server: fix issue with survey prompt (7196e82)
    -

    -1.10.1 (2023-10-14)

    -

    Bug Fixes

    +

    1.10.1 (2023-10-14)

    +

    Bug Fixes

      -
    • -language-server: resolve issue with releasing v1.10.0 for macos and windows (5042b5f)
      • +
    • language-server: resolve issue with releasing v1.10.0 for macos and windows (5042b5f)
    -

    -1.10.0 (2023-10-14)

    -

    Features

    +

    1.10.0 (2023-10-14)

    +

    Features

      -
    • -language-server: includes a one-time invitation for users to complete a Contextive roadmap survey (42272d0)
      • -
    • -language-server: Use the default path defined in contextive if it's not specified in the configuration. (23f9049)
      • +
    • language-server: includes a one-time invitation for users to complete a Contextive roadmap survey (42272d0)
      • +
    • language-server: Use the default path defined in contextive if it's not specified in the configuration. (23f9049)
    -

    -1.9.4 (2023-08-18)

    -

    Bug Fixes

    +

    1.9.4 (2023-08-18)

    +

    Bug Fixes

      -
    • -language-server: improve resilience when terms is an empty list in the definitions file. (fixes: #48) (65517ef)
      • +
    • language-server: improve resilience when terms is an empty list in the definitions file. (fixes: #48) (65517ef)
    -

    -1.9.3 (2023-08-08)

    -

    Bug Fixes

    +

    1.9.3 (2023-08-08)

    +

    Bug Fixes

      -
    • -language-server: ensure rendering the domain vision statement is correct even with trailing whitespace/newline. (fixes #47) (27f86c1)
      • -
    • -language-server: term usage examples render within double-quotes correctly even with leading and trailing whitespace/newlines. (292553f)
      • -
    • -vscode: the default definitions file includes a definition of the 'aliases' key (a983db2)
      • +
    • language-server: ensure rendering the domain vision statement is correct even with trailing whitespace/newline. (fixes #47) (27f86c1)
      • +
    • language-server: term usage examples render within double-quotes correctly even with leading and trailing whitespace/newlines. (292553f)
      • +
    • vscode: the default definitions file includes a definition of the 'aliases' key (a983db2)
    -

    -1.9.2 (2023-07-04)

    -

    Bug Fixes

    +

    1.9.2 (2023-07-04)

    +

    Bug Fixes

      -
    • -language-server: display aliases in the hover panel (6ba291b)
      • +
    • language-server: display aliases in the hover panel (6ba291b)
    -

    -1.9.1 (2023-07-03)

    -

    Bug Fixes

    +

    1.9.1 (2023-07-03)

    +

    Bug Fixes

      -
    • -vscode: ensure the language server process stops when vscode stops the extension. Bug in dependency vscode-languageclient fixed by update. (fixes #44) (a3f7ed8)
      • +
    • vscode: ensure the language server process stops when vscode stops the extension. Bug in dependency vscode-languageclient fixed by update. (fixes #44) (a3f7ed8)
    -

    -1.9.0 (2023-06-21)

    -

    Features

    +

    1.9.0 (2023-06-21)

    +

    Features

      -
    • -language-server: add support for term aliases and show term definition when hovering over an alias (28103de)
      • +
    • language-server: add support for term aliases and show term definition when hovering over an alias (28103de)
    -

    -1.8.1 (2023-06-13)

    -

    Bug Fixes

    +

    1.8.1 (2023-06-13)

    +

    Bug Fixes

      -
    • -language-server: Ensure Contextive works with both CRLF and LF files on Windows (#40) (9a4d248)
      • +
    • language-server: Ensure Contextive works with both CRLF and LF files on Windows (#40) (9a4d248)
    -

    -1.8.0 (2023-06-11)

    -

    Bug Fixes

    +

    1.8.0 (2023-06-11)

    +

    Bug Fixes

      -
    • -language-server: ensure hover works even if the file's path has special characters in it (076a029)
      • -
    • -language-server: resolve error notifications when hovering over a space in column 0 (51936b8)
      • +
    • language-server: ensure hover works even if the file's path has special characters in it (076a029)
      • +
    • language-server: resolve error notifications when hovering over a space in column 0 (51936b8)
    -

    Features

    +

    Features

      -
    • -vscode: Add support for linux-arm64 platform (38d9afb)
      • +
    • vscode: Add support for linux-arm64 platform (38d9afb)
    -

    -1.7.0 (2023-05-28)

    -

    Features

    +

    1.7.0 (2023-05-28)

    +

    Features

      -
    • -vscode: add support for multi-root workspaces with a shared definitions file (#38) (99a4257)
      • +
    • vscode: add support for multi-root workspaces with a shared definitions file (#38) (99a4257)
    -

    -1.6.0 (2023-03-28)

    -

    Features

    +

    1.6.0 (2023-03-28)

    +

    Features

      -
    • -language-server: show hover panel for plural of defined terms (d45095d)
      • +
    • language-server: show hover panel for plural of defined terms (d45095d)
    -

    -1.5.1 (2023-03-24)

    -

    Bug Fixes

    +

    1.5.1 (2023-03-24)

    +

    Bug Fixes

      -
    • -vscode: Ensure Contextive hover results appear below more relevant language feature results. (2e9e40c)
      • +
    • vscode: Ensure Contextive hover results appear below more relevant language feature results. (2e9e40c)
    -

    -1.5.0 (2022-02-13)

    -

    Features

    +

    1.5.0 (2022-02-13)

    +

    Features

      -
    • -language-server: allow contextive.path to contain shell commands to enable more complex location discovery scripts #36 (dc17612)
      • +
    • language-server: allow contextive.path to contain shell commands to enable more complex location discovery scripts #36 (dc17612)
    -

    -1.4.0 (2022-02-05)

    -

    Bug Fixes

    +

    1.4.0 (2022-02-05)

    +

    Bug Fixes

      -
    • -language-server: include more useful auto-complete suggestions for multi-word terms (7a1b4ea)
      • -
    • -language-server: update completion item kind to be (7552c16)
      • +
    • language-server: include more useful auto-complete suggestions for multi-word terms (7a1b4ea)
      • +
    • language-server: update completion item kind to be (7552c16)
    -

    Features

    +

    Features

      -
    • -language-server: show context name (if any) in auto-complete details (8c221d1)
      • -
    • -language-server: show term hover panel content in auto complete documentation window (4748c86)
      • +
    • language-server: show context name (if any) in auto-complete details (8c221d1)
      • +
    • language-server: show term hover panel content in auto complete documentation window (4748c86)
    -

    -1.3.1 (2022-02-01)

    -

    Bug Fixes

    +

    1.3.1 (2022-02-01)

    +

    Bug Fixes

      -
    • -language-server: support snake_case combined words (#35) (abd076a)
      • -
    • -language-server: support true multi-word terms, not just camelCase and PascalCase terms (5fc2f73)
      • +
    • language-server: support snake_case combined words (#35) (abd076a)
      • +
    • language-server: support true multi-word terms, not just camelCase and PascalCase terms (5fc2f73)
    -

    -1.3.0 (2022-01-31)

    -

    Bug Fixes

    +

    1.3.0 (2022-01-31)

    +

    Bug Fixes

      -
    • -language-server: update emojis for definitions and usage examples (f08e477)
      • +
    • language-server: update emojis for definitions and usage examples (f08e477)
    -

    Features

    +

    Features

      -
    • -language-server: contexts can now be defined with a list of path globs. hover and autocomplete terms will only be shown from contexts where at least one path glob matches the currently open file (8bf13ee)
      • -
    • -language-server: display current context name and domain vision statement in hover panel, if defined. (9658385)
      • +
    • language-server: contexts can now be defined with a list of path globs. hover and autocomplete terms will only be shown from contexts where at least one path glob matches the currently open file (8bf13ee)
      • +
    • language-server: display current context name and domain vision statement in hover panel, if defined. (9658385)
    -

    -1.2.1 (2022-01-28)

    -

    Bug Fixes

    +

    1.2.1 (2022-01-28)

    +

    Bug Fixes

      -
    • -language-server: add emojis to the hover panel to illustrate definitions and usage examples (634b1df)
      • +
    • language-server: add emojis to the hover panel to illustrate definitions and usage examples (634b1df)
    -

    -1.2.0 (2022-01-26)

    -

    Bug Fixes

    +

    1.2.0 (2022-01-26)

    +

    Bug Fixes

      -
    • -language-server: language server version updated on release (#26) (2a626a7)
      • +
    • language-server: language server version updated on release (#26) (2a626a7)
    -

    Features

    +

    Features

      -
    • -language-server: hover now supports camelCase, PascalCase or snake_case words where defined terms are combined with other defined terms, or undefined terms (#27) (19d9c6c)
      • +
    • language-server: hover now supports camelCase, PascalCase or snake_case words where defined terms are combined with other defined terms, or undefined terms (#27) (19d9c6c)
    -

    -1.1.3 (2022-01-24)

    -

    Bug Fixes

    +

    1.1.3 (2022-01-24)

    +

    Bug Fixes

      -
    • -vscode: ensure Language Server version is updated on release, so it is reported in vscode extension logs correctly. (4e377f5)
      • -
    • -vscode: resilient to more types of parsing errors (4f8dde6)
      • +
    • vscode: ensure Language Server version is updated on release, so it is reported in vscode extension logs correctly. (4e377f5)
      • +
    • vscode: resilient to more types of parsing errors (4f8dde6)
    -

    -1.1.2 (2022-01-23)

    -

    Bug Fixes

    +

    1.1.2 (2022-01-23)

    +

    Bug Fixes

      -
    • -vscode: add support for Apple Silicon (1e65def)
      • +
    • vscode: add support for Apple Silicon (1e65def)
    -

    -1.1.1 (2022-01-23)

    -

    Bug Fixes

    +

    1.1.1 (2022-01-23)

    +

    Bug Fixes

      -
    • -vscode: ensure Language Server version is updated on release (44e8cb3)
      • -
    • -vscode: Readme image relative link corrected to ensure readme images are displayed (b453ff6)
      • +
    • vscode: ensure Language Server version is updated on release (44e8cb3)
      • +
    • vscode: Readme image relative link corrected to ensure readme images are displayed (b453ff6)
    -

    -1.1.0 (2022-01-23)

    -

    Bug Fixes

    +

    1.1.0 (2022-01-23)

    +

    Bug Fixes

      -
    • -devcontainer: Resolve adr template default setting by ensuring /home/vscode/.config exists in advance, and running scripts with to ensure profile env variables are loaded. (#20) (9c4639e)
      • +
    • devcontainer: Resolve adr template default setting by ensuring /home/vscode/.config exists in advance, and running scripts with to ensure profile env variables are loaded. (#20) (9c4639e)
    • handle invalid definitions file (#21) (caba982)
    -

    Features

    +

    Features

    • Add more word boundary delimiters (arrays, parentheses, parens) (#18) (5c6d6be)
    -

    -v1.0.0 (2022-01-22)

    -

    This is a release label attached to the existing v0.0.1-beta release, in order to serve as a baseline for starting to use semantic-release to manage releases.

    -

    -v0.0.2-beta (2022-01-10)

    -

    Features

    +

    v1.0.0 (2022-01-22)

    +

    This is a release label attached to the existing v0.0.1-beta release, in order to serve as a baseline for starting to use semantic-release to manage releases.

    +

    v0.0.2-beta (2022-01-10)

    +

    Features

    • Build for macOS
    -

    Fixed

    +

    Fixed

    • Error logged when hovering over a term that isn't in the contextive definitions
    -

    -v0.0.1-beta (2022-01-09)

    -

    Features

    +

    v0.0.1-beta (2022-01-09)

    +

    Features

    • VsCode command to initialize a contextive definitions file (Default file contains instructions and examples).
    • Hover info for terms found in the definitions file
      • @@ -344,7 +283,7 @@
    • Watches for updates to the definitions file
    • Watches for updates to the contextive.path configuration parameter which defines which file contains the definitions
    - ]]>     +]]>     diff --git a/src/language-server/Contextive.LanguageServer/Contextive.LanguageServer.fsproj b/src/language-server/Contextive.LanguageServer/Contextive.LanguageServer.fsproj index ed0bca6b..dbfbc23f 100644 --- a/src/language-server/Contextive.LanguageServer/Contextive.LanguageServer.fsproj +++ b/src/language-server/Contextive.LanguageServer/Contextive.LanguageServer.fsproj @@ -6,7 +6,7 @@ 3390;$(WarnOn) - 1.10.5 + 1.11.0 Chris Simon Dev Cycles diff --git a/src/vscode/contextive/CHANGELOG.md b/src/vscode/contextive/CHANGELOG.md index 428dd66b..01788f75 100644 --- a/src/vscode/contextive/CHANGELOG.md +++ b/src/vscode/contextive/CHANGELOG.md @@ -1,5 +1,18 @@ # Change Log +# [1.11.0](https://github.com/dev-cycles/contextive/compare/v1.10.5...v1.11.0) (2024-03-11) + + +### Features + +* **intellij:** Add IntelliJ plugin (closes [#32](https://github.com/dev-cycles/contextive/issues/32)) ([fad50b8](https://github.com/dev-cycles/contextive/commit/fad50b835c2003c02afd023f75ccf510f892c9ff)) +* **intellij:** automatically download the language server if it's not found ([38db4b7](https://github.com/dev-cycles/contextive/commit/38db4b759a47b45d2d1b7e5a38b54c4bfdd57370)) + + +### Performance Improvements + +* **language-server:** reduce binary size (fixes [#61](https://github.com/dev-cycles/contextive/issues/61)) ([5658484](https://github.com/dev-cycles/contextive/commit/56584848fb9e4281092749212ab143690702f88c)) + ## [1.10.5](https://github.com/dev-cycles/contextive/compare/v1.10.4...v1.10.5) (2023-11-19) diff --git a/src/vscode/contextive/package-lock.json b/src/vscode/contextive/package-lock.json index 31db1c85..3f48ae61 100644 --- a/src/vscode/contextive/package-lock.json +++ b/src/vscode/contextive/package-lock.json @@ -1,12 +1,12 @@ { "name": "contextive", - "version": "v1.10.5", + "version": "1.11.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "contextive", - "version": "v1.10.5", + "version": "1.11.0", "license": "SEE LICENSE IN LICENSE", "dependencies": { "vscode-languageclient": "^9.0.1" diff --git a/src/vscode/contextive/package.json b/src/vscode/contextive/package.json index b570fc78..d961566b 100644 --- a/src/vscode/contextive/package.json +++ b/src/vscode/contextive/package.json @@ -2,7 +2,7 @@ "name": "contextive", "displayName": "Contextive", "description": "Supports developers where a complex domain or project specific language is in use by surfacing definitions everywhere specific words are used - code, comments, config or documentation.", - "version": "v1.10.5", + "version": "1.11.0", "publisher": "devcycles", "license": "SEE LICENSE IN LICENSE", "icon": "images/contextive.png",