test(check-line-alignment): add test example from #680 (but with "n…

…ever")
gajus · Jan 27, 2021 · 06f4521 · 06f4521
1 parent 780b8b5
commit 06f4521
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2125,6 +2125,18 @@ const fn = ( lorem, sit ) => {}
  function quux () {}
 // Options: ["never",{"tags":["param","return"]}]
 // Message: Expected JSDoc block lines to not be aligned.
+
+/**
+ * Returns the value stored in the process.env for a given
+ * environment variable.
+ *
+ * @param  {string} withPercents    '%USERNAME%'
+ * @param  {string} withoutPercents 'USERNAME'
+ * @return {string}                 'bob' || '%USERNAME%'
+ */
+function quux () {}
+// Options: ["never"]
+// Message: Expected JSDoc block lines to not be aligned.
 ````
 
 The following patterns are not considered problems:

diff --git a/test/rules/assertions/checkLineAlignment.js b/test/rules/assertions/checkLineAlignment.js
@@ -665,6 +665,48 @@ export default {
        function quux () {}
       `,
     },
+    {
+      code: `
+      /**
+       * Returns the value stored in the process.env for a given
+       * environment variable.
+       *
+       * @param  {string} withPercents    '%USERNAME%'
+       * @param  {string} withoutPercents 'USERNAME'
+       * @return {string}                 'bob' || '%USERNAME%'
+       */
+      function quux () {}
+      `,
+      errors: [
+        {
+          line: 6,
+          message: 'Expected JSDoc block lines to not be aligned.',
+          type: 'Block',
+        },
+        {
+          line: 7,
+          message: 'Expected JSDoc block lines to not be aligned.',
+          type: 'Block',
+        },
+        {
+          line: 8,
+          message: 'Expected JSDoc block lines to not be aligned.',
+          type: 'Block',
+        },
+      ],
+      options: ['never'],
+      output: `
+      /**
+       * Returns the value stored in the process.env for a given
+       * environment variable.
+       *
+       * @param {string} withPercents '%USERNAME%'
+       * @param  {string} withoutPercents 'USERNAME'
+       * @return {string}                 'bob' || '%USERNAME%'
+       */
+      function quux () {}
+      `,
+    },
   ],
   valid: [
     {