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.
-
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.
- -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
See our usage guide for details on the definitions file format and available options.
- +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
F1while the auto-complete list is shown to see the definition, and chooseShow Automatically During Completionfrom the documentation panel's '3-dots' menu to have it show every time.)
+
- Note: Press
- Hover to show definitions from your Contextive Definitions
-
-
- Hover over elements with suffixes & prefixes - +
- Hover over elements with suffixes & prefixes
- Hover over usage of multiple terms combined using camelCase, PascalCase and snake_case
- Hover over multi-word terms
- Hover over plural of defined terms @@ -60,17 +60,15 @@
- Supported Repository Layouts:
-
-
- A repository per context - -
- -Multiple contexts in the same repository (monorepo) (identified by path globs) +
- A repository per context +
- Multiple contexts in the same repository (monorepo) (identified by path globs)
- Context distributed over multiple repositories (#36)
- Multi-root workspaces
- Works in all files
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
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
-
-
- 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