Merge pull request #44 from my-personal-forks/fix-40-here-string

Fix #40 - here string

Author: guillermooo

README.md

@@ -22,8 +22,34 @@ Support for the MS PowerShell programming language.
 - 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:
 
 
@@ -61,10 +87,23 @@ is YAML format. To use this format, follow these steps:
    You will get and updated version of the plist file.
 
 
-[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
+## 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.
+
 
 ## Contributing
 
 See [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

Support/PowershellSyntax.tmLanguage

@@ -134,7 +134,7 @@
 		</dict>
 		<dict>
 			<key>begin</key>
-			<string>^@"\n</string>
+			<string>\@"(?=\n)</string>
 			<key>end</key>
 			<string>^"@</string>
 			<key>name</key>
@@ -155,6 +155,27 @@
 				</dict>
 			</array>
 		</dict>
+		<dict>
+			<key>begin</key>
+			<string>\@'(?=\n)</string>
+			<key>end</key>
+			<string>^'@</string>
+			<key>name</key>
+			<string>string.quoted.single.heredoc.powershell</string>
+			<key>patterns</key>
+			<array>
+				<dict>
+					<key>match</key>
+					<string>''</string>
+					<key>name</key>
+					<string>constant.character.escape.powershell</string>
+				</dict>
+			</array>
+		</dict>
+		<dict>
+			<key>include</key>
+			<string>#numericConstant</string>
+		</dict>
 		<dict>
 			<key>begin</key>
 			<string>@\(</string>
@@ -203,27 +224,6 @@
 				</dict>
 			</array>
 		</dict>
-		<dict>
-			<key>begin</key>
-			<string>@'\n</string>
-			<key>end</key>
-			<string>^'@</string>
-			<key>name</key>
-			<string>string.quoted.single.heredoc.powershell</string>
-			<key>patterns</key>
-			<array>
-				<dict>
-					<key>match</key>
-					<string>''</string>
-					<key>name</key>
-					<string>constant.character.escape.powershell</string>
-				</dict>
-			</array>
-		</dict>
-		<dict>
-			<key>include</key>
-			<string>#numericConstant</string>
-		</dict>
 		<dict>
 			<key>match</key>
 			<string>-([lg][te]|[ci]?(eq|ne))</string>

bin/Build-Folder.ps1

@@ -0,0 +1,33 @@
+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
+}
+
+# copy to local folder
+push-location $thisDir
+    push-location '..'
+        $installedPackages = (GetConfigValue 'global-win' 'installed-packages')
+        write-output "copying files..."
+        # TODO: Perhaps we should delete the folder first.
+        copy-item * -recurse -force -exclude ".git" "$installedPackages/../Packages/PowerShell"
+    pop-location
+pop-location
+
+write-output "restarting editor... bye!"
+start-sleep -milliseconds 100
+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

manifest.json

@@ -8,6 +8,7 @@
 					"*.sublime-workspace",
 					"*.sublime-project",
 					"*.JSON-tmLanguage",
+					"*.YAML-tmLanguage",
 					"*.ps1",
 					"*.hg*",
 					"*.git*",
@@ -19,7 +20,8 @@
 			["./tests/*.py", []],
 
 			["./Snippets/*.*", []],
-			["./Support/*.*", []]
+			["./Support/*.*", ["*.YAML-tmLanguage"]
+			]
 
 		],
 		"release": [
@@ -29,6 +31,7 @@
 					"*.sublime-workspace",
 					"*.sublime-project",
 					"*.JSON-tmLanguage",
+					"*.YAML-tmLanguage",
 					"*.ps1",
 					"*.hg*",
 					"*.git*",

tests/__init__.py

@@ -0,0 +1,39 @@
+import unittest
+
+import sublime
+
+
+class ViewTest(unittest.TestCase):
+    def setUp(self):
+        self.view = sublime.active_window().new_file()
+
+    def append(self, text):
+        self.view.run_command('append', {'characters': text})
+
+    def tearDown(self):
+        self.view.set_scratch(True)
+        self.view.close()
+
+
+class SyntaxTest(ViewTest):
+    def _setSyntax(self, rel_path):
+        self.view.set_syntax_file(rel_path)
+
+    def getScopeNameAt(self, pt):
+        return self.view.scope_name(pt)
+
+    def getFinestScopeNameAt(self, pt):
+        return self.getScopeNameAt(pt).split()[-1]
+
+    def getScopeNameAtRowCol(self, row, col):
+        text_pt = self.view.text_point(row, col)
+        return self.getScopeNameAt(text_pt)
+
+    def getFinestScopeNameAtRowCol(self, row, col):
+        return self.getScopeNameAtRowCol(row, col).split()[-1]
+
+
+class PowerShellSyntaxTest(SyntaxTest):
+    def setUp(self):
+        super().setUp()
+        self._setSyntax('Packages/PowerShell/Support/PowershellSyntax.tmLanguage')

tests/syntax_def/__init__.py

@@ -0,0 +1,37 @@
+from PowerShell.tests import PowerShellSyntaxTest
+
+
+class Test_DoubleQuoted_HereDocStrings(PowerShellSyntaxTest):
+    def testIsScopeCorrectIfDelimiterAtBOL(self):
+        self.append("""@"
+hello
+"@
+""")
+        sname = self.getFinestScopeNameAtRowCol(1, 1)
+        self.assertEqual(sname, 'string.quoted.double.heredoc.powershell')
+
+    def testIsScopeCorrectIfDelimiterNotAtBOL(self):
+        self.append("""$foo = @"
+hello
+"@
+""")
+        sname = self.getFinestScopeNameAtRowCol(1, 1)
+        self.assertEqual(sname, 'string.quoted.double.heredoc.powershell')
+
+
+class Test_SingleQuoted_HereDocStrings(PowerShellSyntaxTest):
+    def testIsScopeCorrectIfDelimiterAtBOL(self):
+        self.append("""@'
+hello
+'@
+""")
+        sname = self.getFinestScopeNameAtRowCol(1, 1)
+        self.assertEqual(sname, 'string.quoted.single.heredoc.powershell')
+
+    def testIsScopeCorrectIfDelimiterNotAtBOL(self):
+        self.append("""$foo = @'
+hello
+'@
+""")
+        sname = self.getFinestScopeNameAtRowCol(1, 1)
+        self.assertEqual(sname, 'string.quoted.single.heredoc.powershell')