Merge pull request #10 from technote-space/feature/#9

feat: add title setting (#9)
technote-space · Aug 31, 2019 · 7805a19 · 7805a19
2 parents 119ea80 + 45f2cea
commit 7805a19
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 9 deletions.
diff --git a/.github/workflows/toc.yml b/.github/workflows/toc.yml
@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: TOC Generator
-        uses: technote-space/toc-generator@v0
+        uses: technote-space/toc-generator@v1
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           TARGET_PATHS: 'README.md,.github/CODE_OF_CONDUCT.md,.github/CONTRIBUTING.md'
diff --git a/README.md b/README.md
@@ -16,6 +16,7 @@ Just run [DocToc](https://github.com/thlorenz/doctoc) and commit to branch if ch
 - [Installation](#installation)
 - [Options](#options)
   - [TARGET_PATHS](#target_paths)
+  - [TOC_TITLE](#toc_title)
   - [COMMIT_MESSAGE](#commit_message)
 - [Action event details](#action-event-details)
   - [Target event](#target-event)
@@ -50,6 +51,9 @@ Just run [DocToc](https://github.com/thlorenz/doctoc) and commit to branch if ch
 ### TARGET_PATHS
 Target file path. (Comma separated, [Detail](https://github.com/thlorenz/doctoc#adding-toc-to-individual-files))  
 default: `'README.md'`  
+### TOC_TITLE
+TOC Title.
+default: `'**Table of Contents**'`
 ### COMMIT_MESSAGE
 Commit message.  
 default: `'docs: Update TOC'`  

diff --git a/__tests__/utils/misc.test.ts b/__tests__/utils/misc.test.ts
@@ -1,5 +1,5 @@
 import path from 'path';
-import {getContext, getApiFixture, disableNetConnect, testEnv} from '../util';
+import {getContext, testEnv} from '../util';
 import {
     isTargetEvent,
     getBuildVersion,
@@ -66,15 +66,16 @@ describe('getBuildVersion', () => {
 describe('getDocTocArgs', () => {
     testEnv();
 
-    it('should get default DocToc args', () => {
+    it('should get DocToc args', () => {
         process.env.GITHUB_WORKSPACE = '/tmp/workspace';
-        expect(getDocTocArgs()).toBe('/tmp/workspace/.work/README.md');
+        process.env.INPUT_TARGET_PATHS = 'README.md,.github/CONTRIBUTING.md';
+        process.env.INPUT_TOC_TITLE = '**Table of Contents**';
+        expect(getDocTocArgs()).toBe('/tmp/workspace/.work/README.md /tmp/workspace/.work/.github/CONTRIBUTING.md --title **Table of Contents**');
     });
 
-    it('should get DocToc args', () => {
+    it('should get default DocToc args', () => {
         process.env.GITHUB_WORKSPACE = '/tmp/workspace';
-        process.env.INPUT_TARGET_PATHS = 'README.md,.github/CONTRIBUTING.md';
-        expect(getDocTocArgs()).toBe('/tmp/workspace/.work/README.md /tmp/workspace/.work/.github/CONTRIBUTING.md');
+        expect(getDocTocArgs()).toBe('/tmp/workspace/.work/README.md --notitle');
     });
 });
 

diff --git a/action.yml b/action.yml
@@ -8,6 +8,9 @@ inputs:
   TARGET_PATHS:
     description: Target file path. (Comma separated, @see https://github.com/thlorenz/doctoc#adding-toc-to-individual-files)
     default: 'README.md'
+  TOC_TITLE:
+    description: TOC Title
+    default: '**Table of Contents**'
   COMMIT_MESSAGE:
     description: Commit message.
     default: 'docs: Update TOC'

diff --git a/src/utils/command.ts b/src/utils/command.ts
@@ -40,7 +40,7 @@ const getCurrentBranchName = async (workDir: string): Promise<string> => {
 const runDocToc = async (workDir: string): Promise<boolean> => {
     const args = getDocTocArgs();
     const doctoc = path.resolve(workDir, 'node_modules/.bin/doctoc');
-    await execAsync(`yarn --cwd ${workDir} add doctoc`);
+    await execAsync(`yarn --cwd ${workDir} add doctoc`, false, null, false, true);
     await execAsync(`${doctoc} ${args} --github`);
     return true;
 };

diff --git a/src/utils/misc.ts b/src/utils/misc.ts
@@ -29,9 +29,12 @@ const getTargetPaths = (): string[] => [...new Set<string>((getInput('TARGET_PAT
 
 export const getDocTocArgs = () => {
     const workDir = getWorkDir();
-    return getTargetPaths().map(item => path.resolve(workDir, item)).join(' ');
+    const title = getTocTitle().replace('\'', '\\\'').replace('"', '\\"');
+    return getTargetPaths().map(item => path.resolve(workDir, item)).join(' ') + (title ? ` --title ${title}` : ' --notitle');
 };
 
+const getTocTitle = (): string => getInput('TOC_TITLE') || '';
+
 const getWorkspace = (): string => process.env.GITHUB_WORKSPACE || '';
 
 export const getWorkDir = () => path.resolve(getWorkspace(), '.work');