-
Notifications
You must be signed in to change notification settings - Fork 81
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a9b53ce
commit d2b61c9
Showing
1 changed file
with
10 additions
and
97 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,111 +1,24 @@ | ||
| Status: [](https://ci.appveyor.com/project/guillermooo/powershell/branch/dev) | ||
| [](https://ci.appveyor.com/project/guillermooo/powershell/branch/dev) | ||
|
|
||
| PowerShell | ||
| ========== | ||
|
|
||
| Support for the MS PowerShell programming language. | ||
| ## PowerShell Package for Sublime Text 3 | ||
|
|
||
| Adds support for the MS PowerShell programming language. | ||
|
|
||
| # Install | ||
|
|
||
| ### Installing | ||
|
|
||
| 1. Install [package control][package_control] for Sublime Text. | ||
| 1. Install the **PowerShell** package: | ||
|
|
||
| 1. `Ctrl + Shift + P` | ||
| 1. `install` | ||
| 1. `powershell` | ||
|
|
||
|
|
||
| # Development | ||
|
|
||
|
|
||
| ## Requirements | ||
|
|
||
| - Python 3.3 (for build scripts) | ||
|
|
||
|
|
||
| ## Publishing This Package Locally as a Directory | ||
|
|
||
| **This is the recommended way of testing this package locally.** | ||
|
|
||
| First of all, you need to create a config file: | ||
|
|
||
|
|
||
| ``` | ||
| %HOME%/.sublime-package-dev | ||
| ``` | ||
|
|
||
| Add this content: | ||
|
|
||
| ``` | ||
| global-win editor ~/path/to/sublime_text.exe | ||
| global-win installed-packages ~/path/to/sublime-text/Installed Packages | ||
| ``` | ||
|
|
||
| 1. Clone [this repo][this_repo] to a folder of your choice | ||
| 1. Make sure you have no *PowerShell.sublime-package* under the | ||
| `{Data}/Installed Packages` directory. | ||
| 1. Run *./bin/Build-Folder.ps1* on the command line. | ||
|
|
||
|
|
||
| ## Generating `PowerShell.sublime-package` | ||
|
|
||
| **This method is not recommended at present.** | ||
|
|
||
| First of all, you need to create a config file: | ||
|
|
||
|
|
||
| ``` | ||
| %HOME%/.sublime-package-dev | ||
| ``` | ||
|
|
||
| Add this content: | ||
|
|
||
| ``` | ||
| global-win editor ~/path/to/sublime_text.exe | ||
| global-win installed-packages ~/path/to/sublime-text/Installed Packages | ||
| ``` | ||
|
|
||
| - Clone [this repo][this_repo] to a folder of your choice | ||
| - Open the `PowerShell.sublime-project` included as a project | ||
| - Select Tools → Build Systems → Run | ||
| - Press <kbd>F7</kbd> to build and publish locally a new dev version | ||
|
|
||
|
|
||
| ## Syntax | ||
|
|
||
| The plist file [PowershellSyntax.tmLanguage](Support/PowershellSyntax.tmLanguage) | ||
| is the syntax definition's master file. | ||
|
|
||
| However, the [recommended way][syntax_topic] to edit the syntax definition | ||
| is YAML format. To use this format, follow these steps: | ||
|
|
||
| 1. Using Package Control, install the `AAAPackageDev` package. | ||
| 1. Open **PowershellSyntax.tmLanguage**. | ||
| 1. Call `Ctrl + Shift + P` + `convert to Yaml and Rearrange`. | ||
| You will get a new file: **Support/PowershellSyntax.YAML-tmLanguage**. | ||
| 1. Edit the YAML file. | ||
| 1. Call `Ctrl + Shift + P` + `convert (YAML, JSON, Plist) to`. | ||
| You will get and updated version of the plist file. | ||
|
|
||
|
|
||
| ## Running the Test Suite | ||
|
|
||
| ### Requirements | ||
|
|
||
| - UnitTesting (install via [Package Control][package_control]) | ||
|
|
||
| ### How to Run the Tests | ||
|
|
||
| Open the command palette, then select 'UnitTesting'. Type in 'PowerShell' and | ||
| press enter. | ||
| 1. Press <kbd>Ctrl + Shift + P</kbd> | ||
| 1. Select 'Install Package' | ||
| 1. Select 'PowerShell' | ||
|
|
||
|
|
||
| ## Contributing | ||
| ### Developing | ||
|
|
||
| See [CONTRIBUTING.md](CONTRIBUTING.md). | ||
| You want to contribute? Awesome! Take a look at [CONTRIBUTING.md](CONTRIBUTING.md). | ||
|
|
||
|
|
||
| [package_control]: https://sublime.wbond.net/installation | ||
| [this_repo]: https://github.com/SublimeText/PowerShell | ||
| [syntax_topic]: http://sublime-text-unofficial-documentation.readthedocs.org/en/latest/extensibility/syntaxdefs.html |