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.
- -See https://github.com/dev-cycles/contextive for details.
+ +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.
+
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.
+At time of writing, it includes:
+-
+
- IntelliJ IDEA Ultimate +
- WebStorm +
- PhpStorm +
- PyCharm Professional +
- DataSpell +
- RubyMine +
- CLion +
- Aqua +
- DataGrip +
- GoLand +
- Rider +
- RustRover +
See our usage guide for details on the definitions file format and available options.
+ +-
+
-
+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 + +
- Hover over usage of multiple terms combined using camelCase, PascalCase and snake_case +
- Hover over multi-word terms +
- Hover over plural of defined terms +
- Hover over aliases of defined terms +
+ - Supported Repository Layouts:
+
-
+
- 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 +
-
+
- IDE command to initialize the definitions file +
- Configure different location for the definitions file +
- UI to edit/manage Contextive Definitions +
- Internationalization support +
- Support for multiple contexts in separate repositories +
- Better support for key word identification in different languages (e.g. different syntax delimiters) +
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.
-
+
- Not configurable - see Plugin Configuration + +