✨ Feature: add log file size limit

Author: Molunerfinn

src/lib/Logger.ts

@@ -12,6 +12,7 @@ import {
   ILogger,
   IPicGo
 } from '../types'
+import { forceNumber } from '../utils/common'
 
 export class Logger implements ILogger {
   private readonly level = {
@@ -36,11 +37,50 @@ export class Logger implements ILogger {
       this.logLevel = this.ctx.getConfig('settings.logLevel')
       this.logPath = this.ctx.getConfig<Undefinable<string>>('settings.logPath') || path.join(this.ctx.baseDir, './picgo.log')
       setTimeout(() => {
+        // fix log file is too large, now the log file's default size is 10 MB
+        try {
+          const result = this.checkLogFileIsLarge(this.logPath)
+          if (result.isLarge) {
+            const warningMsg = `Log file is too large (> ${(result.logFileSizeLimit!) / 1024 / 1024 || '10'} MB), recreate log file`
+            console.log(chalk.yellow('[PicGo WARN]:'), warningMsg)
+            this.recreateLogFile(this.logPath)
+            msg.unshift(warningMsg)
+          }
+        } catch (e) {
+          // why???
+          console.error('[PicGo Error] on checking log file size', e)
+        }
         this.handleWriteLog(this.logPath, type, ...msg)
       }, 0)
     }
   }
 
+  private checkLogFileIsLarge (logPath: string): {
+    isLarge: boolean
+    logFileSize?: number
+    logFileSizeLimit?: number
+  } {
+    if (fs.existsSync(logPath)) {
+      const logFileSize = fs.statSync(logPath).size
+      const logFileSizeLimit = forceNumber(this.ctx.getConfig<Undefinable<number>>('settings.logFileSizeLimit') || 10) * 1024 * 1024 // 10 MB default
+      return {
+        isLarge: logFileSize > logFileSizeLimit,
+        logFileSize,
+        logFileSizeLimit
+      }
+    }
+    return {
+      isLarge: false
+    }
+  }
+
+  private recreateLogFile (logPath: string): void {
+    if (fs.existsSync(logPath)) {
+      fs.unlinkSync(logPath)
+      fs.createFileSync(logPath)
+    }
+  }
+
   private handleWriteLog (logPath: string, type: string, ...msg: ILogArgvTypeWithError[]): void {
     try {
       if (this.checkLogLevel(type, this.logLevel)) {
@@ -60,7 +100,7 @@ export class Logger implements ILogger {
         fs.appendFileSync(logPath, log)
       }
     } catch (e) {
-      console.log(e)
+      console.error('[PicGo Error] on writing log file', e)
     }
   }
 

src/plugins/commander/setting.ts

@@ -42,8 +42,8 @@ const setting = {
                       type: 'list',
                       name: `${module}`,
                       choices: ctx.helper[module].getIdList(),
-                      message: `Choose a(n) ${module}`,
-                      default: ctx.getConfig('picBed.uploader') || ctx.getConfig('picBed.current')
+                      message: `Choose a(n) ${module}`
+                      // default: ctx.getConfig('picBed.uploader') || ctx.getConfig('picBed.current')
                     }
                   ]
                   const answer = await ctx.cmd.inquirer.prompt<IStringKeyMap<any>>(prompts)
@@ -84,7 +84,9 @@ const setting = {
                 ctx.log.warn(`No module named ${module}`)
                 return ctx.log.warn('Available modules are uploader|transformer|plugin')
             }
+            const useModuleName = module === 'plugin' ? 'plugins' : module
             ctx.log.success('Configure config successfully!')
+            ctx.log.info(`If you want to use this config, please run 'picgo use ${useModuleName}'`)
           } catch (e: any) {
             ctx.log.error(e)
             if (process.argv.includes('--debug')) {

src/utils/common.ts

@@ -363,3 +363,7 @@ export function safeParse<T> (str: string): T | string {
 // export const isConfigKeyInWhiteList = (key: string): boolean => {
 //   return configWhiteList.some(whiteItem => whiteItem.test(key))
 // }
+
+export const forceNumber = (num: string | number = 0): number => {
+  return isNaN(Number(num)) ? 0 : Number(num)
+}

src/utils/getClipboardImage.ts

@@ -11,6 +11,7 @@ import windowsClipboardScript from './clipboard/windows.ps1'
 import windows10ClipboardScript from './clipboard/windows10.ps1'
 import linuxClipboardScript from './clipboard/linux.sh'
 import wslClipboardScript from './clipboard/wsl.sh'
+import { CLIPBOARD_IMAGE_FOLDER } from './static'
 
 export type Platform = 'darwin' | 'win32' | 'win10' | 'linux' | 'wsl'
 
@@ -56,9 +57,18 @@ const platform2ScriptFilename: {
   wsl: 'wsl.sh'
 }
 
+function createImageFolder (ctx: IPicGo): void {
+  const imagePath = path.join(ctx.baseDir, CLIPBOARD_IMAGE_FOLDER)
+  if (!fs.existsSync(imagePath)) {
+    fs.mkdirSync(imagePath)
+  }
+}
+
 // Thanks to vs-picgo: https://github.com/Spades-S/vs-picgo/blob/master/src/extension.ts
 const getClipboardImage = async (ctx: IPicGo): Promise<IClipboardImage> => {
-  const imagePath = path.join(ctx.baseDir, `${dayjs().format('YYYYMMDDHHmmss')}.png`)
+  createImageFolder(ctx)
+  // add an clipboard image folder to control the image cache file
+  const imagePath = path.join(ctx.baseDir, CLIPBOARD_IMAGE_FOLDER, `${dayjs().format('YYYYMMDDHHmmss')}.png`)
   return await new Promise<IClipboardImage>((resolve: Function, reject: Function): void => {
     const platform = getCurrentPlatform()
     const scriptPath = path.join(ctx.baseDir, platform2ScriptFilename[platform])

src/utils/static.ts

@@ -0,0 +1 @@
+export const CLIPBOARD_IMAGE_FOLDER = 'picgo-clipboard-images'