#1: Notice will now appear above comments

nickdeis · Jul 8, 2017 · 102209d · 102209d
1 parent 8028d13
commit 102209d
Show file tree

Hide file tree

Showing 13 changed files with 37 additions and 49 deletions.
diff --git a/index.js b/index.js
@@ -35,10 +35,19 @@ module.exports = {
                 const resolvedTemplate = _.template(template)(allVars);
                 const sourceCode = context.getSourceCode();
                 const text = sourceCode.getText().substring(0, chars);
+                const firstComment = sourceCode.getAllComments()[0];
                 return {
                     Program(node) {
                         function fix(fixer) {
-                            return fixer.insertTextBefore(node, resolvedTemplate);
+                            let topNode;
+                            if(!firstComment){
+                                topNode=node;
+                            }else if(firstComment.loc.start.line <= node.loc.start.line){
+                                topNode=firstComment;
+                            }else{
+                                topNode=node;
+                            } 
+                            return fixer.insertTextBefore(topNode, resolvedTemplate);
                         }
                         if (!String(text).match(mustMatch)) {
                             const report = { node, message: `Could not find a match for the mustMatch pattern` };

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,13 +1,13 @@
 {
   "name": "eslint-plugin-notice",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "An eslint rule that checks the top of files and --fix them too!",
   "main": "index.js",
   "directories": {
     "test": "tests"
   },
   "scripts": {
-    "test": "node tests/lib/rules/notice.js && node tests/cli-test.js"
+    "test": "node tests/lib/rules/notice.js"
   },
   "keywords": [
     "eslint",

diff --git a/staging/refresh.sh b/staging/refresh.sh
diff --git a/staging/setup.sh b/staging/setup.sh
diff --git a/staging/src/fixme-2.js b/staging/src/fixme-2.js
diff --git a/staging/src/fixme-3.js b/staging/src/fixme-3.js
diff --git a/staging/src/fixme.js b/staging/src/fixme.js
diff --git a/staging/src/no-fix.js b/staging/src/no-fix.js
diff --git a/tests/cli-test.js b/tests/cli-test.js
diff --git a/tests/lib/rules/fix-result-1.js b/tests/lib/rules/fix-result-1.js
@@ -0,0 +1,8 @@
+
+/**
+ * Copyright (c) 2017, Nick Deis
+ */
+
+function noStyle(){
+    return "I didn't read the style guide :(";
+}
diff --git a/tests/lib/rules/fix-result-2.js b/tests/lib/rules/fix-result-2.js
@@ -0,0 +1,11 @@
+
+/**
+ * Copyright (c) 2017, Nick Deis
+ */
+
+/**
+ * Not exactly what I was looking for
+ */
+function leastYouTried(){
+    return false;
+}
diff --git a/tests/lib/rules/notice.js b/tests/lib/rules/notice.js
@@ -11,7 +11,7 @@ const templateFile = path.join(__dirname,"../../test-template.js");
 
 const template = fs.readFileSync(templateFile,"utf8");
 
-const mustMatch = "Copyright \\(c\\) [0-9]{0,4}, Nick Deis";
+const mustMatch = /Copyright \(c\) [0-9]{0,4}, Nick Deis/;
 
 
 const ruleTester = new RuleTester();
@@ -38,12 +38,14 @@ ruleTester.run("notice",rule,{
         {
             code:noStyle,
             options:[{mustMatch,template}],
-            errors: [{ message: `Could not find a match for the mustMatch pattern`}]
+            errors: [{ message: `Could not find a match for the mustMatch pattern`}],
+            output:fs.readFileSync(__dirname+"/fix-result-1.js","utf8")
         },
         {
             code:notExact,
             options:[{mustMatch,template}],
-            errors:[{message:`Could not find a match for the mustMatch pattern`}]
+            errors:[{message:`Could not find a match for the mustMatch pattern`}],
+            output:fs.readFileSync(__dirname+"/fix-result-2.js","utf8")
         }
     ],
     valid:[{