refactor: rename variable, function, interface

Author: exuanbo

__tests__/index.test.ts

@@ -1,19 +1,19 @@
-import * as cp from 'child_process'
-import * as path from 'path'
+import { execSync } from 'child_process'
+import path from 'path'
 import dotenv from 'dotenv'
-import { getInputs } from '../src/inputs'
+import { getInput } from '../src/inputs'
 
 test('input', () => {
-  process.env.INPUT_GIST_ID = 'test_gist_id'
-  process.env.INPUT_GIST_FILE_NAME = 'test_gist_file_name'
-  process.env.INPUT_FILE_PATH = 'test_file_path'
+  process.env.INPUT_GIST_ID = 'gist_id'
+  process.env.INPUT_GIST_FILE_NAME = 'gist_file_name'
+  process.env.INPUT_FILE_PATH = 'file_path'
 
-  const inp = getInputs()
+  const input = getInput()
 
-  expect(inp.Token).toMatch('')
-  expect(inp.GistID).toMatch('test_gist_id')
-  expect(inp.GistFileName).toMatch('test_gist_file_name')
-  expect(inp.FilePath).toMatch('test_file_path')
+  expect(input.Token).toMatch('')
+  expect(input.GistID).toMatch('gist_id')
+  expect(input.GistFileName).toMatch('gist_file_name')
+  expect(input.FilePath).toMatch('file_path')
 })
 
 test('run', () => {
@@ -23,6 +23,6 @@ test('run', () => {
   process.env.INPUT_GIST_FILE_NAME = 'foo.bar'
   process.env.INPUT_FILE_PATH = '__tests__/foo.bar'
 
-  const ip = path.join(__dirname, '..', 'lib', 'index.js')
-  cp.execSync(`node ${ip}`, { env: process.env })
+  const filePath = path.join(__dirname, '..', 'lib', 'index.js')
+  execSync(`node ${filePath}`, { env: process.env })
 })

src/inputs.ts

@@ -1,27 +1,23 @@
 import * as core from '@actions/core'
 
-export interface Inputs {
+export interface Input {
   readonly Token: string
   readonly GistID: string
   readonly GistFileName?: string
   readonly FilePath: string
 }
 
-export const showInputs = (inp: Inputs): void => {
+export const showInput = (input: Input): void => {
   core.info(`\
-[INFO] GistID: ${inp.GistID}
-[INFO] GistFileName: ${inp.GistFileName ?? 'No Change'}
-[INFO] FilePath: ${inp.FilePath}
+[INFO] GistID: ${input.GistID}
+[INFO] GistFileName: ${input.GistFileName ?? 'No Change'}
+[INFO] FilePath: ${input.FilePath}
 `)
 }
 
-export const getInputs = (): Inputs => {
-  const inp: Inputs = {
-    Token: core.getInput('token'),
-    GistID: core.getInput('gist_id'),
-    GistFileName: core.getInput('gist_file_name'),
-    FilePath: core.getInput('file_path')
-  }
-
-  return inp
-}
+export const getInput = (): Input => ({
+  Token: core.getInput('token'),
+  GistID: core.getInput('gist_id'),
+  GistFileName: core.getInput('gist_file_name'),
+  FilePath: core.getInput('file_path')
+})

src/run.ts

@@ -2,32 +2,32 @@ import fs from 'fs'
 import path from 'path'
 import * as core from '@actions/core'
 import * as github from '@actions/github'
-import { showInputs, getInputs } from './inputs'
+import { showInput, getInput } from './inputs'
 
 export const run = async (): Promise<void> => {
-  const inp = getInputs()
-  showInputs(inp)
+  const input = getInput()
+  showInput(input)
 
   core.startGroup('Read file content')
   const workSpace = process.env.GITHUB_WORKSPACE as string
-  const filepath = path.join(workSpace, inp.FilePath)
-  const content = fs.readFileSync(filepath, 'utf-8')
-  core.info(`[INFO] Done with file "${filepath}"`)
+  const filePath = path.join(workSpace, input.FilePath)
+  const content = fs.readFileSync(filePath, 'utf-8')
+  core.info(`[INFO] Done with file "${filePath}"`)
   core.endGroup()
 
   core.startGroup('Deploy to gist')
-  const octokit = github.getOctokit(inp.Token)
-  const filename = inp.GistFileName ?? path.basename(filepath)
+  const octokit = github.getOctokit(input.Token)
+  const fileName = input.GistFileName ?? path.basename(filePath)
   await octokit.gists.update({
-    gist_id: inp.GistID,
+    gist_id: input.GistID,
     files: {
-      [filename]: {
-        filename,
+      [fileName]: {
+        fileName,
         content
       }
     }
   })
-  core.info(`[INFO] Done with gist "${inp.GistID}/${filename}"`)
+  core.info(`[INFO] Done with gist "${input.GistID}/${fileName}"`)
   core.endGroup()
 
   core.info('[INFO] Action successfully completed')