Merge pull request #39 from my-personal-forks/scripts

Build scripts

Author: guillermooo

.gitignore

@@ -8,3 +8,6 @@
 dist/
 MANIFEST
 *.YAML-tmLanguage
+
+# Other
+.idea

PowerShell.sublime-project

@@ -5,5 +5,12 @@
 			"follow_symlinks": true,
 			"path": "."
 		}
+	],
+
+	"build_systems": [
+		{
+			"name": "Run",
+			"shell_cmd": "powershell.exe -noninteractive -file $project_path/bin/Build.ps1"
+		}
 	]
 }

README.md

@@ -16,9 +16,32 @@ Support for the MS PowerShell programming language.
 
 # Development
 
-1. Open the Sublime Text packages folder (`Ctrl + Shift + P` + `browse packages`)
-1. Clone [this repo][this_repo] to the packages folder
-Now your local version of this package is available in Sublime Text.
+
+## Requirements
+
+- Python 3.3 (for build scripts)
+
+
+## Generating `PowerShell.sublime-package`
+
+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 

bin/Build.ps1

@@ -0,0 +1,32 @@
+param([switch]$Release)
+
+$script:thisDir = split-path $MyInvocation.MyCommand.Path -parent
+
+. (join-path $script:thisDir "Config.ps1")
+
+if(!$?){
+	write-error "Could not read config."
+	exit 1
+}
+
+$publishRelease = join-path $script:thisDir "Publish.ps1"
+
+
+# XXX: Use @boundparams instead?
+& $publishRelease -Release:$Release
+
+if ($LASTEXITCODE -ne 0) {
+    write-error "Could not publish package."
+    exit 1
+}
+
+get-process "sublime_text" | stop-process
+start-sleep -milliseconds 250
+# sss
+$editor = (GetConfigValue 'global-win' 'editor')
+if(!$?){
+	write-error "Could not locate editor command."
+	exit 1
+}
+
+&$editor

bin/Config.ps1

@@ -0,0 +1,35 @@
+# Helpers to read files in this format:
+#
+#	global-win editor path/to/some/bin
+#	project-foo deploy-url http://some/url/here
+#	...
+
+function GetConfig {
+	$path = "~/.sublime-package-dev"
+
+	if(!(test-path $path)){
+		write-error "Could not find personal configuration in $path."
+		exit 1
+	}
+	get-content $path
+}
+
+$script:configData = GetConfig
+
+function GetConfigValue {
+	param($section, $key)
+	$section = $section.ToLower()
+	$key = $key.ToLower()
+	foreach($item in $configData){
+		if(!$item.Trim()){
+			continue
+		}
+		$s, $k, $v = $item.ToLower() -split ' ',3
+		if(($s -eq $section) -and ($k -eq $key)){
+			if(!$v){
+				throw "No value found for '${section}:$key'."
+			}
+			return $v
+		}
+	}
+}

bin/Publish.ps1

@@ -0,0 +1,46 @@
+param([switch]$Release, [switch]$DontUpload)
+
+$script:thisDir = split-path $MyInvocation.MyCommand.Path -parent
+# Don't resolve-path because it may not exist yet.
+$script:distDir = join-path $thisDir "../dist"
+
+. (join-path $script:thisDir "Config.ps1")
+
+if(!$?){
+	write-error "Could not read config."
+	exit 1
+}
+
+# & "py.exe" "-3" (join-path $script:thisDir "check.py") $typeOfBuild
+# if ($LASTEXITCODE -ne 0) {
+	# "publish aborted"
+	# exit 1
+# }
+
+$typeOfBuild = if ($Release) {"release"} else {"dev"}
+# Run with the required Python version.
+& "py.exe" "-3" (join-path $script:thisDir "builder.py") "--release" $typeOfBuild
+
+if ($LASTEXITCODE -ne 0) {
+   write-error "could not run builder.py"
+   exit 1
+}
+
+$installedPackages = (GetConfigValue 'global-win' 'installed-packages')
+if(!$?){
+	throw "Could not retrieve Installed Packages location from confige"
+	exit 1
+}
+$targetDir = resolve-path ($installedPackages)
+
+copy-item (join-path $distDir "PowerShell.sublime-package") $targetDir -force
+
+if ($Release -and (!$DontUpload)) {
+	$deployUrl = (GetConfigValue 'project-powershell' 'deploy-url')
+	if(!$?){
+		throw "Could not retrieve deploy url from config."
+		exit 1
+	}
+	start-process $deployUrl
+	(resolve-path $distDir).path | clip.exe
+}

bin/builder.py

@@ -0,0 +1,60 @@
+from fnmatch import fnmatch
+from itertools import chain
+from zipfile import ZipFile
+from zipfile import ZIP_DEFLATED
+import argparse
+import glob
+import json
+import os
+
+
+THIS_DIR = os.path.abspath(os.path.dirname(__file__))
+PROJECT_ROOT = os.path.dirname(THIS_DIR)
+RESERVED = ['manifest.json', 'dist']
+
+
+parser = argparse.ArgumentParser(
+                    description="Builds .sublime-package archives.")
+parser.add_argument('-d', dest='target_dir', default='./dist',
+                    help="output directory")
+parser.add_argument('--release', dest='release', default='dev',
+                    help="type of build (e.g. 'dev', 'release'...)")
+
+
+def get_manifest():
+    path = os.path.join(PROJECT_ROOT, 'manifest.json')
+    with open(path) as f:
+        return json.load(f)
+
+
+def unwanted(fn, pats):
+    return any(fnmatch(fn, pat) for pat in pats + RESERVED)
+
+
+def ifind_files(patterns):
+    for fn in (fn for (pat, exclude) in patterns
+                                     for fn in glob.iglob(pat)
+                                     if not unwanted(fn, exclude)):
+        yield fn
+
+
+def build(target_dir="dist", release="dev"):
+    manifest = get_manifest()
+    name = manifest['name'] + '.sublime-package'
+
+    target_dir = os.path.join(PROJECT_ROOT, target_dir)
+    if not os.path.exists(target_dir):
+        os.mkdir(target_dir)
+
+    target_file = os.path.join(target_dir, name)
+    if os.path.exists(target_file):
+        os.unlink(target_file)
+
+    with ZipFile(target_file, 'a', compression=ZIP_DEFLATED) as package:
+        for fn in ifind_files(manifest['include'][release]):
+            package.write(fn)
+
+
+if __name__ == '__main__':
+    args = parser.parse_args()
+    build(args.target_dir, args.release)

bin/check.py

@@ -0,0 +1,49 @@
+"""
+check for common build errors
+"""
+
+import json
+import os
+import sys
+
+
+_this_dir = os.path.dirname(__file__)
+_parent = os.path.realpath(os.path.join(_this_dir, '..'))
+
+
+def check_messages():
+    _messages = os.path.realpath(os.path.join(_parent, 'messages.json'))
+    _messages_dir = os.path.realpath(os.path.join(_parent, 'messages'))
+
+    msg_paths = None
+    try:
+        with open(_messages, 'r') as f:
+            msg_paths = json.load(f)
+    except Exception as e:
+        print('syntax error in messages.json')
+        print('=' * 80)
+        print(e)
+        print('=' * 80)
+        sys.exit(1)
+
+    def exists(path):
+        if os.path.exists(os.path.join(_parent, path)):
+            return True
+
+    def is_name_correct(key, path):
+        name = os.path.basename(path)
+        return (key == os.path.splitext(name)[0])
+
+    # is there a file for each message?
+    for (key, rel_path) in msg_paths.items():
+        if not is_name_correct(key, rel_path):
+            print('file name not correct: {0} ==> {1}'.format(key, rel_path))
+            sys.exit(1)
+
+        if not exists(rel_path):
+            print('message file not found: {0}'.format(rel_path))
+            sys.exit(1)
+
+
+if __name__ == '__main__':
+    check_messages()