Merge pull request #5 from technote-space/release/next-v2.0.0

release: v2.1.0

Author: technote-space

README.md

@@ -45,8 +45,8 @@ transform(readFileSync('README.md', {
   // updateOnly: true,
   // openingComment: '<!-- toc -->',
   // closingComment: '<!-- tocstop --> ',
-  // checkOpeningComment: '<!-- toc ',
-  // checkClosingComment: '<!-- tocstop ',
+  // checkOpeningComments: ['<!-- toc '],
+  // checkClosingComments: ['<!-- tocstop '],
 }));
 ```
 

__tests__/transform-weird-headers.test.ts

@@ -33,8 +33,8 @@ describe('transform', () => {
   it('change check toc comment', () => {
     const content = readFileSync(resolve(__dirname, 'fixtures/readme-with-weird-headers.md'), 'utf8');
     const headers = transform(content, {
-      checkOpeningComment: '<!-- toc ',
-      checkClosingComment: '<!-- tocstop ',
+      checkOpeningComments: ['<!-- toc '],
+      checkClosingComments: ['<!-- tocstop '],
       openingComment: '<!-- toc -->',
       closingComment: '<!-- tocstop -->',
       isNotitle: true,

__tests__/transform.test.ts

@@ -597,24 +597,24 @@ describe('matchesStart', () => {
   it('should return true', () => {
     expect(matchesStart()('<!-- START doctoc -->')).toBe(true);
     expect(matchesStart()('<!-- START doctoc generated TOC please keep comment here to allow auto update -->')).toBe(true);
-    expect(matchesStart('<!-- test ')('<!-- test abc -->')).toBe(true);
+    expect(matchesStart(['<!-- test '])('<!-- test abc -->')).toBe(true);
   });
 
   it('should return false', () => {
     expect(matchesStart()('<!-- doctoc -->')).toBe(false);
-    expect(matchesStart('<!-- test ')('<!-- START doctoc -->')).toBe(false);
+    expect(matchesStart(['<!-- test '])('<!-- START doctoc -->')).toBe(false);
   });
 });
 
 describe('matchesEnd', () => {
   it('should return true', () => {
     expect(matchesEnd()('<!-- END doctoc -->')).toBe(true);
     expect(matchesEnd()('<!-- END doctoc generated TOC please keep comment here to allow auto update -->')).toBe(true);
-    expect(matchesEnd('<!-- test ')('<!-- test abc -->')).toBe(true);
+    expect(matchesEnd(['<!-- test '])('<!-- test abc -->')).toBe(true);
   });
 
   it('should return false', () => {
     expect(matchesEnd()('<!-- doctoc -->')).toBe(false);
-    expect(matchesEnd('<!-- test ')('<!-- END doctoc -->')).toBe(false);
+    expect(matchesEnd(['<!-- test '])('<!-- END doctoc -->')).toBe(false);
   });
 });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@technote-space/doctoc",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Generates TOC for markdown files of local git repo.",
   "keywords": [
     "github",

src/lib/transform.ts

@@ -12,8 +12,16 @@ import {
 } from '..';
 import {TransformOptions, Header, HeaderWithRepetition, HeaderWithAnchor, SectionInfo, TransformResult} from '../types';
 
-export const matchesStart = (openingComment?: string) => (line: string): boolean => (new RegExp(openingComment ? openingComment : CHECK_OPENING_COMMENT)).test(line);
-export const matchesEnd   = (closingComment?: string) => (line: string): boolean => (new RegExp(closingComment ? closingComment : CHECK_CLOSING_COMMENT)).test(line);
+const getTargetComments = (checkComments: Array<string>, defaultComments: string): Array<string> => {
+  if (checkComments.length) {
+    return checkComments;
+  }
+
+  return [defaultComments];
+};
+
+export const matchesStart = (checkOpeningComments?: Array<string>) => (line: string): boolean => getTargetComments(checkOpeningComments ?? [], CHECK_OPENING_COMMENT).some(comment => new RegExp(comment).test(line));
+export const matchesEnd   = (checkClosingComments?: Array<string>) => (line: string): boolean => getTargetComments(checkClosingComments ?? [], CHECK_CLOSING_COMMENT).some(comment => new RegExp(comment).test(line));
 const addAnchor           = (mode: string | undefined, moduleName: string | undefined, header: HeaderWithRepetition): HeaderWithAnchor => {
   return {
     ...header,
@@ -120,8 +128,8 @@ export const transform = (
     updateOnly,
     openingComment,
     closingComment,
-    checkOpeningComment,
-    checkClosingComment,
+    checkOpeningComments,
+    checkClosingComments,
   }: TransformOptions = {},
 ): TransformResult => {
   mode        = mode || 'github.com';
@@ -131,7 +139,7 @@ export const transform = (
   // eslint-disable-next-line no-magic-numbers
   const maxHeaderLevelHtml = maxHeaderLevel || 4;
   const lines              = content.split('\n');
-  const info: SectionInfo  = updateSection.parse(lines, matchesStart(checkOpeningComment), matchesEnd(checkClosingComment));
+  const info: SectionInfo  = updateSection.parse(lines, matchesStart(checkOpeningComments), matchesEnd(checkClosingComments));
 
   if (!info.hasStart && updateOnly) {
     return {
@@ -185,7 +193,7 @@ export const transform = (
 
   return {
     transformed: true,
-    data: updateSection(lines.join('\n'), wrappedToc, matchesStart(checkOpeningComment), matchesEnd(checkClosingComment), true),
+    data: updateSection(lines.join('\n'), wrappedToc, matchesStart(checkOpeningComments), matchesEnd(checkClosingComments), true),
     toc,
     wrappedToc,
     reason: '',

src/types.ts

@@ -12,8 +12,8 @@ export type TransformOptions = Partial<{
   updateOnly: boolean;
   openingComment: string;
   closingComment: string;
-  checkOpeningComment: string;
-  checkClosingComment: string;
+  checkOpeningComments: Array<string>;
+  checkClosingComments: Array<string>;
 }>
 
 export type FileInfo = {