Only generate manifest if update is specified

BREAKING CHANGE: packwatch will now exit with a non-zero code if run
without an existing manifest file and without the --update-manifest
flag. Now run packwatch --update-manifest to generate a manifest for the
first time.
This commit is contained in:
Michael Rose 2020-03-04 23:44:18 -05:00
parent bc01df6dd9
commit 411c4daa59
2 changed files with 11 additions and 2 deletions

View file

@ -31,7 +31,7 @@ While you can install `packwatch` as a global package, it's better to include it
## Usage ## Usage
`packwatch` tracks your packages' size via its `.packwatch.json` manifest. To get started, call `packwatch` at the root of your project: a fresh manifest will be generated for you using your current package's size as the initial upper limit for package size. `packwatch` tracks your packages' size via its `.packwatch.json` manifest. To get started, call `packwatch --update-manifest` at the root of your project: a fresh manifest will be generated for you using your current package's size as the initial upper limit for package size.
Once a manifest file exists, calling `packwatch` again will compare its data to the current state of your package. Every time `packwatch` compares your code to the manifest, it will update the last reported package size statistics it contains, but not the limit you have set. Once a manifest file exists, calling `packwatch` again will compare its data to the current state of your package. Every time `packwatch` compares your code to the manifest, it will update the last reported package size statistics it contains, but not the limit you have set.

View file

@ -16,7 +16,9 @@ if (!existsSync('package.json')) {
process.exit(1) process.exit(1)
} }
const isUpdatingManifest = process.argv.includes('--update-manifest') const UPDATE_MANIFEST_OPTION = '--update-manifest'
const isUpdatingManifest = process.argv.includes(UPDATE_MANIFEST_OPTION)
const currentStats = getCurrentPackageStats() const currentStats = getCurrentPackageStats()
@ -26,6 +28,13 @@ const currentStats = getCurrentPackageStats()
*/ */
if (!existsSync(MANIFEST_FILENAME)) { if (!existsSync(MANIFEST_FILENAME)) {
if (!isUpdatingManifest) {
console.log(
`🔥🔥📦🔥🔥 No manifest file exists! Run packwatch with ${UPDATE_MANIFEST_OPTION} to generate a manifest file`,
)
process.exit(1)
}
createOrUpdateManifest({ current: currentStats }) createOrUpdateManifest({ current: currentStats })
console.log( console.log(
`📝 No Manifest to compare against! Current package stats written to ${MANIFEST_FILENAME}!`, `📝 No Manifest to compare against! Current package stats written to ${MANIFEST_FILENAME}!`,