code cleanup

Signed-off-by: shmck <[email protected]>

Author: ShMcK

src/build.ts

@@ -1,7 +1,7 @@
-import * as yamlParser from 'js-yaml'
-import * as path from 'path'
-import * as fs from 'fs'
-import * as util from 'util'
+import { load } from 'js-yaml'
+import { join } from 'path'
+import { writeFile, readFile } from 'fs'
+import { promisify } from 'util'
 import { parse } from './utils/parse'
 import { getArg } from './utils/args'
 import { getCommits, CommitLogObject } from './utils/commits'
@@ -11,8 +11,8 @@ import { validateSchema } from './utils/validateSchema'
 import { validateMarkdown } from './utils/validateMarkdown'
 import * as T from '../typings/tutorial'
 
-const write = util.promisify(fs.writeFile)
-const read = util.promisify(fs.readFile)
+const write = promisify(writeFile)
+const read = promisify(readFile)
 
 export type BuildConfigOptions = {
   text: string // text document from markdown
@@ -60,15 +60,15 @@ async function build (args: string[]) {
   }
 
   // path to run build from
-  const localPath = path.join(process.cwd(), options.dir)
+  const localPath = join(process.cwd(), options.dir)
 
   // load markdown and files
   let _markdown: string
   let _yaml: string
   try {
     ;[_markdown, _yaml] = await Promise.all([
-      read(path.join(localPath, options.markdown), 'utf8'),
-      read(path.join(localPath, options.yaml), 'utf8')
+      read(join(localPath, options.markdown), 'utf8'),
+      read(join(localPath, options.yaml), 'utf8')
     ])
   } catch (e) {
     console.error('Error reading file:')
@@ -91,7 +91,7 @@ async function build (args: string[]) {
   // parse yaml skeleton config
   let skeleton
   try {
-    skeleton = yamlParser.load(_yaml) as T.TutorialSkeleton
+    skeleton = load(_yaml) as T.TutorialSkeleton
     if (!skeleton || !Object.keys(skeleton).length) {
       throw new Error(`Skeleton at "${options.yaml}" is invalid`)
     }

src/utils/commits.ts

@@ -1,13 +1,13 @@
-import * as fs from 'fs'
+import { mkdir, exists, rmdir } from 'fs'
 import util from 'util'
 import * as path from 'path'
-import { ListLogSummary } from 'simple-git/typings/response'
+import { LogResult } from 'simple-git/typings/response'
 import gitP, { SimpleGit } from 'simple-git/promise'
 import { validateCommitOrder } from './validateCommits'
 
-const mkdir = util.promisify(fs.mkdir)
-const exists = util.promisify(fs.exists)
-const rmdir = util.promisify(fs.rmdir)
+const mkdirPromise = util.promisify(mkdir)
+const existsPromise = util.promisify(exists)
+const rmdirPromise = util.promisify(rmdir)
 
 type GetCommitOptions = {
   localDir: string
@@ -17,7 +17,7 @@ type GetCommitOptions = {
 export type CommitLogObject = { [position: string]: string[] }
 
 export function parseCommits (
-  logs: ListLogSummary<any>
+  logs: LogResult<any>
 ): { [hash: string]: string[] } {
   // Filter relevant logs
   const commits: CommitLogObject = {}
@@ -78,11 +78,11 @@ export async function getCommits ({
 
   // setup .tmp directory
   const tmpDir = path.join(localDir, '.tmp')
-  const tmpDirExists = await exists(tmpDir)
+  const tmpDirExists = await existsPromise(tmpDir)
   if (tmpDirExists) {
-    await rmdir(tmpDir, { recursive: true })
+    await rmdirPromise(tmpDir, { recursive: true })
   }
-  await mkdir(tmpDir)
+  await mkdirPromise(tmpDir)
 
   const tempGit = gitP(tmpDir)
   await tempGit.clone(localDir, tmpDir)
@@ -115,6 +115,6 @@ export async function getCommits ({
     // revert back to the original branch on failure
     await git.checkout(originalBranch)
     // cleanup the tmp directory
-    await rmdir(tmpDir, { recursive: true })
+    await rmdirPromise(tmpDir, { recursive: true })
   }
 }

src/utils/exec.ts

@@ -1,6 +1,6 @@
 import * as T from '../../typings/tutorial'
 import { exec as cpExec } from 'child_process'
-import * as path from 'path'
+import { join } from 'path'
 import { promisify } from 'util'
 
 const asyncExec = promisify(cpExec)
@@ -50,7 +50,7 @@ export function createCommandRunner (cwd: string) {
         console.log(`--> ${command}`)
         let cwdDir = cwd
         if (dir) {
-          cwdDir = path.join(cwd, dir)
+          cwdDir = join(cwd, dir)
         }
         const { stdout, stderr } = await createExec(cwdDir)(command)
 
@@ -67,7 +67,7 @@ export function createCommandRunner (cwd: string) {
 }
 
 // function isAbsolute(p: string) {
-//   return path.normalize(p + "/") === path.normalize(path.resolve(p) + "/");
+//   return normalize(p + "/") === normalize(resolve(p) + "/");
 // }
 
 export function createTestRunner (cwd: string, config: T.TestRunnerConfig) {
@@ -77,7 +77,7 @@ export function createTestRunner (cwd: string, config: T.TestRunnerConfig) {
 
   let wd = cwd
   if (directory) {
-    wd = path.join(cwd, directory)
+    wd = join(cwd, directory)
   }
 
   const commandWithArgs = `${command} ${args.tap}`

src/validate.ts

@@ -1,6 +1,6 @@
-import * as path from 'path'
-import * as fs from 'fs-extra'
-import * as yamlParser from 'js-yaml'
+import { join } from 'path'
+import { readFile, pathExists, emptyDir } from 'fs-extra'
+import { load } from 'js-yaml'
 import { getArg } from './utils/args'
 import gitP, { SimpleGit } from 'simple-git/promise'
 import {
@@ -19,23 +19,20 @@ interface Options {
 async function validate (args: string[]) {
   // dir - default .
   const dir = !args.length || args[0].match(/^-/) ? '.' : args[0]
-  const localDir = path.join(process.cwd(), dir)
+  const localDir = join(process.cwd(), dir)
 
   // -y --yaml - default coderoad-config.yml
   const options: Options = {
     yaml: getArg(args, { name: 'yaml', alias: 'y' }) || 'coderoad.yaml',
     clean: getArg(args, { name: 'clean', alias: 'c' }) !== 'false'
   }
 
-  const _yaml: string = await fs.readFile(
-    path.join(localDir, options.yaml),
-    'utf8'
-  )
+  const _yaml: string = await readFile(join(localDir, options.yaml), 'utf8')
 
   // parse yaml config
   let skeleton
   try {
-    skeleton = yamlParser.load(_yaml) as TutorialSkeleton
+    skeleton = load(_yaml) as TutorialSkeleton
 
     if (!skeleton) {
       throw new Error('Invalid yaml file contents')
@@ -52,11 +49,11 @@ async function validate (args: string[]) {
   const commits: CommitLogObject = await getCommits({ localDir, codeBranch })
 
   // setup tmp dir
-  const tmpDir = path.join(localDir, '.tmp')
+  const tmpDir = join(localDir, '.tmp')
 
   try {
-    if (!(await fs.pathExists(tmpDir))) {
-      await fs.emptyDir(tmpDir)
+    if (!(await pathExists(tmpDir))) {
+      await emptyDir(tmpDir)
     }
     const tempGit: SimpleGit = gitP(tmpDir)