From a912ebfa8ab71f8e021e4abf6f786f5575db1720 Mon Sep 17 00:00:00 2001 From: Efriandika Pratama Date: Sun, 24 Jul 2022 11:33:33 +0100 Subject: [PATCH] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 68fd514..b046a2f 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Some documented features might not have been published yet, see the [change log] - Run `yalc publish` in your dependency package `my-package`. - It will copy [all the files that should be published in remote NPM registry](https://docs.npmjs.com/files/package.json#files). - If your package has any of these lifecycle scripts: `prepublish`, `prepare`, `prepublishOnly`, `prepack`, `preyalcpublish`, they will run before in this order. If your package has any of these: `postyalcpublish`, `postpack`, `publish`, `postpublish`, they will run after in this order. Use `--no-scripts` to publish without running scripts. -- While copying package content, `yalc` calculates the hash signature of all files and, by default, adds this signature to the package manifest `version`. You can disable this by using the `--no-sig` option. +- While copying package content, `yalc` calculates the hash signature of all files. You can use `--sig` option to add this signature to the package manifest `version` to avoid yarn local package caching. Please read ["yarn probably shouldn't cache packages resolved with a file path"](https://github.com/yarnpkg/yarn/issues/2165) for more details. - You may also use `.yalcignore` to exclude files from publishing to yalc repo, for example, files like README.md, etc. - `--content` flag will show included files in the published package - **NB!** In terms of which files will be included in the package `yalc` fully supposed to emulate behavior of `npm` client (`npm pack`). [If you have nested `.yalc` folder in your package](https://github.com/whitecolor/yalc/issues/95) that you are going to publish with `yalc` and you use `package.json` `files` list, it should be included there explicitly.