✨ Add @percy/cli update notice #678
Conversation
| }); | ||
| import('@percy/cli').then( | ||
| async ({ checkForUpdate, percy }) => { | ||
| await checkForUpdate(); |
There was a problem hiding this comment.
Such a nice implementation
| import pkg from '../package.json'; | ||
|
|
||
| // filepath where the cache will be read and written to | ||
| const CACHE_FILE = path.join(__dirname, '..', '.releases'); |
There was a problem hiding this comment.
Any reason to not make this a json file? Would avoid having to stringify and parse it. I was annoyed doing that in the UI & localStorage
There was a problem hiding this comment.
That would not avoid having to stringify, since writeFile still needs a string or buffer.
As for reading and parsing, If you're implying to lean on require, that will not work in native ES modules (once we're there). The Node documentation recommends using fs like we're doing here, or we could add extra code to enable traditional require functionality.
import { createRequire } from 'module';
const require = createRequire(import.meta.url);
// ...
let { releases, createdAt } = require('./releases.json');Since it's recommended to explicitly read and parse JSON files anyway, I don't see a reason to add .json to the file name in this case.
What is this?
This PR adds an update notice when it detects a newer version of the CLI is available.
Before parsing command-line arguments, releases are requested from GitHub's API and compared against the currently installed CLI's version.
Releases are cached for 3 days before being re-requested, with fallbacks in place so the check still happens if there are errors when reading or writing to the cache file.
The
mockfstest helper was updated to support a betterspyOnsyntax formemfs.fsmethods and also automatically mock the current working directory.