Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/azu/file-cache
Node.js library that provide a cache for file metadata or file content.
https://github.com/azu/file-cache
cache library nodejs
Last synced: 11 days ago
JSON representation
Node.js library that provide a cache for file metadata or file content.
- Host: GitHub
- URL: https://github.com/azu/file-cache
- Owner: azu
- License: mit
- Created: 2022-07-10T14:41:59.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-20T11:06:02.000Z (10 months ago)
- Last Synced: 2024-10-28T06:31:59.841Z (16 days ago)
- Topics: cache, library, nodejs
- Language: TypeScript
- Homepage:
- Size: 877 KB
- Stars: 19
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @file-cache
A cache library for file metadata or file content.
It is useful for process that work a given series of files and that only need to repeat the job on the changed ones
since the previous run of the process.
## When to update the cache
- When the source code changes.
- When the source code metadata changes.
- When the dependencies change.
- When the configuration changes.
`@file-cache` package help you to implement `--cache` for your tools.
## Installation
```
npm install @file-cache/core @file-cache/npm
```
## Usage
Do heavy tasks for only changed files.
```js
import { createCache } from "@file-cache/core";
import { createNpmPackageKey } from "@file-cache/npm"
const prettierConfig = {/* ... */ };
const cache = await createCache({
name: "prettier",
// Use hash value of the content for detecting changes
mode: "content", // or "metadata"
// create key for cache
keys: [
// use dependency(version) as cache key
() => createNpmPackageKey(["prettier"]),
// use custom key
() => {
return JSON.stringify(prettierConfig);
}
],
noCache: process.env.NO_CACHE_YOUR_TOOL === "true" // disable cache by the flag
});
const targetFiles = ["a.js", "b.js", "c.js"];
const doHeavyTask = (filePath) => {
// do heavy task
}
for (const targetFile of targetFiles) {
const result = await cache.getAndUpdateCache(targetFile);
if (result.error) {
throw result.error
}
if (!result.changed) {
continue; // no need to update
}
doHeavyTask(targetFile);
}
// write cache state to file for persistence
await cache.reconcile();
```
**Examples:**
- https://github.com/azu/file-cache-demo
**Options:**
See [package/core](packages/core) documentation.
## Advanced Usage
If your tool has a plugin system, you can use [`@file-cache/package-lock`](./packages/package-lock) for caching plugin's dependencies.
This package use `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`, or `bun.lockb` as cache key.
```
npm install @file-cache/core @file-cache/npm @file-cache/package-lock
```
```js
import { createCache } from "@file-cache/core";
import { createNpmPackageKey } from "@file-cache/npm"
import { createPackageLockKey } from "@file-cache/package-lock"
const yourConfig = {/* ... */ };
const cache = await createCache({
name: "your-tool",
// Use hash value of the content for detecting changes
mode: "content", // or "metadata"
// create key for cache
keys: [
// use your tool version as cache key
() => createNpmPackageKey(["your-tool"]),
// use dependency as cache key
() => createPackageLockKey(process.cwd()), // search process.cwd()/package-lock.json
// use config as cache key
() => {
return JSON.stringify(yourConfig);
}
],
noCache: process.env.NO_CACHE_YOUR_TOOL === "true" // disable cache by the flag
});
```
## Cache Mechanism
Cache file directory:
:memo: You can change the directory by `cacheDirectory` option.
```
|- node_modules
|- .cache
|-
|- -
```
- Related: [sindresorhus/find-cache-dir: Finds the common standard cache directory](https://github.com/sindresorhus/find-cache-dir)
Cache file structure:
```markdown
{
"file-path":
}
```
This library does not clean up previous cache files.
When the `` is changed, the previous cache file will not be deleted automatically.
## Users
- [azu/create-validator-ts: Create JSON Schema validator from TypeScript.](https://github.com/azu/create-validator-ts)
## Release flow
npm run versionup:* && npm run release && git add . && git commit -m "update lock" && git push --tags
## Related
- [royriojas/file-entry-cache](https://github.com/royriojas/file-entry-cache)
- Inspired by this project
## License
MIT