SublimeCodeIntel

https://github.com/sublimecodeintel/sublimecodeintel
Admin
SublimeCodeIntel is a Sublime Text plugin that provides code intelligence features including symbol...
Tokens:5,944
Snippets:72
Trust Score:5.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install or Upgrade CodeIntel Package

Source: https://github.com/sublimecodeintel/sublimecodeintel/blob/master/README.md

This command installs or upgrades the CodeIntel package using pip. It is required for version 3.0.0 and later of SublimeCodeIntel, which utilizes CodeIntel as an OOP command and package. Ensure you are using the correct version for your Sublime Text setup.

```bash
pip install --upgrade --pre CodeIntel
```

--------------------------------

### Install CodeIntel Backend Engine

Source: https://context7.com/sublimecodeintel/sublimecodeintel/llms.txt

Install the required CodeIntel Python backend engine using pip. This is a prerequisite for the plugin to function correctly.

```bash
# For Python 2
pip install --upgrade --pre CodeIntel

# For Python 3
pip3 install --upgrade --pre CodeIntel
```

--------------------------------

### Install CodeIntel Engine via Terminal

Source: https://github.com/sublimecodeintel/sublimecodeintel/blob/master/README.md

Commands to install the required CodeIntel Python package using pip. This is a prerequisite for the SublimeCodeIntel plugin to function.

```bash
# For Python 2
[sudo] pip install --upgrade --pre CodeIntel

# For Python 3
[sudo] pip3 install --upgrade --pre CodeIntel
```

--------------------------------

### Clone SublimeCodeIntel Repository via Git

Source: https://github.com/sublimecodeintel/sublimecodeintel/blob/master/README.md

Command to clone the SublimeCodeIntel source code directly into the Sublime Text Packages directory for manual installation.

```bash
git clone git://github.com/SublimeCodeIntel/SublimeCodeIntel.git
```

--------------------------------

### Configure Syntax Mapping

Source: https://context7.com/sublimecodeintel/sublimecodeintel/llms.txt

Map custom syntax definitions to supported CodeIntel languages to ensure proper code intelligence support for various file types.

```json
{
    "user": {
        "syntax_map": {
            "C": "C++",
            "C++11": "C++",
            "Objective-C": "C++",
            "Objective-C++": "C++",
            "Python Django": "Python",
            "PythonImproved": "Python",
            "HTML (Django)": "Django",
            "JavaScript": "ECMAScript",
            "JavaScript (Babel)": "ECMAScript",
            "Node.js": "ECMAScript",
            "JSX": "ECMAScript"
        }
    }
}
```

--------------------------------

### View CodeIntel Log File Command

Source: https://context7.com/sublimecodeintel/sublimecodeintel/llms.txt

This command provides instructions on how to locate and view the SublimeCodeIntel log file, which is essential for debugging issues. It includes paths for different operating systems and a command to tail the log in real-time.

```bash
# Log file location
# Mac/Linux: ~/.codeintel/codeintel.log
# Windows: %userprofile%\.codeintel\codeintel.log

# View recent log entries
tail -f ~/.codeintel/codeintel.log
```

--------------------------------

### Configure API Catalogs in SublimeCodeIntel

Source: https://context7.com/sublimecodeintel/sublimecodeintel/llms.txt

This JSON configuration enables and selects specific API catalogs to enhance autocompletion and calltips for third-party libraries within SublimeCodeIntel. Users can choose from a predefined list of catalogs for various languages.

```json
{
    "user": {
        "selected_catalogs": [
            "jQuery",
            "Rails",
            "PyWin32",
            "Drupal"
        ]
    }
}
```

--------------------------------

### Check Sublime Console for Errors

Source: https://context7.com/sublimecodeintel/sublimecodeintel/llms.txt

This provides instructions on how to access the Sublime Text console, where plugin messages and errors from SublimeCodeIntel are displayed. This is a crucial step for diagnosing problems with the plugin.

```text
# Open console with keyboard shortcut
Ctrl+` (backtick)

# Or via menu
View > Show Console
```

--------------------------------

### Configure SublimeCodeIntel Settings

Source: https://context7.com/sublimecodeintel/sublimecodeintel/llms.txt

Define user-specific settings for SublimeCodeIntel, such as debug mode, scan paths, and OOP communication mode. These settings are managed via the User settings file.

```json
{
    "user": {
        "debug": false,
        "live": true,
        "disabled_languages": [],
        "command": "codeintel",
        "oop_mode": "pipe",
        "log_levels": ["WARNING"],
        "complete_commit": true,
        "complete_commit_fillup": false,
        "scan_files_in_project": true,
        "max_recursive_dir_depth": 10,
        "scan_extra_paths": [],
        "scan_exclude_paths": ["/build/", "/min/"]
    }
}
```

--------------------------------

### Configure Language-Specific Settings in SublimeCodeIntel

Source: https://context7.com/sublimecodeintel/sublimecodeintel/llms.txt

This JSON configuration allows users to define interpreter paths, extra library paths, and other language-specific settings for various programming languages within SublimeCodeIntel. It helps in tailoring the code intelligence engine to individual project needs and environments.

```json
{
    "user": {
        "language_settings": {
            "Python": {
                "python": "/usr/bin/python",
                "pythonExtraPaths": [
                    "/usr/local/lib/python3.9/site-packages",
                    "~/myproject/lib"
                ]
            },
            "Python3": {
                "python3": "/usr/bin/python3",
                "python3ExtraPaths": [
                    "/usr/local/lib/python3.9/site-packages"
                ]
            },
            "JavaScript": {
                "javascriptExtraPaths": [
                    "~/myproject/node_modules"
                ]
            },
            "Node.js": {
                "nodejsDefaultInterpreter": "/usr/bin/node",
                "nodejsExtraPaths": [
                    "/usr/local/lib/node_modules"
                ]
            },
            "PHP": {
                "php": "/usr/bin/php",
                "phpConfigFile": "/etc/php.ini",
                "phpExtraPaths": [
                    "/var/www/html/vendor"
                ]
            },
            "Ruby": {
                "ruby": "/usr/bin/ruby",
                "rubyExtraPaths": [
                    "/usr/local/lib/ruby/gems"
                ]
            },
            "Go": {
                "golangDefaultLocation": "/usr/local/go",
                "gocodeDefaultLocation": "/home/user/go/bin/gocode",
                "godefDefaultLocation": "/home/user/go/bin/godef"
            },
            "C++": {
                "cppFlags": ["-I/usr/local/include", "-L/usr/local/lib"]
            }
        }
    }
}
```

--------------------------------

### Check Ignored Packages Configuration

Source: https://context7.com/sublimecodeintel/sublimecodeintel/llms.txt

This JSON snippet shows how to configure the `ignored_packages` setting in Sublime Text preferences. It is used to ensure that SublimeCodeIntel is not listed in this array, which would prevent it from loading.

```json
// In Preferences > Settings
// Remove "SublimeCodeIntel" from ignored_packages if present:
{
    "ignored_packages": [
        // Remove "SublimeCodeIntel" from this list
    ]
}
```

--------------------------------

### Regenerate Code Intelligence Database Command

Source: https://context7.com/sublimecodeintel/sublimecodeintel/llms.txt

This bash command is used to manually trigger the regeneration of the code intelligence database for SublimeCodeIntel. It involves removing the existing database directory and restarting Sublime Text, forcing a re-indexation.

```bash
# Close Sublime Text first

# Remove the codeintel database directory
# Mac/Linux:
rm -rf ~/.codeintel

# Windows:
rmdir /s /q %userprofile%\.codeintel

# Restart Sublime Text - database will be rebuilt automatically
```

--------------------------------

### Per-Language Disable Configuration in SublimeCodeIntel

Source: https://context7.com/sublimecodeintel/sublimecodeintel/llms.txt

This JSON configuration provides a granular way to disable code intelligence for specific languages or features within SublimeCodeIntel using the '@disable' flag or other language-specific settings. It allows for fine-tuning the behavior on a per-language basis.

```json
{
    "user": {
        "language_settings": {
            "CSS": {
                "@disable": true
            },
            "HTML": {
                "live": false
            }
        }
    }
}
```

--------------------------------

### Enable/Disable Debug Mode Commands

Source: https://context7.com/sublimecodeintel/sublimecodeintel/llms.txt

These commands, executed via the Sublime Text Command Palette, allow users to toggle the debug mode for SublimeCodeIntel. Enabling debug mode provides detailed logging in the console, which is useful for troubleshooting.

```shell
# Open Command Palette (Cmd+Shift+P / Ctrl+Shift+P)

# To enable debug:
SublimeCodeIntel: Enable Debug Mode

# To disable debug:
SublimeCodeIntel: Disable Debug Mode
```

--------------------------------

### Enable/Disable Code Intelligence Commands

Source: https://context7.com/sublimecodeintel/sublimecodeintel/llms.txt

These are commands to be executed in the Sublime Text Command Palette to toggle code intelligence features on or off globally for SublimeCodeIntel. They provide a quick way to manage the plugin's core functionality.

```shell
# Open Command Palette (Cmd+Shift+P / Ctrl+Shift+P)

# To disable:
SublimeCodeIntel: Disable Code Intelligence

# To enable:
SublimeCodeIntel: Enable Code Intelligence
```

--------------------------------

### Disable Live Autocomplete in SublimeCodeIntel

Source: https://github.com/sublimecodeintel/sublimecodeintel/blob/master/README.md

This configuration option disables the live autocomplete feature, which provides suggestions as you type. Setting 'live' to false can help improve performance or prevent unwanted interruptions. This setting is part of the user configuration and overrides default behavior.

```json
"live": false
```

--------------------------------

### Configure Disabled Languages in SublimeCodeIntel

Source: https://github.com/sublimecodeintel/sublimecodeintel/blob/master/README.md

This setting allows you to specify a list of programming languages for which code intelligence should be disabled. This is useful if you encounter performance issues or conflicts with specific languages. The setting completely replaces the default, so ensure all desired languages are included if overriding.

```json
"disabled_languages": ["css"]
```

--------------------------------

### Disable Languages in SublimeCodeIntel

Source: https://context7.com/sublimecodeintel/sublimecodeintel/llms.txt

This JSON configuration allows users to disable code intelligence for specific programming languages that are not actively used in their projects. This can help in reducing resource consumption and improving performance.

```json
{
    "user": {
        "disabled_languages": [
            "CSS",
            "SCSS",
            "Less"
        ]
    }
}
```
Tokens:
Raw