chore: tweaks

technote-space · technote-space · commit 0f70d72741e3 · 2022-06-22T17:46:14.000+09:00
diff --git a/__tests__/file.test.ts b/__tests__/file.test.ts
@@ -1,7 +1,7 @@
 /* eslint-disable no-magic-numbers */
 import { describe, expect, it, vi } from 'vitest';
-import {resolve} from 'path';
-import {findMarkdownFiles} from '../src';
+import { resolve } from 'path';
+import { findMarkdownFiles } from '../src';
 
 describe('findMarkdownFiles', () => {
   it('should find markdown files', () => {
diff --git a/__tests__/params.test.ts b/__tests__/params.test.ts
@@ -1,7 +1,7 @@
 /* eslint-disable no-magic-numbers */
 import { describe, expect, it } from 'vitest';
-import {extractParams, getStartSection, getParamsSection} from '../src/lib/params';
-import {CLOSING_COMMENT, OPENING_COMMENT} from '../src';
+import { extractParams, getStartSection, getParamsSection } from '../src/lib/params';
+import { CLOSING_COMMENT, OPENING_COMMENT } from '../src';
 
 describe('extractParams', () => {
   const opening = OPENING_COMMENT.replace('\n', ' ');
diff --git a/__tests__/transform-custom-mode.test.ts b/__tests__/transform-custom-mode.test.ts
@@ -1,13 +1,13 @@
 /* eslint-disable no-magic-numbers */
 import { describe, expect, it } from 'vitest';
-import {resolve} from 'path';
-import {readFileSync} from 'fs';
-import {transform} from '../src';
+import { resolve } from 'path';
+import { readFileSync } from 'fs';
+import { transform } from '../src';
 
 describe('transform', () => {
   it('run in html mode', () => {
     const content = readFileSync(resolve(__dirname, 'fixtures/readme-with-html.md'), 'utf8');
-    const headers = transform(content, {mode: 'github.com', isCustomMode: true});
+    const headers = transform(content, { mode: 'github.com', isCustomMode: true });
 
     expect(headers.toc.split('\n')).toEqual(
       ['**Table of Contents**  *generated with [DocToc](https://github.com/technote-space/doctoc)*',
diff --git a/__tests__/transform-footer.test.ts b/__tests__/transform-footer.test.ts
@@ -1,13 +1,13 @@
 /* eslint-disable no-magic-numbers */
 import { describe, expect, it } from 'vitest';
-import {resolve} from 'path';
-import {readFileSync} from 'fs';
-import {transform} from '../src';
+import { resolve } from 'path';
+import { readFileSync } from 'fs';
+import { transform } from '../src';
 
 describe('transform', () => {
   it('add footer', () => {
     const content = readFileSync(resolve(__dirname, 'fixtures/readme-with-custom-title.md'), 'utf8');
-    const headers = transform(content, {title: '## Table of Contents', footer: '*generated with [TOC Generator](https://github.com/technote-space/toc-generator)*'});
+    const headers = transform(content, { title: '## Table of Contents', footer: '*generated with [TOC Generator](https://github.com/technote-space/toc-generator)*' });
 
     expect(headers.toc.split('\n')).toEqual(
       ['## Table of Contents',
diff --git a/__tests__/transform-html.test.ts b/__tests__/transform-html.test.ts
@@ -1,13 +1,13 @@
 /* eslint-disable no-magic-numbers */
 import { describe, expect, it } from 'vitest';
-import {resolve} from 'path';
-import {readFileSync} from 'fs';
-import {transform} from '../src';
+import { resolve } from 'path';
+import { readFileSync } from 'fs';
+import { transform } from '../src';
 
 describe('transform', () => {
   it('given a file that includes html with header tags and maxHeaderLevel 8', () => {
     const content = readFileSync(resolve(__dirname, 'fixtures/readme-with-html.md'), 'utf8');
-    const headers = transform(content, {mode: 'github.com', maxHeaderLevel: 8});
+    const headers = transform(content, { mode: 'github.com', maxHeaderLevel: 8 });
 
     expect(headers.toc.split('\n')).toEqual(
       ['**Table of Contents**  *generated with [DocToc](https://github.com/technote-space/doctoc)*',
diff --git a/__tests__/transform-nested-markdown.test.ts b/__tests__/transform-nested-markdown.test.ts
@@ -1,8 +1,8 @@
 /* eslint-disable no-magic-numbers */
 import { describe, expect, it } from 'vitest';
-import {resolve} from 'path';
-import {readFileSync} from 'fs';
-import {transform} from '../src';
+import { resolve } from 'path';
+import { readFileSync } from 'fs';
+import { transform } from '../src';
 
 describe('transform', () => {
   it('\nhandle inline links and images', () => {
diff --git a/__tests__/transform-not-transformed.test.ts b/__tests__/transform-not-transformed.test.ts
@@ -1,13 +1,13 @@
 /* eslint-disable no-magic-numbers */
 import { describe, expect, it } from 'vitest';
-import {resolve} from 'path';
-import {readFileSync} from 'fs';
-import {transform} from '../src';
+import { resolve } from 'path';
+import { readFileSync } from 'fs';
+import { transform } from '../src';
 
 describe('transform', () => {
   it('update only', () => {
     const content = readFileSync(resolve(__dirname, 'fixtures/readme-update-only.md'), 'utf8');
-    const headers = transform(content, {updateOnly: true});
+    const headers = transform(content, { updateOnly: true });
 
     expect(headers.transformed).toBe(false);
     expect(headers.reason).toBe('update only');
diff --git a/__tests__/transform-override-params.test.ts b/__tests__/transform-override-params.test.ts
@@ -1,13 +1,13 @@
 /* eslint-disable no-magic-numbers */
 import { describe, expect, it } from 'vitest';
-import {resolve} from 'path';
-import {readFileSync} from 'fs';
-import {transform} from '../src';
+import { resolve } from 'path';
+import { readFileSync } from 'fs';
+import { transform } from '../src';
 
 describe('transform', () => {
   it('override params (empty toc)', () => {
     const content = readFileSync(resolve(__dirname, 'fixtures/readme-with-params1.md'), 'utf8');
-    const headers = transform(content, {isNotitle: true, isFolding: false, maxHeaderLevel: 1, entryPrefix: '*'});
+    const headers = transform(content, { isNotitle: true, isFolding: false, maxHeaderLevel: 1, entryPrefix: '*' });
 
     expect(headers.wrappedToc.split('\n')).toEqual(
       [
@@ -37,7 +37,7 @@ describe('transform', () => {
 
   it('override params (not empty toc)', () => {
     const content = readFileSync(resolve(__dirname, 'fixtures/readme-with-params2.md'), 'utf8');
-    const headers = transform(content, {isNotitle: true, isFolding: false, maxHeaderLevel: 1, entryPrefix: '*', footer: 'footer'});
+    const headers = transform(content, { isNotitle: true, isFolding: false, maxHeaderLevel: 1, entryPrefix: '*', footer: 'footer' });
 
     expect(headers.wrappedToc.split('\n')).toEqual(
       [
@@ -70,7 +70,7 @@ describe('transform', () => {
 
   it('not override params', () => {
     const content = readFileSync(resolve(__dirname, 'fixtures/readme-with-params1.md'), 'utf8');
-    const headers = transform(content, {isFolding: true, title: 'Test title'});
+    const headers = transform(content, { isFolding: true, title: 'Test title' });
 
     expect(headers.wrappedToc.split('\n')).toEqual(
       [
diff --git a/__tests__/transform-title.test.ts b/__tests__/transform-title.test.ts
@@ -1,13 +1,13 @@
 /* eslint-disable no-magic-numbers */
 import { describe, expect, it } from 'vitest';
-import {resolve} from 'path';
-import {readFileSync} from 'fs';
-import {transform} from '../src';
+import { resolve } from 'path';
+import { readFileSync } from 'fs';
+import { transform } from '../src';
 
 describe('transform', () => {
   it('overwrite existing title', () => {
     const content = readFileSync(resolve(__dirname, 'fixtures/readme-with-custom-title.md'), 'utf8');
-    const headers = transform(content, {title: '## Table of Contents'});
+    const headers = transform(content, { title: '## Table of Contents' });
 
     expect(headers.toc.split('\n')).toEqual(
       ['## Table of Contents',
@@ -35,7 +35,7 @@ describe('transform', () => {
 
   it('clobber existing title', () => {
     const content = readFileSync(resolve(__dirname, 'fixtures/readme-with-custom-title.md'), 'utf8');
-    const headers = transform(content, {isNotitle: true});
+    const headers = transform(content, { isNotitle: true });
 
     expect(headers.toc.split('\n')).toEqual(
       ['',
diff --git a/__tests__/transform-weird-headers.test.ts b/__tests__/transform-weird-headers.test.ts
@@ -1,8 +1,8 @@
 /* eslint-disable no-magic-numbers */
 import { describe, expect, it } from 'vitest';
-import {resolve} from 'path';
-import {readFileSync} from 'fs';
-import {transform} from '../src';
+import { resolve } from 'path';
+import { readFileSync } from 'fs';
+import { transform } from '../src';
 
 describe('transform', () => {
   it('given a file with edge-case header names', () => {
diff --git a/__tests__/transform.test.ts b/__tests__/transform.test.ts
@@ -1,8 +1,8 @@
 /* eslint-disable no-magic-numbers */
 import { describe, expect, it } from 'vitest';
-import {transform} from '../src';
-import {getLinesToToc, matchesStart, matchesEnd} from '../src/lib/transform';
-import {OPENING_COMMENT, CLOSING_COMMENT} from '../src';
+import { transform } from '../src';
+import { getLinesToToc, matchesStart, matchesEnd } from '../src/lib/transform';
+import { OPENING_COMMENT, CLOSING_COMMENT } from '../src';
 
 const check = (
   name: string,
@@ -500,7 +500,7 @@ describe('transform', () => {
       '',
     ].join('\n');
 
-    const res = transform(md, {processAll: true});
+    const res = transform(md, { processAll: true });
 
     expect(res.transformed).toBe(true);
     expect(res.toc.split('\n')).toEqual(
diff --git a/__tests__/utils.test.ts b/__tests__/utils.test.ts
@@ -1,13 +1,13 @@
 /* eslint-disable no-magic-numbers */
 import { describe, expect, it } from 'vitest';
-import {replaceVariables} from '../src/lib/utils';
+import { replaceVariables } from '../src/lib/utils';
 
 describe('replaceVariables', () => {
   it('should replace variables', () => {
     expect(replaceVariables('', [])).toBe('');
     expect(replaceVariables('abc/${test1}/${test2}/${test1}/xyz', [
-      {key: 'test1', replace: '1'},
-      {key: 'test3', replace: '3'},
+      { key: 'test1', replace: '1' },
+      { key: 'test3', replace: '3' },
     ])).toBe('abc/1/${test2}/1/xyz');
   });
 });
diff --git a/src/index.ts b/src/index.ts
@@ -1,5 +1,5 @@
-export {findMarkdownFiles} from './lib/file';
-export {transform} from './lib/transform';
+export { findMarkdownFiles } from './lib/file';
+export { transform } from './lib/transform';
 export {
   OPENING_COMMENT,
   CLOSING_COMMENT,
diff --git a/src/lib/file.ts b/src/lib/file.ts
@@ -1,7 +1,7 @@
 import path from 'path';
 import fs from 'fs';
-import {FileInfo, FileAndDirs} from '../types';
-import {MARKDOWN_EXTENSIONS, IGNORED_DIRS} from '..';
+import { FileInfo, FileAndDirs } from '../types';
+import { MARKDOWN_EXTENSIONS, IGNORED_DIRS } from '..';
 
 const separateFilesAndDirs = (fileInfos: Array<FileInfo>): FileAndDirs => ({
   directories: fileInfos.filter(info => info.stat.isDirectory() && !IGNORED_DIRS.includes(info.name)),
diff --git a/src/lib/get-html-headers.ts b/src/lib/get-html-headers.ts
@@ -1,6 +1,6 @@
 import * as htmlparser from 'htmlparser2';
 import * as md from '@textlint/markdown-to-ast';
-import {HeaderData, Header} from '../types';
+import { HeaderData, Header } from '../types';
 
 const addLinenos = (lines: Array<string>, headers: Array<HeaderData>): Array<Omit<Header, 'rank'> & HeaderData> => {
   let current = 0;
@@ -73,11 +73,11 @@ export const getHtmlHeaders = (lines: Array<string>, maxHeaderLevel: number): Ar
       // eslint-disable-next-line no-magic-numbers
       if (grabbing[grabbing.length - 1] === name) {
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        headers.push({text: [...text], tag: grabbing.pop()!});
+        headers.push({ text: [...text], tag: grabbing.pop()! });
         text.length = 0;
       }
     },
-  }, {decodeEntities: true});
+  }, { decodeEntities: true });
 
   parser.write(source);
   parser.end();
diff --git a/src/lib/params.ts b/src/lib/params.ts
@@ -1,4 +1,4 @@
-import {SectionInfo, TransformOptions} from '../types';
+import { SectionInfo, TransformOptions } from '../types';
 
 const getBoolValue = (input: string): boolean => !['false', '0', '', 'no', 'n'].includes(input.trim().toLowerCase());
 const converter    = {
@@ -43,7 +43,7 @@ export const extractParams = (section: string): TransformOptions => Object.assig
 ).filter(
   (items): items is Array<string> => items !== null && items[1] in converter,
 ).map(
-  items => ({[items[1]]: converter[items[1]](items[2])}),
+  items => ({ [items[1]]: converter[items[1]](items[2]) }),
 ) ?? []));
 
 export const getParamsSection = (options: TransformOptions): string => {
diff --git a/src/lib/transform.ts b/src/lib/transform.ts
@@ -1,11 +1,11 @@
-import type {TxtNode} from '@textlint/ast-node-types';
-import type {TransformOptions, Header, HeaderWithRepetition, HeaderWithAnchor, SectionInfo, TransformResult} from '../types';
-import {anchor, getUrlHash} from '@technote-space/anchor-markdown-header';
+import type { TxtNode } from '@textlint/ast-node-types';
+import type { TransformOptions, Header, HeaderWithRepetition, HeaderWithAnchor, SectionInfo, TransformResult } from '../types';
+import { anchor, getUrlHash } from '@technote-space/anchor-markdown-header';
 import updateSection from 'update-section';
 import * as md from '@textlint/markdown-to-ast';
-import {getHtmlHeaders} from './get-html-headers';
-import {getStartSection, extractParams, getParamsSection} from './params';
-import {replaceVariables} from './utils';
+import { getHtmlHeaders } from './get-html-headers';
+import { getStartSection, extractParams, getParamsSection } from './params';
+import { replaceVariables } from './utils';
 import {
   OPENING_COMMENT,
   CLOSING_COMMENT,
@@ -141,8 +141,8 @@ const getHtmlHeaderContents = (headers: Array<HeaderWithAnchor>, lowestRank: num
 
 const getHeaderItemHtml = (header: HeaderWithAnchor, itemTemplate: string | undefined): string => {
   return replaceVariables(itemTemplate ?? DEFAULT_ITEM_TEMPLATE, [
-    {key: 'LINK', replace: `#${header.hash}`},
-    {key: 'TEXT', replace: header.name},
+    { key: 'LINK', replace: `#${header.hash}` },
+    { key: 'TEXT', replace: header.name },
   ]);
 };
 
@@ -208,10 +208,10 @@ export const transform = (
       itemTemplate,
       separator,
       footer,
-    }                    = {...options, ...extractedOptions};
+    }                    = { ...options, ...extractedOptions };
 
   if (!info.hasStart && updateOnly) {
-    return getResult({transformed: false, reason: 'update only'});
+    return getResult({ transformed: false, reason: 'update only' });
   }
 
   const _mode        = mode || 'github.com';
@@ -237,7 +237,7 @@ export const transform = (
   const toc         = buildToc(isCustomMode, inferredTitle, linkedHeaders, lowestRank, customTemplate, itemTemplate, separator, indentation, _entryPrefix, footer);
   const wrappedToc  = (openingComment ?? OPENING_COMMENT) + getParamsSection(extractedOptions) + '\n' + wrapToc(toc, inferredTitle, isFolding) + '\n' + (closingComment ?? CLOSING_COMMENT);
   if (currentToc === wrappedToc) {
-    return getResult({transformed: false, reason: 'not updated'});
+    return getResult({ transformed: false, reason: 'not updated' });
   }
 
   return getResult({
diff --git a/src/types.ts b/src/types.ts
@@ -1,4 +1,4 @@
-import {Stats} from 'fs';
+import { Stats } from 'fs';
 
 export type TransformOptions = Partial<{
   mode: string;
