comment-parser 1.1.5 → 1.1.6-beta.0

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v1.1.6-beta.0
+- keep original CR line endings
+- allow to normalize line endings with `crlf` transform
+
 # v1.1.5
 - drop unused variables
 - add .editorconfig

package/browser/index.js

@@ -11,7 +11,7 @@ var CommentParser = (function (exports) {
             : [source.slice(0, matches[0].length), source.slice(matches[0].length)];
     }
     function splitLines(source) {
-        return source.split(/\r?\n/);
+        return source.split(/\n/);
     }
     function seedSpec(spec = {}) {
         return Object.assign({ tag: '', name: '', type: '', optional: false, description: '', problems: [], source: [] }, spec);
@@ -530,6 +530,48 @@ var CommentParser = (function (exports) {
         };
     }
 
+    var __rest$2 = (window && window.__rest) || function (s, e) {
+        var t = {};
+        for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+            t[p] = s[p];
+        if (s != null && typeof Object.getOwnPropertySymbols === "function")
+            for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+                if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                    t[p[i]] = s[p[i]];
+            }
+        return t;
+    };
+    const order = [
+        'end',
+        'description',
+        'postType',
+        'type',
+        'postName',
+        'name',
+        'postTag',
+        'tag',
+        'postDelimiter',
+        'delimiter',
+        'start',
+    ];
+    function crlf(ending) {
+        const normalize = (source) => source.replace(/\r*$/, ending === 'LF' ? '' : '\r');
+        function update(line) {
+            const { tokens } = line;
+            for (const f of order) {
+                if (tokens[f] !== '') {
+                    tokens[f] = normalize(tokens[f]);
+                    break;
+                }
+            }
+            return Object.assign(Object.assign({}, line), { tokens });
+        }
+        return (_a) => {
+            var { source } = _a, fields = __rest$2(_a, ["source"]);
+            return rewireSource(Object.assign(Object.assign({}, fields), { source: source.map(update) }));
+        };
+    }
+
     function flow(...transforms) {
         return (block) => transforms.reduce((block, t) => t(block), block);
     }
@@ -583,6 +625,7 @@ var CommentParser = (function (exports) {
         flow: flow,
         align: align,
         indent: indent,
+        crlf: crlf,
     };
     const tokenizers = {
         tag: tagTokenizer,

package/es6/index.d.ts

@@ -5,6 +5,7 @@ import tagTokenizer from './parser/tokenizers/tag';
 import typeTokenizer from './parser/tokenizers/type';
 import alignTransform from './transforms/align';
 import indentTransform from './transforms/indent';
+import crlfTransform from './transforms/crlf';
 import { flow as flowTransform } from './transforms/index';
 export * from './primitives';
 export declare function parse(source: string, options?: Partial<ParserOptions>): import("./primitives").Block[];
@@ -14,6 +15,7 @@ export declare const transforms: {
     flow: typeof flowTransform;
     align: typeof alignTransform;
     indent: typeof indentTransform;
+    crlf: typeof crlfTransform;
 };
 export declare const tokenizers: {
     tag: typeof tagTokenizer;

package/es6/index.js

@@ -6,6 +6,7 @@ import typeTokenizer from './parser/tokenizers/type';
 import getStringifier from './stringifier/index';
 import alignTransform from './transforms/align';
 import indentTransform from './transforms/indent';
+import crlfTransform from './transforms/crlf';
 import { flow as flowTransform } from './transforms/index';
 export * from './primitives';
 export function parse(source, options = {}) {
@@ -17,6 +18,7 @@ export const transforms = {
     flow: flowTransform,
     align: alignTransform,
     indent: indentTransform,
+    crlf: crlfTransform,
 };
 export const tokenizers = {
     tag: tagTokenizer,

package/es6/transforms/crlf.d.ts

@@ -0,0 +1,3 @@
+import { Transform } from './index';
+export declare type Ending = 'LF' | 'CRLF';
+export default function crlf(ending: Ending): Transform;

package/es6/transforms/crlf.js

@@ -0,0 +1,42 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { rewireSource } from '../util';
+const order = [
+    'end',
+    'description',
+    'postType',
+    'type',
+    'postName',
+    'name',
+    'postTag',
+    'tag',
+    'postDelimiter',
+    'delimiter',
+    'start',
+];
+export default function crlf(ending) {
+    const normalize = (source) => source.replace(/\r*$/, ending === 'LF' ? '' : '\r');
+    function update(line) {
+        const { tokens } = line;
+        for (const f of order) {
+            if (tokens[f] !== '') {
+                tokens[f] = normalize(tokens[f]);
+                break;
+            }
+        }
+        return Object.assign(Object.assign({}, line), { tokens });
+    }
+    return (_a) => {
+        var { source } = _a, fields = __rest(_a, ["source"]);
+        return rewireSource(Object.assign(Object.assign({}, fields), { source: source.map(update) }));
+    };
+}

package/es6/util.js

@@ -8,7 +8,7 @@ export function splitSpace(source) {
         : [source.slice(0, matches[0].length), source.slice(matches[0].length)];
 }
 export function splitLines(source) {
-    return source.split(/\r?\n/);
+    return source.split(/\n/);
 }
 export function seedBlock(block = {}) {
     return Object.assign({ description: '', tags: [], source: [], problems: [] }, block);

package/lib/index.d.ts

@@ -5,6 +5,7 @@ import tagTokenizer from './parser/tokenizers/tag';
 import typeTokenizer from './parser/tokenizers/type';
 import alignTransform from './transforms/align';
 import indentTransform from './transforms/indent';
+import crlfTransform from './transforms/crlf';
 import { flow as flowTransform } from './transforms/index';
 export * from './primitives';
 export declare function parse(source: string, options?: Partial<ParserOptions>): import("./primitives").Block[];
@@ -14,6 +15,7 @@ export declare const transforms: {
     flow: typeof flowTransform;
     align: typeof alignTransform;
     indent: typeof indentTransform;
+    crlf: typeof crlfTransform;
 };
 export declare const tokenizers: {
     tag: typeof tagTokenizer;

package/lib/index.js

@@ -19,6 +19,7 @@ const type_1 = require("./parser/tokenizers/type");
 const index_2 = require("./stringifier/index");
 const align_1 = require("./transforms/align");
 const indent_1 = require("./transforms/indent");
+const crlf_1 = require("./transforms/crlf");
 const index_3 = require("./transforms/index");
 __exportStar(require("./primitives"), exports);
 function parse(source, options = {}) {
@@ -32,6 +33,7 @@ exports.transforms = {
     flow: index_3.flow,
     align: align_1.default,
     indent: indent_1.default,
+    crlf: crlf_1.default,
 };
 exports.tokenizers = {
     tag: tag_1.default,

package/lib/transforms/crlf.d.ts

@@ -0,0 +1,3 @@
+import { Transform } from './index';
+export declare type Ending = 'LF' | 'CRLF';
+export default function crlf(ending: Ending): Transform;

package/lib/transforms/crlf.js

@@ -0,0 +1,45 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../util");
+const order = [
+    'end',
+    'description',
+    'postType',
+    'type',
+    'postName',
+    'name',
+    'postTag',
+    'tag',
+    'postDelimiter',
+    'delimiter',
+    'start',
+];
+function crlf(ending) {
+    const normalize = (source) => source.replace(/\r*$/, ending === 'LF' ? '' : '\r');
+    function update(line) {
+        const { tokens } = line;
+        for (const f of order) {
+            if (tokens[f] !== '') {
+                tokens[f] = normalize(tokens[f]);
+                break;
+            }
+        }
+        return Object.assign(Object.assign({}, line), { tokens });
+    }
+    return (_a) => {
+        var { source } = _a, fields = __rest(_a, ["source"]);
+        return util_1.rewireSource(Object.assign(Object.assign({}, fields), { source: source.map(update) }));
+    };
+}
+exports.default = crlf;

package/lib/util.js

@@ -13,7 +13,7 @@ function splitSpace(source) {
 }
 exports.splitSpace = splitSpace;
 function splitLines(source) {
-    return source.split(/\r?\n/);
+    return source.split(/\n/);
 }
 exports.splitLines = splitLines;
 function seedBlock(block = {}) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comment-parser",
-  "version": "1.1.5",
+  "version": "1.1.6-beta.0",
   "description": "Generic JSDoc-like comment parser",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -53,4 +53,4 @@
   },
   "homepage": "https://github.com/syavorsky/comment-parser",
   "dependencies": {}
-}
+}

package/src/index.ts

@@ -6,6 +6,7 @@ import typeTokenizer from './parser/tokenizers/type';
 import getStringifier from './stringifier/index';
 import alignTransform from './transforms/align';
 import indentTransform from './transforms/indent';
+import crlfTransform from './transforms/crlf';
 import { flow as flowTransform } from './transforms/index';
 
 export * from './primitives';
@@ -21,6 +22,7 @@ export const transforms = {
   flow: flowTransform,
   align: alignTransform,
   indent: indentTransform,
+  crlf: crlfTransform,
 };
 
 export const tokenizers = {

package/src/transforms/crlf.ts

@@ -0,0 +1,38 @@
+import { Transform } from './index';
+import { Block, Line } from '../primitives';
+import { rewireSource } from '../util';
+
+const order = [
+  'end',
+  'description',
+  'postType',
+  'type',
+  'postName',
+  'name',
+  'postTag',
+  'tag',
+  'postDelimiter',
+  'delimiter',
+  'start',
+];
+
+export type Ending = 'LF' | 'CRLF';
+
+export default function crlf(ending: Ending): Transform {
+  const normalize = (source: string): string =>
+    source.replace(/\r*$/, ending === 'LF' ? '' : '\r');
+
+  function update(line: Line): Line {
+    const { tokens } = line;
+    for (const f of order) {
+      if (tokens[f] !== '') {
+        tokens[f] = normalize(tokens[f]);
+        break;
+      }
+    }
+    return { ...line, tokens };
+  }
+
+  return ({ source, ...fields }: Block): Block =>
+    rewireSource({ ...fields, source: source.map(update) });
+}

package/src/util.ts

@@ -12,7 +12,7 @@ export function splitSpace(source: string): [string, string] {
 }
 
 export function splitLines(source: string): string[] {
-  return source.split(/\r?\n/);
+  return source.split(/\n/);
 }
 
 export function seedBlock(block: Partial<Block> = {}): Block {

package/tests/unit/source-parser.spec.ts

@@ -1,5 +1,5 @@
 import getParser, { Parser } from '../../src/parser/source-parser';
-import { Block, Line } from '../../src/primitives';
+import { Line } from '../../src/primitives';
 import { splitLines, seedBlock, seedTokens } from '../../src/util';
 
 let _parse: Parser;
@@ -235,3 +235,51 @@ test('start line number', () => {
 
   expect(parsed).toEqual([null, block]);
 });
+
+test('carriage returns', () => {
+  const source = splitLines(
+    ['/**', ' * description', ' *', ' */', ''].join('\r\n')
+  );
+
+  const parsed = source.map(getParser());
+
+  const block = [
+    {
+      number: 0,
+      source: '/**\r',
+      tokens: seedTokens({
+        delimiter: '/**',
+        postDelimiter: '\r',
+      }),
+    },
+    {
+      number: 1,
+      source: ' * description\r',
+      tokens: seedTokens({
+        start: ' ',
+        delimiter: '*',
+        postDelimiter: ' ',
+        description: 'description\r',
+      }),
+    },
+    {
+      number: 2,
+      source: ' *\r',
+      tokens: seedTokens({
+        start: ' ',
+        delimiter: '*',
+        postDelimiter: '\r',
+      }),
+    },
+    {
+      number: 3,
+      source: ' */\r',
+      tokens: seedTokens({
+        start: ' ',
+        end: '*/\r',
+      }),
+    },
+  ];
+
+  expect(parsed).toEqual([...nulls(3), block, null]);
+});

package/tests/unit/transforms-crlf.spec.ts

@@ -0,0 +1,70 @@
+import crlf, { Ending } from '../../src/transforms/crlf';
+import getParser, { Parser } from '../../src/parser/index';
+import getStringifier, { Stringifier } from '../../src/stringifier/index';
+
+const tests = [
+  [
+    'no CR',
+    'CRLF',
+    `
+    /**
+     * description
+     *
+     */`,
+    `
+    /**\r
+     * description\r
+     *\r
+     */\r`,
+  ],
+  [
+    'mixed',
+    'CRLF',
+    `
+    /**
+     * description
+     *\r
+     */`,
+    `
+    /**\r
+     * description\r
+     *\r
+     */\r`,
+  ],
+  [
+    'no CR',
+    'LF',
+    `
+    /**
+     * description
+     *
+     */`,
+    `
+    /**
+     * description
+     *
+     */`,
+  ],
+  [
+    'mixed',
+    'LF',
+    `
+    /**
+     * description
+     *\r
+     */`,
+    `
+    /**
+     * description
+     *
+     */`,
+  ],
+];
+
+test.each(tests)('CRLF - %s to %s', (name, mode, source, expected) => {
+  expected = expected.slice(1);
+  const parsed = getParser()(source);
+  const normalized = crlf(mode as Ending)(parsed[0]);
+  const out = getStringifier()(normalized);
+  expect(out).toBe(expected);
+});

package/tests/unit/util.spec.ts

@@ -8,9 +8,9 @@ import {
 } from '../../src/util';
 
 test.each([
-  ['win', 'a\r\nb\r\nc', ['a', 'b', 'c']],
+  ['win', 'a\r\nb\r\nc', ['a\r', 'b\r', 'c']],
   ['unix', 'a\nb\nc', ['a', 'b', 'c']],
-  ['mixed', 'a\nb\r\nc', ['a', 'b', 'c']],
+  ['mixed', 'a\nb\r\nc', ['a', 'b\r', 'c']],
   ['none', 'abc', ['abc']],
 ])('spliLines - %s', (name, source, parsed) =>
   expect(splitLines(source)).toEqual(parsed)