Merge pull request palantir#405 from eonarheim/master

Fix issue palantir#324 windows line endings not respected

src/rules/jsdocFormatRule.ts

@@ -45,7 +45,10 @@ class JsdocWalker extends Lint.SkippableTokenAwareRuleWalker {
 
     private findFailuresForJsdocComment(commentText: string, startingPosition: number, sourceFile: ts.SourceFile) {
         var currentPosition = startingPosition;
-        var lines = commentText.split("\n");
+        // the file may be different depending on the OS it was originally authored on
+        // can't rely on require('os').EOL or process.platform as that is the execution env
+        // regex is: split optionally on \r\n, but alwasy split on \n if no \r exists
+        var lines = commentText.split(/\r?\n/);
         var jsdocPosition = currentPosition;
         var firstLine = lines[0];
 

test/files/rules/jsdoc-windows.test.ts

@@ -0,0 +1,10 @@
+/**
+ * MyClass
+ *
+ * Does classy things and impresses everyone. Quite a debonair class indeed.
+ *
+ * This file has all windows line endings "\r\n" and valid jsdoc.
+ */
+class MyClass {
+
+}

test/rules/jsdocFormatRuleTests.ts

@@ -42,4 +42,10 @@ describe("<jsdoc-format>", () => {
         Lint.Test.assertContainsFailure(actualFailures, expectedFailure7);
         assert.lengthOf(actualFailures, 7);
     });
+
+    it("ensures jsdoc commments can have have windows line endings", () => {
+        var fileName = "rules/jsdoc-windows.test.ts";
+        var actualFailures = Lint.Test.applyRuleOnFile(fileName, JsdocFormatRule);
+        assert.lengthOf(actualFailures, 0);
+    });
 });