chore: document useLocalPackage

snyk · Aug 11, 2021 · aed2812 · aed2812
1 parent 04d18cd
commit aed2812
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/snyk-protect/test/util/useLocalPackage.ts b/packages/snyk-protect/test/util/useLocalPackage.ts
@@ -9,6 +9,13 @@ type PackageJSON = {
 
 const debug = debuglog('@snyk' + __filename);
 
+/**
+ * Modifies the given fixture's package.json to use a locally built
+ * @snyk/protect tarball instead of the one in NPM Registry.
+ *
+ * Typically used via `createProject` to automatically switch between
+ * dev and prod testing.
+ */
 const useLocalPackage = async (projectPath: string) => {
   const workspaceRoot = path.resolve(__dirname, '../..');
   const { stdout: tarballName } = await runCommand('npm', ['pack'], {