feat: support --cache-directory

README.md

@@ -56,6 +56,7 @@ name | type | description
 `--no-detail-when-failed` | boolean? | not show detail message when the CLI failed(Added in `v2.19`)(Use `--no-detail-when-failed=true` to enable it <https://github.com/plantain-00/type-coverage/issues/113>)
 `--report-semantic-error` | boolean? | report typescript semantic error(Added in `v2.22`)
 `-- file1.ts file2.ts ...` | string[]? | only checks these files, useful for usage with tools like `lint-staged`(Added in `v2.23`)
+`--cache-directory` | string? | [set cache directory](#enable-cache)(Added in `v2.24`)
 
 ### strict mode
 
@@ -69,7 +70,7 @@ Also, future minor release may introduce stricter type check in this mode, which
 
 ### enable cache
 
-save and reuse type check result of files that is unchanged and independent of changed files in `.type-coverage` directory, to improve speed
+save and reuse type check result of files that is unchanged and independent of changed files in `.type-coverage` directory(or set by `--cache-directory`), to improve speed
 
 ### ignore catch
 
@@ -122,6 +123,7 @@ This tool will ignore the files, eg: `--ignore-files "demo1/*.ts" --ignore-files
     "historyFile": "typecoverage.json", // same as --history-file (Added in `v2.18`)
     "noDetailWhenFailed": true, // same as --no-detail-when-failed (Added in `v2.19`)
     "reportSemanticError": true, // same as --report-semantic-error (Added in `v2.22`)
+    "cacheDirectory": "custom-directory", // same as --cache-directory (Added in `v2.24`)
   },
 ```
 
@@ -204,6 +206,7 @@ export interface LintOptions {
   ignoreObject: boolean // Added in v2.21
   ignoreEmptyType: boolean // Added in v2.21
   reportSemanticError: boolean // Added in v2.22
+  cacheDirectory: string // Added in v2.24
 }
 
 export interface FileTypeCheckResult {

packages/cli/src/index.ts

@@ -42,6 +42,7 @@ function printHelp() {
 --no-detail-when-failed     boolean?  not show detail message when the CLI failed
 --report-semantic-error     boolean?  report typescript semantic error
 -- file1.ts file2.ts ...    string[]? only checks these files, useful for usage with tools like lint-staged
+--cache-directory           string?   set cache directory
   `)
 }
 
@@ -81,6 +82,7 @@ interface CliArgs extends BaseArgs {
   ['update-if-higher']: boolean
 
   ['report-semantic-error']: boolean
+  ['cache-directory']: string
 }
 
 interface PkgArgs extends BaseArgs {
@@ -101,6 +103,7 @@ interface PkgArgs extends BaseArgs {
   noDetailWhenFailed: boolean
   updateIfHigher: boolean
   reportSemanticError: boolean
+  cacheDirectory: string
 }
 
 interface PackageJson {
@@ -146,6 +149,7 @@ async function executeCommandLine() {
     historyFile,
     noDetailWhenFailed,
     reportSemanticError,
+    cacheDirectory,
   } = await getTarget(argv);
 
   const { correctCount, totalCount, anys } = await lint(project, {
@@ -162,6 +166,7 @@ async function executeCommandLine() {
       ignoreObject,
       ignoreEmptyType,
       reportSemanticError,
+      cacheDirectory,
       files: argv['--'].length > 0 ? argv['--'] : undefined,
   });
 
@@ -247,6 +252,7 @@ async function getTarget(argv: CliArgs) {
     const historyFile = getArgOrCfgVal(['history-file', 'historyFile'])
     const noDetailWhenFailed = getArgOrCfgVal(['no-detail-when-failed', 'noDetailWhenFailed'])
     const reportSemanticError = getArgOrCfgVal(['report-semantic-error', 'reportSemanticError'])
+    const cacheDirectory = getArgOrCfgVal(['cache-directory', 'cacheDirectory'])
 
     return {
       atLeast,
@@ -271,6 +277,7 @@ async function getTarget(argv: CliArgs) {
       historyFile,
       noDetailWhenFailed,
       reportSemanticError,
+      cacheDirectory,
     };
 }
 

packages/core/src/cache.ts

@@ -17,12 +17,12 @@ function calculateHash(str: string): string {
   return createHash('sha1').update(str).digest('hex')
 }
 
-export async function saveCache(typeCheckResult: TypeCheckResult) {
-  await mkdirIfmissing()
+export async function saveCache(typeCheckResult: TypeCheckResult, dirName = defaultDirName) {
+  await mkdirIfmissing(dirName)
   await writeFileAsync(path.resolve(dirName, 'result.json'), JSON.stringify(typeCheckResult, null, 2))
 }
 
-const dirName = '.type-coverage'
+const defaultDirName = '.type-coverage'
 
 function statAsync(p: string) {
   return new Promise<fs.Stats | undefined>((resolve) => {
@@ -36,14 +36,14 @@ function statAsync(p: string) {
   })
 }
 
-async function mkdirIfmissing() {
+async function mkdirIfmissing(dirName = defaultDirName) {
   const stats = await statAsync(dirName)
   if (!stats) {
     await mkdirAsync(dirName)
   }
 }
 
-export async function readCache(enableCache: boolean): Promise<TypeCheckResult> {
+export async function readCache(enableCache: boolean, dirName = defaultDirName): Promise<TypeCheckResult> {
   if (!enableCache) {
     return {
       cache: {}

packages/core/src/core.ts

@@ -29,7 +29,7 @@ export async function lint(project: string, options?: Partial<LintOptions>) {
 
   const allFiles = new Set<string>()
   const sourceFileInfos: SourceFileInfo[] = []
-  const typeCheckResult = await readCache(lintOptions.enableCache)
+  const typeCheckResult = await readCache(lintOptions.enableCache, lintOptions.cacheDirectory)
   const ignoreFileGlobs = lintOptions.ignoreFiles
     ? (typeof lintOptions.ignoreFiles === 'string'
       ? [lintOptions.ignoreFiles]
@@ -186,7 +186,7 @@ export async function lint(project: string, options?: Partial<LintOptions>) {
   }
 
   if (lintOptions.enableCache) {
-    await saveCache(typeCheckResult)
+    await saveCache(typeCheckResult, lintOptions.cacheDirectory)
   }
 
   return { correctCount, totalCount, anys, program, fileCounts }

packages/core/src/interfaces.ts

@@ -45,6 +45,7 @@ export interface LintOptions extends CommonOptions {
   fileCounts: boolean,
   absolutePath?: boolean,
   reportSemanticError: boolean
+  cacheDirectory?: string
 }
 
 interface CommonOptions {