Fix actions/tour

node_modules/comment-parser/tests/e2e/issue-129.spec.js

@@ -0,0 +1,143 @@
+const {
+  parse,
+  inspect,
+  stringify,
+  transforms: { align },
+} = require('../../lib/index.cjs');
+
+const tokens = {
+  start: '',
+  delimiter: '',
+  postDelimiter: '',
+  tag: '',
+  postTag: '',
+  type: '',
+  postType: '',
+  name: '',
+  postName: '',
+  description: '',
+  end: '',
+  lineEnd: '',
+};
+
+test('carriage returns', () => {
+  const parsed = parse(`
+    /**
+     * description\r
+     * @param0 {param-type}\r
+     * @param1 {param-type} paramName param description\r
+     */`);
+
+  const source = [
+    {
+      number: 1,
+      source: '    /**',
+      tokens: {
+        ...tokens,
+        start: '    ',
+        delimiter: '/**',
+      },
+    },
+    {
+      number: 2,
+      source: '     * description\r',
+      tokens: {
+        ...tokens,
+        start: '     ',
+        delimiter: '*',
+        postDelimiter: ' ',
+        description: 'description',
+        lineEnd: '\r',
+      },
+    },
+    {
+      number: 3,
+      source: '     * @param0 {param-type}\r',
+      tokens: {
+        ...tokens,
+        start: '     ',
+        delimiter: '*',
+        postDelimiter: ' ',
+        tag: '@param0',
+        postTag: ' ',
+        type: '{param-type}',
+        lineEnd: '\r',
+      },
+    },
+    {
+      number: 4,
+      source: '     * @param1 {param-type} paramName param description\r',
+      tokens: {
+        ...tokens,
+        start: '     ',
+        delimiter: '*',
+        postDelimiter: ' ',
+        tag: '@param1',
+        postTag: ' ',
+        type: '{param-type}',
+        postType: ' ',
+        name: 'paramName',
+        postName: ' ',
+        description: 'param description',
+        lineEnd: '\r',
+      },
+    },
+    {
+      number: 5,
+      source: '     */',
+      tokens: {
+        ...tokens,
+        start: '     ',
+        end: '*/',
+      },
+    },
+  ];
+
+  expect(parsed[0]).toMatchObject({
+    description: 'description',
+    problems: [],
+    source,
+    tags: [
+      {
+        tag: 'param0',
+        type: 'param-type',
+        name: '',
+        optional: false,
+        description: '',
+        source: [source[2]],
+      },
+      {
+        tag: 'param1',
+        type: 'param-type',
+        name: 'paramName',
+        optional: false,
+        description: 'param description',
+        source: [source[3], source[4]],
+      },
+    ],
+  });
+});
+
+test('carriage returns with alignment', () => {
+  const source = `
+     /**\r
+      * Description may go\r
+      * over multiple lines followed by @tags\r
+      *  @param {string} name the name parameter\r
+      *     @param {any} value\r
+      */\r`.slice(1);
+
+  const expected = `
+     /**\r
+      * Description may go\r
+      * over multiple lines followed by @tags\r
+      * @param {string} name  the name parameter\r
+      * @param {any}    value\r
+      */\r`.slice(1);
+
+  const parsed = parse(source);
+  const aligned = align()(parsed[0]);
+  const stringified = stringify(aligned);
+
+  expect(stringified).toEqual(expected);
+});