Package Control.sublime-settings 覚書

リポジトリの一覧を記載した JSON ファイルを保有する URL の一覧。
”channels” に記載されたチャンネルに由来するリポジトリは
”repositories” 設定の後に登録される。

"channels": [
   "https://packagecontrol.io/channel_v3.json"
],

JSON ファイルのパッケージを含む URL の一覧。
”repositories” に記載されたリポジトリは
”channels” 設定に由来するリポジトリの前に登録される。

"repositories": [],

プレリリース版をインストールするパッケージの一覧。
パッケージが “install_prereleases” の一覧に記載されていない場合、
Version 1.0.0 未満のパッケージはプレリリース版とはみなされず、
SemVer -prerelease 接尾辞が使用されているもののみ無視される。

"install_prereleases": [],

HTTP / HTTPS 接続のデバッグ情報をSublime Text コンソールへ表示するかどうかを指定する。

"debug": false,

リポジトリ名と同じ名前のパッケージがないか確認し、
名前の付け方についての問題解決を支援する。
主に GitHub と BitBucket のリポジトリにおいて役に立つ。
この関連付けはリポジトリチャンネルから取得した関連付けを上書きする。

"package_name_map": {},

パッケージのインストール、更新、削除についての情報を
集約統計チャンネルへ登録するかどうかを指定する。

"submit_usage": true,

インストール後、更新後、削除後に通知を送信する URL 。

"submit_url": "https://packagecontrol.io/submit",

Sublime Text 起動時にパッケージを自動更新するかどうかを指定する。

"auto_upgrade": true,

欠落しているパッケージを Sublime Text 起動時に
自動的にインストールするかどうかを指定する。

"install_missing": true,

Package Control によってインストールされたが、
installed_packages に記載がない場合に
該当パッケージは他の端末において削除され、
Package Control.sublime-settings ファイルが
他の端末と同期されたと推定し、
パッケージを削除する。
(ただし package-metadata.json ファイルを保有するパッケージに限る)

"remove_orphaned": true,

自動更新の確認を行う頻度の最小値を時間単位で指定する。
0 を指定した場合、常に自動更新の確認を実行する。

"auto_upgrade_frequency": 1,

自動更新しないパッケージを指定する。

"auto_upgrade_ignore": [],

チャンネル、リポジトリ、パッケージのダウンロード時のタイムアウトを設定する。
Windows では WinINet のバグにより動作しない。

"timeout": 30,

リポジトリとパッケージの情報をキャッシュする期間を秒単位で指定する。

"cache_length": 300,

要求に使用する HTTP プロキシサーバを指定する。
Windows のシステムプロキシ設定は WinINet を利用する為、通常は使用しない。
しかし WinINet が正しく動作していない場合、
http_proxy は Urllib downloader によって代替手段として使用される。

"http_proxy": "",

要求に使用する HTTPS プロキシサーバを指定する。
”” または null が設定されている場合は http_proxy から値を継承する。
http_proxy から継承したくない場合は false を指定する。
Windows のシステムプロキシ設定は WinINet を利用する為、通常は使用しない。
しかし WinINet が正しく動作していない場合、
https_proxy はUrllib downloader によって代替手段として使用される。

"https_proxy": "",

http_proxy と https_proxy において使用するユーザ名とパスワードを指定する。
システムレベルプロキシ設定の資格情報を設定する為に WinINet によって使用されることがある。

"proxy_username": "",
"proxy_password": "",

HTTP 応答をディスクへキャッシュするかどうかを指定する。

"http_cache": true,

HTTP 応答をキャッシュする期間を秒単位で指定する。既定値は 1 週間。

"http_cache_length": 604800,

HTTP 要求に使用するユーザエージェントを指定する。
”%s” を指定した場合、最新のバージョンに置換される。

"user_agent": "Package Control v%s",

操作実行時に無視するパッケージ名の一覧を指定する。
git または hg リポジトリにあるパッケージに限り、有効となる。
Package Control を使用せず、
手動でリポジトリを操作したいパッケージ開発者にとって有用な設定。

インストールが停止しているパッケージの一覧表示を支援する。
対話式プロンプトを使用することができる。

true を指定した場合、すべての git と hg リポジトリを無視する。

"ignore_vcs_packages": [],

システム上で自動検出できず、
パッケージが .git メタデータディレクトリを含んでいる場合に使用する
”git” バイナリのカスタムパスを指定する。
複数のパス設定をサポートし、 OS 全体で設定の同期を行うことを許可する。

"git_binary": [],

コマンドの実行対象は自動的に決定される為、
リモートリポジトリやブランチの名前を含めてはならない。

"git_update_command": ["pull", "--ff", "--commit"],

システム上で自動検出できず、
パッケージが .hg メタデータディレクトリを含んでいる場合に使用する
”hg” バイナリのカスタムパスを指定する。
複数のパス設定をサポートし、 OS 全体で設定の同期を行うことを許可する。

"hg_binary": [],

HG リポジトリ向けの設定。リモート URL として必ず “default” を使用すること。
この動作は HG リポジトリをクローンする際の既定動作である。

"hg_update_command": ["pull", "--update"],

管理されていないパッケージを一覧表示する際に無視する追加パッケージ。

"unmanaged_packages_ignore": [],

HTTP(S) 要求を使用するダウンローダのバックエンドを指定する。
設定の共有を許可する為に OS によって使用される。

有効なオプション:

• “urllib”
• “curl”
• “wget”
• “wininet”(Windows のみ)

端末またはネットワーク上で wininet に問題が発生している場合に
wininet の代わりに urllib を使用することを Windows ユーザへ許可する。
OS X と Linux のユーザは urllib の代わりに
curl や wget を使用する方が良いこともある。

“curl” と “wget” オプションはコマンドラインへ
”curl” や “wget” プログラムがインストールされており、
PATH が設定されていることを要求する。

"downloader_precedence": {
   "windows": ["wininet"],
   "osx": ["urllib"],
   "linux": ["urllib", "curl", "wget"]
},

パッケージ作成時に無視するディレクトリ。

"dirs_to_ignore": [
   ".hg", ".git", ".svn", "_darcs", "CVS"
],

パッケージ作成時に無視するファイル。

"files_to_ignore": [
   "*.pyc", ".hgignore", ".gitignore", ".bzrignore",
   "*.sublime-project", "*.sublime-workspace", "*.tmTheme.cache"
],

files_to_ignore のパターンに合致するが、無視しないファイル。

"files_to_include": [],

パッケージ作成時のコピー先フォルダ。既定値は Desktop

"package_destination": "",

異なる種類のパッケージリリース向けの
(異なるプラットフォームやバイナリのみのリリース)
パッケージプロファイルの作成方法。

オブジェクトのキーがプロファイル名となり、
”Create Package File” コマンド実行時にキーの一覧が提示される。
”Default” プロファイルが使用する上位版を下記に示す:

• “dirs_to_ignore”
• “files_to_ignore”
• “files_to_include”
• “package_destination”

プロファイルがこれら 3 つの設定の内いずれかを含んでいない場合、
上位の設定が代替として使用される。

"package_profiles": {
   "Binaries Only": {
      // 全ての .py ファイルを除外し、 .pyc ファイルを含める。
      "files_to_ignore": [
         "*.py", ".hgignore", ".gitignore", ".bzrignore",
         "*.sublime-project", "*.sublime-workspace", "*.tmTheme.cache"
      ],

      // __init__.py を含め、 Sublime Text へパッケージを読込ませる。
      "files_to_include": [
         "__init__.py"
      ]
   }
},

テストの実行機能を有効にする。 - 開発時のみ。

"enable_tests": false