Package Control Default Channel

https://github.com/sublimehq/package_control_channel
Admin
Package Control Default Channel is the official package registry for Sublime Text that provides a...
Tokens:4,494
Snippets:49
Trust Score:6.8
Update:7 months ago
Show doc for...
Tokens:
Raw
### Adding Platform-Specific Package (JSON)

Source: https://context7.com/sublimehq/package_control_channel/llms.txt

Shows how to specify platform restrictions for a package using the `platforms` field, limiting its installation to specific operating systems. This ensures compatibility.

```json
{
  "schema_version": "3.0.0",
  "packages": [
    {
      "name": "AccuTermClient",
      "details": "https://github.com/ianharper/AccuTermClient",
      "releases": [
        {
          "sublime_text": ">=3000",
          "tags": true,
          "platforms": ["windows"]
        }
      ]
    }
  ]
}
```

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

### Adding Package with Tag-Based Releases (JSON)

Source: https://context7.com/sublimehq/package_control_channel/llms.txt

Demonstrates how to add a package using `tags: true`, which automatically pulls releases from Git tags following semantic versioning. This is the recommended method for new packages.

```json
{
  "schema_version": "3.0.0",
  "packages": [
    {
      "name": "A File Icon",
      "details": "https://github.com/SublimeText/AFileIcon",
      "author": ["ihodev", "DeathAxe"],
      "labels": ["theme", "file", "icons"],
      "releases": [
        {
          "sublime_text": ">=3114",
          "tags": true
        }
      ]
    }
  ]
}
```

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

### Specify Direct URL Dependencies in JSON

Source: https://context7.com/sublimehq/package_control_channel/llms.txt

Demonstrates how to declare dependencies using direct download URLs, including SHA256 checksums and version numbers. This method bypasses Git repositories for package distribution.

```json
{
  "schema_version": "3.0.0",
  "packages": [],
  "dependencies": [
    {
      "name": "ssl-linux",
      "description": "Python _ssl module for Linux",
      "author": "wbond",
      "issues": "https://github.com/codexns/sublime-ssl-linux/issues",
      "load_order": "01",
      "releases": [
        {
          "url": "http://packagecontrol.io/ssl/1.0.2/ssl-linux.sublime-package",
          "sha256": "23f35f64458a0a14c99b1bb1bbc3cb04794c7361c4940e0a638d40f038acd377",
          "platforms": ["linux"],
          "sublime_text": "*",
          "version": "1.0.2"
        }
      ]
    }
  ]
}
```

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

### Adding Package with Branch-Based Releases (Deprecated) (JSON)

Source: https://context7.com/sublimehq/package_control_channel/llms.txt

Illustrates adding a package using branch-based releases, which is deprecated but supported for legacy packages. New packages should use tag-based releases instead.

```json
{
  "schema_version": "3.0.0",
  "packages": [
    {
      "name": "ABC Notation",
      "details": "https://github.com/jimhawkridge/SublimeABC",
      "labels": ["language syntax"],
      "releases": [
        {
          "sublime_text": "*",
          "branch": "master"
        }
      ]
    }
  ]
}
```

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

### Adding a Dependency (Library) (JSON)

Source: https://context7.com/sublimehq/package_control_channel/llms.txt

Details how to declare shared Python libraries as dependencies for packages. It includes `load_order` for initialization sequencing and release information.

```json
{
  "schema_version": "3.0.0",
  "packages": [],
  "dependencies": [
    {
      "name": "python-markdown",
      "description": "Python Markdown module",
      "author": "facelessuser",
      "issues": "https://github.com/facelessuser/sublime-markdown/issues",
      "load_order": "50",
      "releases": [
        {
          "base": "https://github.com/facelessuser/sublime-markdown",
          "platforms": ["*"],
          "sublime_text": ">=3000",
          "tags": true
        }
      ]
    }
  ]
}
```

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

### Repository Structure with Includes (JSON)

Source: https://context7.com/sublimehq/package_control_channel/llms.txt

Outlines the main repository structure, referencing alphabetically organized package files for managing a large collection. It includes references to package files and dependencies.

```json
{
  "schema_version": "3.0.0",
  "packages": [],
  "dependencies": [],
  "includes": [
    "./repository/0-9.json",
    "./repository/a.json",
    "./repository/b.json",
    "./repository/c.json",
    "./repository/z.json",
    "./repository/dependencies.json"
  ]
}
```

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

### Define Multi-Platform Dependencies in JSON

Source: https://context7.com/sublimehq/package_control_channel/llms.txt

Specifies how to declare dependencies in JSON format, allowing for different release configurations based on platform and Sublime Text version. This ensures compatibility across various environments.

```json
{
  "schema_version": "3.0.0",
  "packages": [],
  "dependencies": [
    {
      "name": "multiprocessing",
      "description": "Python _multiprocessing module",
      "author": "wbond",
      "issues": "https://github.com/codexns/sublime-multiprocessing/issues",
      "load_order": "01",
      "releases": [
        {
          "base": "https://github.com/codexns/sublime-multiprocessing",
          "platforms": ["windows"],
          "sublime_text": "<3000",
          "tags": true
        },
        {
          "base": "https://github.com/codexns/sublime-multiprocessing",
          "platforms": ["osx"],
          "sublime_text": ">=3000",
          "tags": true
        },
        {
          "base": "https://github.com/codexns/sublime-multiprocessing",
          "platforms": ["linux"],
          "sublime_text": "*",
          "tags": true
        }
      ]
    }
  ]
}
```

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

### Channel Configuration with Multiple Repositories (JSON)

Source: https://context7.com/sublimehq/package_control_channel/llms.txt

Defines the main channel configuration, specifying local and external repository files that Package Control aggregates. This JSON file dictates which repositories are included in the channel.

```json
{
  "schema_version": "3.0.0",
  "repositories": [
    "./repository.json",
    "https://codexns.io/packages/packages.json",
    "https://raw.githubusercontent.com/SublimeLinter/package_control_channel/master/packages.json",
    "https://raw.githubusercontent.com/sublimelsp/repository/main/repository.json"
  ]
}
```

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

### Detect Repository URL Redirects with Python

Source: https://context7.com/sublimehq/package_control_channel/llms.txt

A Python script to scan the package repository for 301 redirects. It iterates through package JSON files, checks for redirects using HEAD requests, and updates the links if found. Includes a small delay between requests.

```python
#!/usr/bin/env python3
import json
import requests
from pathlib import Path
from time import sleep

base_dir = Path(__file__).parent.parent

for path in sorted(Path(base_dir, "repository").glob("*.json")):
    if path.name == "dependencies.json":
        continue

    with path.open('r', encoding="utf-8") as f:
        packages_text = f.read()
        packages = json.loads(packages_text)["packages"]

    for package in packages:
        link = package["details"]
        r = requests.head(link, allow_redirects=False)
        if r.status_code == 301:
            new_link = requests.head(link, allow_redirects=True).url
            print(f"Found 301: \"{link}\" -> \"{new_link}\"")
            packages_text = packages_text.replace(link, new_link)
        sleep(0.1)

    with path.open('w', encoding="utf-8") as f:
        f.write(packages_text)
```

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

### Package Submission Pull Request Checklist in Markdown

Source: https://context7.com/sublimehq/package_control_channel/llms.txt

A markdown checklist to ensure package submissions meet the required guidelines. It covers author verification, documentation, release tagging, repository standards, and command/UI conventions.

```markdown
- [ ] I'm the package's author and/or maintainer.
- [ ] I have have read the docs.
- [ ] I have tagged a release with a semver version number.
- [ ] My package repo has a description and a README describing what it's for and how to use it.
- [ ] My package doesn't add context menu entries.
- [ ] My package doesn't add key bindings.
- [ ] Any commands are available via the command palette.
- [ ] Preferences and keybindings (if any) are listed in the menu and the command palette, and open in split view.
- [ ] If my package is a syntax it doesn't also add a color scheme.
- [ ] I use .gitattributes to exclude files from the package: images, test files, sublime-project/workspace.

My package is ...

There are no packages like it in Package Control.
```

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

### GitHub Actions for Schema Validation in YAML

Source: https://context7.com/sublimehq/package_control_channel/llms.txt

A GitHub Actions workflow defined in YAML that automatically validates schema compliance for pull requests and pushes to the master branch. It utilizes the 'st-schema-reviewer-action' for validation.

```yaml
name: Schema test

on:
  pull_request:
  push:
    branches:
      - master

jobs:
  schema:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: packagecontrol/st-schema-reviewer-action@f0ed8819bd9058dfa9921e4a061a6a1b643339a2
        with:
          test_repositories: true
```
Tokens:
Raw