1
1
mirror of https://github.com/codota/TabNine.git synced 2024-09-11 18:05:28 +03:00
TabNine/TabNineProjectConfigurations.md

60 lines
2.8 KiB
Markdown
Raw Normal View History

# Project Configuration
# `.tabnine` file
Projects are folders containing a VCS root (such as a `.git` directory or directories containing `.tabnine_root`).
Projects containing a file called `.tabnine` in their root can have special configurations applied to them.
## Structure
```
project-root/
├── .git
└── .tabnine <<<<< this configuration file
└── ...
```
## .tabnine format
The `.tabnine` file is formatted using `JSON` containing the following fields:
2021-10-18 10:08:29 +03:00
2021-10-17 15:35:40 +03:00
| field | type | default value (if not set) | description | notes |
|-----------------------|------------|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|
2021-10-18 10:08:29 +03:00
| `disableTeamLearning` | `boolean` | `false` | relevant for users which are part of a team and want to disable team training on this project. `true` - team learning is disabled for this project `false` team learning is enabled for this project | |
2021-10-17 15:36:38 +03:00
| `teamLearningIgnore` | `[string]` | `[]` | an `Array` of `String` file path masks to ignore for team learning | Entries are identical in format to those you would have as part of a `.gitignore` file |
| | | | | |
### Examples
*ignore everything in my secrets and passwords files*
```
{
2021-10-18 10:08:29 +03:00
"disableTeamLearning": false,
"teamLearningIgnore" : ["myFile.txt", "someOtherFile.abc"]
}
```
*ignore everything under tests folder*
2021-10-18 10:08:29 +03:00
(notice that `disableTeamLearning` is implicitly `false` since field is omitted)
```
{
"teamLearningIgnore" : ["src/tests", "build/tests"]
}
```
*don't collect data for this project*
```
{
2021-10-18 10:08:29 +03:00
"disableTeamLearning" : true
}
```
**equivalent to a catch all mask**
```
{
2021-10-18 10:08:29 +03:00
"disableTeamLearning" : false,
"teamLearningIgnore" : ["*"]
}
```