Skip to content

Commit

Permalink
chore(release): 1.12.0 [skip ci]
Browse files Browse the repository at this point in the history
# [1.12.0](v1.11.1...v1.12.0) (2024-09-04)

### Bug Fixes

* **intellij:** Add support for 2042.2 series of intellij platform ([08308bf](08308bf))

### Features

* **language-server:** Add support for LSP Clients that only support rootUri and not workspaces (e.g. Visual Studio) ([7fe11b3](7fe11b3))
* **language-server:** Add yaml schema for definitions file ([#74](#74)) ([65ec44a](65ec44a))
* **language-server:** Only use 'window/showMessage' if it is supported by the LanguageClient (e.g. Visual Studio does not support it) ([965cb30](965cb30))
* **language-server:** validate definitions file for missing term names ([0fb0978](0fb0978))
* **visual-studio:** Add Visual Studio integration ([b052a82](b052a82)), closes [#28](#28)
  • Loading branch information
semantic-release-bot committed Sep 4, 2024
1 parent ecc1dee commit cdd0bc8
Show file tree
Hide file tree
Showing 8 changed files with 61 additions and 32 deletions.
2 changes: 1 addition & 1 deletion src/intellij/contextive/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ plugins {
}

group = "tech.contextive"
version = "1.11.1"
version = "1.12.0"

repositories {
mavenCentral()
Expand Down
39 changes: 26 additions & 13 deletions src/intellij/contextive/src/main/resources/META-INF/plugin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ This plugin is considered 'beta' status, as leverages relatively new <a href="ht
<p>See <a href="#known-issues">known issues</a> below</p>
</blockquote>
<h2>Installation</h2>
<p>See <a href="https://github.com/dev-cycles/contextive/blob/main/docs/wiki/INSTALLATION.md#intellij-plugin-platform">IntelliJ IDEs (e.g. IDEA) Installation Instructions</a>.</p>
<p>See <a href="https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/INSTALLATION.md#intellij-plugin-platform">IntelliJ IDEs (e.g. IDEA) Installation Instructions</a>.</p>
<h2>Getting Started</h2>
<p>Create a folder in your project root called <code>.contextive</code>. Create a file in that folder called <code>definitions.yml</code>.</p>
<p>Start defining your definitions following the schema specified in our <a href="https://github.com/dev-cycles/contextive/blob/main/docs/wiki/USAGE.md">usage guide</a>. You might like to start by copying our <a href="https://github.com/dev-cycles/contextive/blob/main/src/language-server/Contextive.LanguageServer.Tests/DefinitionsInitializationTests.Default%20Definitions.verified.txt">default definitions</a> file that defines the terms used in the definitions file itself.</p>
<p>Start defining your definitions following the schema specified in our <a href="https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md">usage guide</a>. You might like to start by copying our <a href="https://github.com/dev-cycles/contextive/blob/v1.12.0/src/language-server/Contextive.LanguageServer.Tests/DefinitionsInitializationTests.Default%20Definitions.verified.txt">default definitions</a> file that defines the terms used in the definitions file itself.</p>
<h2>Supported IDEs</h2>
<p>The plugin uses the IntelliJ Language Server Protocol support, so it's only available in the IDEs where that feature is offered. See the <a href="https://plugins.jetbrains.com/docs/intellij/language-server-protocol.html#supported-ides">JetBrains LSP Documentation</a> for the latest list.</p>
<p>At time of writing, it includes:</p>
Expand All @@ -44,10 +44,10 @@ This plugin is considered 'beta' status, as leverages relatively new <a href="ht
<li>RustRover</li>
</ul>
<h2>Usage Guide</h2>
<p>See our <a href="https://github.com/dev-cycles/contextive/blob/main/docs/wiki/USAGE.md">usage guide</a> for details on the definitions file format and available options.</p>
<p>See our <a href="https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md">usage guide</a> for details on the definitions file format and available options.</p>
<h2>Features</h2>
<ul>
<li><a href="https://github.com/dev-cycles/contextive/blob/main/docs/wiki/USAGE.md#smart-auto-complete">Auto-complete</a> from your Contextive Definitions
<li><a href="https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#smart-auto-complete">Auto-complete</a> from your Contextive Definitions
<ul>
<li>Shows definitions in auto-complete details
<ul>
Expand All @@ -58,19 +58,19 @@ This plugin is considered 'beta' status, as leverages relatively new <a href="ht
</li>
<li>Hover to show definitions from your Contextive Definitions
<ul>
<li>Hover over elements with <a href="https://github.com/dev-cycles/contextive/blob/main/docs/wiki/USAGE.md#suffixes-and-prefixes">suffixes &amp; prefixes</a></li>
<li>Hover over usage of <a href="https://github.com/dev-cycles/contextive/blob/main/docs/wiki/USAGE.md#combining-two-or-more-terms">multiple terms</a> combined using camelCase, PascalCase and snake_case</li>
<li>Hover over <a href="https://github.com/dev-cycles/contextive/blob/main/docs/wiki/USAGE.md#multi-word-terms">multi-word</a> terms</li>
<li>Hover over <a href="https://github.com/dev-cycles/contextive/blob/main/docs/wiki/USAGE.md#plural-words">plural</a> of defined terms</li>
<li>Hover over <a href="https://github.com/dev-cycles/contextive/blob/main/docs/wiki/USAGE.md#term-aliases">aliases</a> of defined terms</li>
<li>Hover over elements with <a href="https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#suffixes-and-prefixes">suffixes &amp; prefixes</a></li>
<li>Hover over usage of <a href="https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#combining-two-or-more-terms">multiple terms</a> combined using camelCase, PascalCase and snake_case</li>
<li>Hover over <a href="https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#multi-word-terms">multi-word</a> terms</li>
<li>Hover over <a href="https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#plural-words">plural</a> of defined terms</li>
<li>Hover over <a href="https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#term-aliases">aliases</a> of defined terms</li>
</ul>
</li>
<li>Supported Repository Layouts:
<ul>
<li>A <a href="https://github.com/dev-cycles/contextive/blob/main/docs/wiki/USAGE.md#multiple-bounded-contexts-repository-per-context">repository per context</a></li>
<li><a href="https://github.com/dev-cycles/contextive/blob/main/docs/wiki/USAGE.md#multiple-bounded-contexts-single-repository-single-root-monorepo">Multiple contexts in the same repository</a> (monorepo) (identified by path globs)</li>
<li>Context distributed over <a href="https://github.com/dev-cycles/contextive/blob/main/docs/wiki/USAGE.md#single-bounded-context-multiple-repositories">multiple repositories</a> (#36)</li>
<li><a href="https://github.com/dev-cycles/contextive/blob/main/docs/wiki/USAGE.md#multiple-bounded-contexts-multi-root-shared-definitions-file">Multi-root workspaces</a></li>
<li>A <a href="https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#multiple-bounded-contexts-repository-per-context">repository per context</a></li>
<li><a href="https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#multiple-bounded-contexts-single-repository-single-root-monorepo">Multiple contexts in the same repository</a> (monorepo) (identified by path globs)</li>
<li>Context distributed over <a href="https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#single-bounded-context-multiple-repositories">multiple repositories</a> (<a href="https://github.com/dev-cycles/contextive/issues/36">#36</a>)</li>
<li><a href="https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#multiple-bounded-contexts-multi-root-shared-definitions-file">Multi-root workspaces</a></li>
</ul>
</li>
<li>Works in all files</li>
Expand Down Expand Up @@ -98,6 +98,19 @@ This plugin is considered 'beta' status, as leverages relatively new <a href="ht
]]></description>

<change-notes><![CDATA[<h1>Change Log</h1>
<h1><a href="https://github.com/dev-cycles/contextive/compare/v1.11.1...v1.12.0">1.12.0</a> (2024-09-04)</h1>
<h3>Bug Fixes</h3>
<ul>
<li><strong>intellij:</strong> Add support for 2042.2 series of intellij platform (<a href="https://github.com/dev-cycles/contextive/commit/08308bff2056fd1af764d88649de7fe90b8516b1">08308bf</a>)</li>
</ul>
<h3>Features</h3>
<ul>
<li><strong>language-server:</strong> Add support for LSP Clients that only support rootUri and not workspaces (e.g. Visual Studio) (<a href="https://github.com/dev-cycles/contextive/commit/7fe11b3831d6f8b8f86d1d10817c7ba50a0163c0">7fe11b3</a>)</li>
<li><strong>language-server:</strong> Add yaml schema for definitions file (<a href="https://github.com/dev-cycles/contextive/issues/74">#74</a>) (<a href="https://github.com/dev-cycles/contextive/commit/65ec44a16de20357b69d1662cfc70521298287da">65ec44a</a>)</li>
<li><strong>language-server:</strong> Only use 'window/showMessage' if it is supported by the LanguageClient (e.g. Visual Studio does not support it) (<a href="https://github.com/dev-cycles/contextive/commit/965cb30539ea05357dfd6cdf4e2bb44406d8a16c">965cb30</a>)</li>
<li><strong>language-server:</strong> validate definitions file for missing term names (<a href="https://github.com/dev-cycles/contextive/commit/0fb0978640f594843d1f8ff25959ea3d0bf729ae">0fb0978</a>)</li>
<li><strong>visual-studio:</strong> Add Visual Studio integration (<a href="https://github.com/dev-cycles/contextive/commit/b052a82df7df39d518760f8dfcae84771505262f">b052a82</a>), closes <a href="https://github.com/dev-cycles/contextive/issues/28">#28</a></li>
</ul>
<h2><a href="https://github.com/dev-cycles/contextive/compare/v1.11.0...v1.11.1">1.11.1</a> (2024-06-15)</h2>
<h3>Bug Fixes</h3>
<ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<WarnOn>3390;$(WarnOn)</WarnOn>
</PropertyGroup>
<PropertyGroup>
<Version>1.11.1</Version>
<Version>1.12.0</Version>
<Authors>Chris Simon</Authors>
<Company>Dev Cycles</Company>
</PropertyGroup>
Expand Down
26 changes: 13 additions & 13 deletions src/visualstudio/contextive/contextive/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Contextive is a Visual Studio Code extension to assist developers in environment

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.](https://raw.githubusercontent.com/dev-cycles/contextive/v1.11.1/docs/wiki/images/simple-auto-complete-demo.gif)
![Example of Contextive in action.](https://raw.githubusercontent.com/dev-cycles/contextive/v1.12.0/docs/wiki/images/simple-auto-complete-demo.gif)

> [!WARNING]
> This plugin is considered 'beta' status, as leverages relatively new [Language Server Protocol](https://learn.microsoft.com/en-us/visualstudio/extensibility/visualstudio.extensibility/language-server-provider/language-server-provider?view=vs-2022) support in the [Preview Extensibility Model](https://learn.microsoft.com/en-us/visualstudio/extensibility/visualstudio.extensibility/?view=vs-2022). Some features may not work or may not work as expected. Please [report issues](https://github.com/dev-cycles/contextive/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=) in this project and we will liaise with Microsoft & the Visual Studio team to resolve.
Expand All @@ -18,33 +18,33 @@ It should help new team members get up to speed more quickly in understanding do
## Installation

See [VsCode Installation Instructions](https://raw.githubusercontent.com/dev-cycles/contextive/v1.11.1/docs/wiki/INSTALLATION.md#visual-studio-code).
See [VsCode Installation Instructions](https://raw.githubusercontent.com/dev-cycles/contextive/v1.12.0/docs/wiki/INSTALLATION.md#visual-studio-code).

## 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](https://github.com/dev-cycles/contextive/blob/v1.11.1/docs/wiki/USAGE.md). You might like to start by copying our [default definitions](https://github.com/dev-cycles/contextive/blob/v1.11.1/src/language-server/Contextive.LanguageServer.Tests/DefinitionsInitializationTests.Default%20Definitions.verified.txt) file that defines the terms used in the definitions file itself.
Start defining your definitions following the schema specified in our [usage guide](https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md). You might like to start by copying our [default definitions](https://github.com/dev-cycles/contextive/blob/v1.12.0/src/language-server/Contextive.LanguageServer.Tests/DefinitionsInitializationTests.Default%20Definitions.verified.txt) file that defines the terms used in the definitions file itself.

## Usage Guide

See our [usage guide](https://github.com/dev-cycles/contextive/blob/v1.11.1/docs/wiki/USAGE.md) for details on the definitions file format and available options.
See our [usage guide](https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md) for details on the definitions file format and available options.

## Features

* Initialize your Contextive Definitions
* [Auto-complete](https://github.com/dev-cycles/contextive/blob/v1.11.1/docs/wiki/USAGE.md#smart-auto-complete) from your Contextive Definitions
* [Auto-complete](https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#smart-auto-complete) from your Contextive Definitions
* Shows definitions in auto-complete details
* Hover to show definitions from your Contextive Definitions
* Hover over elements with [suffixes & prefixes](https://github.com/dev-cycles/contextive/blob/v1.11.1/docs/wiki/USAGE.md#suffixes-and-prefixes)
* Hover over usage of [multiple terms](https://github.com/dev-cycles/contextive/blob/v1.11.1/docs/wiki/USAGE.md#combining-two-or-more-terms) combined using camelCase, PascalCase and snake_case
* Hover over [multi-word](https://github.com/dev-cycles/contextive/blob/v1.11.1/docs/wiki/USAGE.md#multi-word-terms) terms
* Hover over [plural](https://github.com/dev-cycles/contextive/blob/v1.11.1/docs/wiki/USAGE.md#plural-words) of defined terms
* Hover over [aliases](https://github.com/dev-cycles/contextive/blob/v1.11.1/docs/wiki/USAGE.md#term-aliases) of defined terms
* Hover over elements with [suffixes & prefixes](https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#suffixes-and-prefixes)
* Hover over usage of [multiple terms](https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#combining-two-or-more-terms) combined using camelCase, PascalCase and snake_case
* Hover over [multi-word](https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#multi-word-terms) terms
* Hover over [plural](https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#plural-words) of defined terms
* Hover over [aliases](https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#term-aliases) of defined terms
* Supported Repository Layouts:
* A [repository per context](https://github.com/dev-cycles/contextive/blob/v1.11.1/docs/wiki/USAGE.md#multiple-bounded-contexts-repository-per-context)
* [Multiple contexts in the same repository](https://github.com/dev-cycles/contextive/blob/v1.11.1/docs/wiki/USAGE.md#multiple-bounded-contexts-single-repository-single-root-monorepo) (monorepo) (identified by path globs)
* Context distributed over [multiple repositories](https://github.com/dev-cycles/contextive/blob/v1.11.1/docs/wiki/USAGE.md#single-bounded-context-multiple-repositories) ([#36](https://github.com/dev-cycles/contextive/issues/36))
* A [repository per context](https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#multiple-bounded-contexts-repository-per-context)
* [Multiple contexts in the same repository](https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#multiple-bounded-contexts-single-repository-single-root-monorepo) (monorepo) (identified by path globs)
* Context distributed over [multiple repositories](https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/USAGE.md#single-bounded-context-multiple-repositories) ([#36](https://github.com/dev-cycles/contextive/issues/36))

### Coming Soon

Expand Down
2 changes: 1 addition & 1 deletion src/visualstudio/contextive/contextive/contextive.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<TargetFramework>net8.0-windows7.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<Version>1.11.1</Version>
<Version>1.12.0</Version>
</PropertyGroup>
<ItemGroup>
<Compile Remove="ContextiveLanguageServerProvider.cs" />
Expand Down
16 changes: 16 additions & 0 deletions src/vscode/contextive/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# Change Log

# [1.12.0](https://github.com/dev-cycles/contextive/compare/v1.11.1...v1.12.0) (2024-09-04)


### Bug Fixes

* **intellij:** Add support for 2042.2 series of intellij platform ([08308bf](https://github.com/dev-cycles/contextive/commit/08308bff2056fd1af764d88649de7fe90b8516b1))


### Features

* **language-server:** Add support for LSP Clients that only support rootUri and not workspaces (e.g. Visual Studio) ([7fe11b3](https://github.com/dev-cycles/contextive/commit/7fe11b3831d6f8b8f86d1d10817c7ba50a0163c0))
* **language-server:** Add yaml schema for definitions file ([#74](https://github.com/dev-cycles/contextive/issues/74)) ([65ec44a](https://github.com/dev-cycles/contextive/commit/65ec44a16de20357b69d1662cfc70521298287da))
* **language-server:** Only use 'window/showMessage' if it is supported by the LanguageClient (e.g. Visual Studio does not support it) ([965cb30](https://github.com/dev-cycles/contextive/commit/965cb30539ea05357dfd6cdf4e2bb44406d8a16c))
* **language-server:** validate definitions file for missing term names ([0fb0978](https://github.com/dev-cycles/contextive/commit/0fb0978640f594843d1f8ff25959ea3d0bf729ae))
* **visual-studio:** Add Visual Studio integration ([b052a82](https://github.com/dev-cycles/contextive/commit/b052a82df7df39d518760f8dfcae84771505262f)), closes [#28](https://github.com/dev-cycles/contextive/issues/28)

## [1.11.1](https://github.com/dev-cycles/contextive/compare/v1.11.0...v1.11.1) (2024-06-15)


Expand Down
4 changes: 2 additions & 2 deletions src/vscode/contextive/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/vscode/contextive/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": "1.11.1",
"version": "1.12.0",
"publisher": "devcycles",
"license": "SEE LICENSE IN LICENSE",
"icon": "images/contextive.png",
Expand Down

0 comments on commit cdd0bc8

Please sign in to comment.