/yalc

Work with yarn/npm packages locally like a boss.

Primary LanguageTypeScript

Yalc

Better workflow than npm | yarn link for package authors.

Why

When developing and authoring multiple packages (private or public) you often find yourself in a need of using the latest/WIP versions in other projects that you are working on in your local environment without publishing those packages to remote registry. NPM and Yarn address this issue with a similar approach of symlinked packages (npm/yarn link). Though this may work in many cases, it often brings nasty constraints and problems with dependency resolution, symlink interoperability between file systems, etc.

What

  • Yalc acts as very simple local repository for your localy developed packages that you want to share across your local environment.
  • When you run yalc publish in the package directory it grabs only files that should be published to NPM and puts them to special global store (located for example in ~/.yalc).
  • When you run yalc add my-package in your project it pulls package content to .yalc in current folder and injects file:/link: dependency in package.json. Alternatively you may use yalc link my-pakage which will create symlink to package content in node_modules and will not touch package.json (like npm/yarn link does).
  • Yalc creates special yalc.lock file in your project (near yarn.lock and package.json) that be used to ensure consistentcy while performing yalc's routines.
  • Yalc can be used with projects where yarn or npm package managers are used for managing package.json dependencies.

Install

npm (scoped) Build Status

  npm i yalc -g

Usage

Publish

  • Run yalc publish in your dependency package my-package.

  • It will copy all the files that should be published in remote NPM registry, but will not include standard non-code files like README, LICENCE etc (if you need them included please add !LICENCE to .npmignore).

  • It will run preyalc or prepublish scripts before, and postyalc or postpublish after. Use --force to publish without running scripts.

  • NB! Windows users should ensure LF new line symbol is used in published sources, it may be needed for package to work correctly (for example it is must for bin scripts). Yalc won't convert line endings for you (because npm and yarn won't too).

  • While copying package content yalc calculates hash signature of all files and by default adds this signature to package manifest version. You can disable this by using --no-sig option.

  • Easily propagate package updates everywhere.

Add

  • Run yalc add my-package in your dependant project, it will copy current version from store to your project's .yalc folder and inject file:.yalc/my-package dependency in package.json.
  • You may add particular versoin yalc add my-package@version, this version will be fixed in yalc.lock file and while updates it will not update to newly published versions.
  • Use --link option to add link: dependency instead of file:

Link

  • Alternatively to add you may use link operation which should work for you the same way as npm/yarn link does, the only difference is that source for symllink will be not the global link directory but local .yalc folder of your project.
  • After yalc copies package content to .yalc folder it will create symlink: project/.yalc/my-package ==> project/node_modules/my-package. It will not touch package.json in this case.

Update

  • Run yalc update my-package to update the latest version from store.
  • Run yalc update to update all the packages found in yalc.lock.

Remove

  • Run yalc remove my-package, it will remove package info from package.json and yalc.lock
  • Run yalc remove --all to remove all packages from project.

NB! Currenlty yalc copies (or links) added/updated package content to node_modules folder, but it doesn't execute yarn/npm install/update commands after this, so dependencies must be updated manually if necessary.

Advanced usage

Pushing updates automaticaly to all installations

  • When do yalc add/link/update, project's locations where packages added are tracked and saved, thus yalc tries to know where each package from store is being used in your local environment.
  • yalc publish --push will publish package to store and propagate all changes to existing yalc's package installations (will actually do update operation on the location).
  • yalc push - is a use shortcut command for push operation (which will likely become your primarily used command for publication):
    • force options is true by default, so it won't run pre/post scripts (may change this with --no-force flag).

Keep it out of git

  • If you are using yalc'ed modules temporary while development, first add .yalc and yalc.lock to .gitignore.
  • Use yalc link, that won't touch packages.json
  • If you use yalc add it will change package.json, and ads file:/link: dependencies, if you may want to use yalc check in the precommit hook which will check package.json for yalc'ed dependencies and exits with error, if you forgot to remove them.

Keep it in git

  • You may want to keep shared yalc'ed stuff within the projects you are working on and treat it as a part of the project's codebase. This may really simplify management and usage of shared work in progress packages within your projects and help to make things consistent. So, then just do it, keep .yalc folder and yalc.lock in git.
  • Replace it with published versions from remote repository when ready.

Publish/push sub-projects

  • Useful for monorepos (projects with multiple sub-projects/packages): yalc publish package-dir will perform publish operation in nested package` folder of current working dir.

Related links

Licence

WTF.