Notices: This section not yet converted to new layout. Download stats are rolling back out.

70,120

Downloads

67,374

Downloads of v 2.0.0.20140915

9/15/2014

Last update

Sublime Text 3 Package Control

2.0.0.20140915

Package test results have failed.

This package was approved by moderator ferventcoder on 3/30/2016.

  • Easily find, install, upgrade and remove packages without restarting Sublime Text
  • Keeps installed packages up-to-date with an auto-upgrade feature
  • Downloads packages from GitHub, BitBucket and the custom JSON channel/repository system
  • Handles updating packages cloned from GitHub and BitBucket via Git and Hg
  • Provides commands for enabling and disabling packages
  • Includes a command to bundle any package directory into a .sublime-package file.

To install Sublime Text 3 Package Control, run the following command from the command line or from PowerShell:

C:\> choco install sublimetext3.packagecontrol

To upgrade Sublime Text 3 Package Control, run the following command from the command line or from PowerShell:

C:\> choco upgrade sublimetext3.packagecontrol

Files

Hide
  • tools\chocolateyInstall.ps1 Show
    function Get-CurrentDirectory
    {
      $thisName = $MyInvocation.MyCommand.Name
      [IO.Path]::GetDirectoryName((Get-Content function:$thisName).File)
    }
    
    try {
      $package = 'SublimeText3.PackageControl'
    
      $current = Get-CurrentDirectory
      . (Join-Path $current 'JsonHelpers.ps1')
      . (Join-Path $current 'SublimeHelpers.ps1')
    
      Install-SublimePackageControl -Version 3
    
      Write-ChocolateySuccess $package
    } catch {
      Write-ChocolateyFailure $package "$($_.Exception.Message)"
      throw
    }
    
  • tools\JsonHelpers.ps1 Show
    function ConvertFrom-UnicodeEscaped
    {
      [CmdletBinding()]
      param(
        [Parameter(ValueFromPipeline=$true, Mandatory = $true)]
        [String]
        $Text
      )
    
      $regex = [regex]'\\[uU]([0-9A-Fa-f]{4})'
      $callback = {
        $match = $args[0]
        $hexStyle = [Globalization.NumberStyles]::HexNumber
        ([Char][Int32]::Parse($match.Value.Substring(2), $hexStyle)).ToString()
      }
    
      $regex.Replace($Text, $callback)
    }
    
    # HACK: this *must* be called after a file has been merged together to sanitize it
    function ConvertTo-DoubleEscapedQuotes
    {
      [CmdletBinding()]
      param(
        [Parameter(ValueFromPipeline=$true, Mandatory = $true)]
        [String]
        $Text,
    
        [Parameter(Mandatory = $false)]
        [String]
        $Name = ''
      )
    
      # HACK: stupid powershell has a bug and doesn't allow " in JSON values
      # So we're forced to double it up... which might not always work.. sigh
      # If we try to get sneaky it doesn't matter -> i.e. -replace '\"', '\u0022'
      # https://connect.microsoft.com/PowerShell/feedback/details/735978/convertto-json-in-psv3-beta-does-not-support-values-containing-double-quotes
      if ($Text -match '"')
      {
        $old = $Text
        $Text = $Text -replace '"', '""'
        Write-Warning "Circumventing Powershell bug - replacing $Name string $old with $Text"
      }
    
      return $Text
    }
    
    function Merge-JsonNamedValue
    {
      [CmdletBinding()]
      param(
        [Parameter(Mandatory = $true)]
        [String]
        $Name,
    
        [Parameter(Mandatory = $true)]
        [PSCustomObject]
        $Destination,
    
        [Parameter(Mandatory = $true)]
        $Value
      )
    
      if (!($Destination | Get-Member -Name $Name))
      {
        $Destination |
          Add-Member -Name $Name -Value $Value -MemberType NoteProperty
      }
      else
      {
        $Destination.$Name = $Value
      }
    }
    
    function Merge-JsonArray
    {
      [CmdletBinding()]
      param(
        [Parameter(Mandatory = $true)]
        [String]
        $Name,
    
        [Parameter(Mandatory = $true)]
        [PSCustomObject]
        $Destination,
    
        [Parameter(Mandatory = $true)]
        [Object[]]
        $Array
      )
    
      if (!$Destination.$Name)
      {
        $Destination |
          Add-Member -Name $Name -Value $Array -MemberType NoteProperty
      }
      else
      {
        $Destination.$Name = ($Destination.$Name + $Array | Sort-Object -Unique)
      }
    }
    
    function Merge-JsonSimpleMap
    {
      [CmdletBinding()]
      param(
        [Parameter(Mandatory = $true)]
        [String]
        $Name,
    
        [Parameter(Mandatory = $true)]
        [PSCustomObject]
        $Destination,
    
        [Parameter(Mandatory = $true)]
        [PSCustomObject]
        $SimpleMap
      )
    
      if (!$Destination.$Name)
      {
        $Destination |
          Add-Member -Name $Name -Value ([PSCustomObject]@{}) -MemberType NoteProperty
      }
    
      $currentHash = $Destination.$Name
      $SimpleMap.PSObject.Properties |
        % {
          $key = $_.Name
          if (!$currentHash.$key)
          {
            $currentHash |
              Add-Member -Name $key -Value $_.Value -MemberType NoteProperty
          }
          else
          {
            $currentHash.$key = $_.Value
          }
        }
    }
    
    function Create-CustomObjectKey
    {
     [CmdletBinding()]
      param(
        [Parameter(Mandatory = $true)]
        [PSCustomObject]
        $Object
      )
    
      $key = ''
      $Object.PSObject.Properties |
        % {
          $key += "{$($_.Name):$($_.Value)}"
        }
    
      return $key
    }
    
    function Merge-JsonArrayOfSimpleMap
    {
      [CmdletBinding()]
      param(
        [Parameter(Mandatory = $true)]
        [String]
        $Name,
    
        [Parameter(Mandatory = $true)]
        [PSCustomObject]
        $Destination,
    
        [Parameter(Mandatory = $true)]
        [Object[]]
        $Array
      )
    
      if (!$Destination.$Name)
      {
        $Destination |
          Add-Member -Name $Name -Value $Array -MemberType NoteProperty
      }
      else
      {
        $merged = $Destination.$Name + $Array
        $seen = @()
        $Destination.$Name = $merged |
          ? { $seen -inotcontains (Create-CustomObjectKey $_) } |
          % {
            $seen += (Create-CustomObjectKey $_)
            $_
          }
      }
    }
    
  • tools\SublimeHelpers.ps1 Show
    # uses functions in JsonHelpers.ps1
    function Get-SublimeInstallPath
    {
      [CmdletBinding()]
      param(
        [Parameter(Mandatory = $false)]
        [ValidateRange(2,3)]
        [int]
        $Version = 2
      )
    
      Join-Path $Env:ProgramFiles "Sublime Text $Version"
    }
    
    function Get-SublimeSettingsPath
    {
      [CmdletBinding()]
      param(
        [Parameter(Mandatory = $false)]
        [ValidateRange(2,3)]
        [int]
        $Version = 2
      )
    
      Join-Path ([Environment]::GetFolderPath('ApplicationData')) "Sublime Text $Version"
    }
    
    function Get-SublimePackagesPath
    {
      [CmdletBinding()]
      param(
        [Parameter(Mandatory = $false)]
        [ValidateRange(2,3)]
        [int]
        $Version = 2
      )
    
      $packagesPath = Join-Path (Get-SublimeSettingsPath -Version $Version) 'Packages'
      if (!(Test-Path $packagesPath))
      {
        New-Item $packagesPath -Type Directory | Out-Null
      }
    
      return $packagesPath
    }
    
    function Get-SublimeUserPath
    {
      [CmdletBinding()]
      param(
        [Parameter(Mandatory = $false)]
        [ValidateRange(2,3)]
        [int]
        $Version = 2
      )
    
      $path = Join-Path (Get-SublimePackagesPath -Version $Version) 'User'
      if (!(Test-Path $path))
      {
        New-Item $path -Type Directory  | Out-Null
      }
      return $path
    }
    
    function Install-SublimePackagesFromCache
    {
      [CmdletBinding()]
      param(
        [Parameter(Mandatory = $true)]
        [string]
        $Directory,
    
        [Parameter(Mandatory = $false)]
        [ValidateRange(2,3)]
        [int]
        $Version = 2
      )
    
      $packagesPath = Get-SublimePackagesPath -Version $Version
      Get-ChildItem $Directory |
        ? { $_.PsIsContainer } |
        % { @{Path = $_.FullName; Destination = Join-Path $packagesPath $_.Name }} |
        ? {
          $exists = Test-Path $_.Destination
          if ($exists) { Write-Host "[ ] Skipping existing $($_.Destination)" }
          return !$exists
        } |
        % {
          Write-Host "[+] Copying cached package $($_.Destination)"
          Copy-Item @_ -Recurse
        }
    }
    
    # clean up any previous installation attempts that were Git clnoe based
    function Remove-GitInstalledSublimePackageControl
    {
      $installPath = 'Packages\Package Control'
      $packagesPath = Join-Path (Get-SublimeSettingsPath -Version $Version) $installPath
      if (Test-Path $packagesPath)
      {
        Write-Host "Removing previously Git installed Package Control from $packagesPath"
        Remove-Item $packagesPath -Recurse -Force -ErrorAction SilentlyContinue
      }
    }
    
    function Install-SublimePackageControl
    {
      [CmdletBinding()]
      param(
        [Parameter(Mandatory = $false)]
        [ValidateRange(2,3)]
        [int]
        $Version = 2,
    
        [Parameter(Mandatory = $false)]
        [Switch]
        $PreRelease = $false
      )
    
      # remove Git cloned version if it exists
      if ($Version -eq 3) { Remove-GitInstalledSublimePackageControl }
    
      # install package control
      $packageFolder = 'Installed Packages'
      $packagesPath = Join-Path (Get-SublimeSettingsPath -Version $Version) $packageFolder
    
      if (!(Test-Path $packagesPath)) { New-Item $packagesPath -Type Directory }
    
      $packageControl = Join-Path $packagesPath 'Package Control.sublime-package'
    
      if (Test-Path $packageControl) { Remove-item $packageControl }
    
      # http://wbond.net/sublime_packages/package_control/installation
      $packageUrl = 'http://sublime.wbond.net/Package%20Control.sublime-package'
      if ($PreRelease)
      {
        $packageUrl = 'https://sublime.wbond.net/prerelease/Package%20Control.sublime-package'
      }
      Get-ChocolateyWebFile -url $packageUrl -fileFullPath $packageControl
    
      $settings = @{ 'install_prereleases' = $PreRelease }
      Merge-PackageControlSettings -Settings $settings -Version $Version
    }
    
    function Merge-PackageControlSettings
    {
      [CmdletBinding(DefaultParameterSetName = "File")]
      param(
        [Parameter(Mandatory = $false, ParameterSetName = "File")]
        [string]
        $FilePath,
    
        [Parameter(Mandatory = $false, ParameterSetName = "Hash")]
        [Hashtable]
        $Settings,
    
        [Parameter(Mandatory = $false)]
        [ValidateRange(2,3)]
        [int]
        $Version = 2
      )
    
      $root = Get-SublimeUserPath -Version $Version
      $existingPath = Join-Path $root 'Package Control.sublime-settings'
      if (!(Test-Path $existingPath))
      {
        '{}' | Out-File -FilePath $existingPath -Encoding ASCII
      }
      $existingText = [IO.File]::ReadAllText($existingPath) -replace '(?m)^\s*//.*$', ''
      if ([string]::IsNullOrEmpty($existingText)) { $existingText = '{}' }
    
      $existing = ConvertFrom-Json $existingText
      Write-Verbose "Existing settings: `n`n$existingText`n`n"
    
      if ($PsCmdlet.ParameterSetName -eq 'File')
      {
        $new = ConvertFrom-Json ([IO.File]::ReadAllText($FilePath))
      }
      else
      {
        $new = $Settings
      }
    
      $simpleArrays = @('installed_packages', 'repositories', 'channels',
        'auto_upgrade_ignore', 'git_update_command', 'hg_update_command',
        'dirs_to_ignore', 'files_to_ignore', 'files_to_include',
        'files_to_ignore_binary', 'files_to_include_binary' )
      $simpleArrays |
        ? { $new.$_ -ne $null } |
        % { Merge-JsonArray -Name $_ -Destination $existing -Array $new.$_ }
    
      $maps = @('package_name_map')
      $maps |
        ? { $new.$_ -ne $null } |
        % { Merge-JsonSimpleMap -Name $_ -Destination $existing -SimpleMap $new.$_ }
    
      $arrayOfMaps = @('certs')
      $arrayOfMaps |
        ? { $new.$_ -ne $null } |
        % { Merge-JsonArrayOfSimpleMap -Name $_ -Destination $existing -Array $new.$_ }
    
      $excluded = $simpleArrays + $maps + $arrayOfMaps
      if ($new -is [PSCustomObject]) { $props = $new.PSObject.Properties }
      else { $props = $new.GetEnumerator() }
      $props |
        ? { $excluded -inotcontains $_.Name } |
        % {
          Merge-JsonNamedValue -Name $_.Name -Destination $existing -Value $_.Value
        }
    
      $json = $existing | ConvertTo-Json -Depth 10 | ConvertFrom-UnicodeEscaped
      Write-Verbose "Updated settings: `n`n$json`n"
      [IO.File]::WriteAllText($existingPath, $json, [System.Text.Encoding]::ASCII)
    }
    
    function Merge-Preferences
    {
      [CmdletBinding()]
      param(
        [Parameter(Mandatory = $true)]
        [String]
        $FilePath,
    
        [Parameter(Mandatory = $false)]
        [ValidateRange(2,3)]
        [int]
        $Version = 2
      )
    
      $root = Get-SublimeUserPath -Version $Version
      $existingPath = Join-Path $root 'Preferences.sublime-settings'
      if (!(Test-Path $existingPath))
      {
        '{}' | Out-File -FilePath $existingPath -Encoding ASCII
      }
    
      $existingText = [IO.File]::ReadAllText($existingPath) -replace '(?m)^\s*//.*$', ''
      if ([string]::IsNullOrEmpty($existingText)) { $existingText = '{}' }
    
      $existing = ConvertFrom-Json $existingText
      Write-Verbose "Existing settings: `n`n$existingText`n`n"
    
      $new = ConvertFrom-Json ([IO.File]::ReadAllText($FilePath))
    
      $simpleArrays = @('ignored_packages', 'indent_guide_options', 'rulers',
        'font_options', 'folder_exclude_patterns', 'file_exclude_patterns',
        'binary_file_patterns')
    
      $simpleArrays |
        ? { $new.$_ -ne $null } |
        % { Merge-JsonArray -Name $_ -Destination $existing -Array $new.$_ }
    
      'auto_complete_triggers' |
        ? { $new.$_ -ne $null } |
        % { Merge-JsonArrayOfSimpleMap -Name $_ -Destination $existing -Array $new.$_ }
    
      $excluded = $simpleArrays + 'auto_complete_triggers'
      $new.PSObject.Properties |
        ? { $excluded -inotcontains $_.Name } |
        % {
          Merge-JsonNamedValue -Name $_.Name -Destination $existing -Value $_.Value
        }
    
      # HACK: one last top level scan to ensure we don't have any single "
      $existing.PSObject.Properties |
        ? { $_.Value -is [String] } |
        % { $_.Value = $_.Value | ConvertTo-DoubleEscapedQuotes -Name $_.Name }
    
      $json = $existing | ConvertTo-Json -Depth 10 | ConvertFrom-UnicodeEscaped
      Write-Verbose "Updated settings: `n`n$json`n"
      [IO.File]::WriteAllText($existingPath, $json, [System.Text.Encoding]::ASCII)
    }
    

Virus Scan Results

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Dependencies

Maintainer(s)

Software Author(s)

  • Will Bond

Tags

Release Notes

Helper package to install Sublime Package Control.

Version History

Version Downloads Last updated Status
Sublime Text 3 Package Control 2.0.0.20130723 2746 Tuesday, July 23, 2013  

Discussion for the Sublime Text 3 Package Control Package

Ground rules:

  • This discussion is only about Sublime Text 3 Package Control and the Sublime Text 3 Package Control package. If you have feedback for Chocolatey, please contact the google group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Sublime Text 3 Package Control, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.

comments powered by Disqus