fyn makes your disk a npm registry. Code, publish, and test all your packages using local copies directly.
It is a super fast node package manager with some unique features to improve productivity and efficiency:
- enhanced npm link with fynlocal mode
- efficient disk space usage with central storage
node_moduleswith guaranteed single copy of a package
- flexible dependencies lock by using a lock time stamp
- built-in support for maintaining a mono-repo project
- and more
Interested in giving it a quick test? Just install and run it on your project:
npm i -g fyn cd <your-project> fyn
Want to add a package on your local disk as a dependency to your project? Do this:
fyn add ../another-package
To see detailed stats about any package, use the
fyn stat lodash
- It can read and use some settings from your
- It can use
Want to find out more? Please read on below:
Table Of Contents
- Easier Debugging
- Using fyn
- Configuring fyn
- Other Info
- Focus on improving workflow and productivity.
- Very comprehensive and proper handling of
- A new
Guaranteed single copy of a package => smaller
- The best at installing and linking local packages - better npm link.
- Install local packages like they are published (
- Works particularly well with lerna monorepos.
- Shows detailed stats of your dependencies.
- Efficient disk space usage with optional central storage.
- Central storage mode is fast (and very fast on Linux) once cache is hot.
- Install dependencies with a time stamp lock.
- A super fast node package manager for installing modules.
- Production quality with a lot of unit tests and verified on real applications.
- 100% compatible with Node.js and its ecosystem.
- A flat and simple dependency lock file that can be diffed and edited.
- Always deterministic
- Compatible with npm by internally using the same modules as npm.
- Maintains as much of npm's behaviors as possible.
- Able to use npm's
- built-in support for maintaining a mono-repo workspace.
fyn is the result of a long pursuit to make developing and managing large and complex software in Node.js easier. To realize that, it ultimately ends up being a node package manager.
It started out as small experiments for a single goal of better local package installing and linking, ie: better npm link, but has gradually grown to a fully functional node package manager for the [flat node_modules design]. It is fast, production quality, and maintains 100% compatibility.
While it has all the bells and whistles to make it an extremely fast and efficient package manager, it's not just another npm.
It comes with two unique features that are very useful when you are working on a large Node.js application that consists of many packages.
So why would you want to use this?
node_modules structure is the smallest possible in size because there are no multiple copies of the exact same package installed.
It also has a special
fynlocal mode that's a better npm link for handling local packages.
It's workspace aware and fits perfectly with the mono-repo concept.
fyn has a
fynlocal mode that's designed specifically to be a much better npm link. It effectively makes your disk a npm registry by treating packages on your local disk like they've been published. You can install and use them directly, and quickly test changes iteratively. It fits perfectly with the mono-repo workspace concept. It would be very useful if you've ever done any of these:
- Debug your application by inspecting code inside
- Live edit your package that's installed to
node_modules, and then have to copy the changes out to commit.
- Use lerna to maintain and develop multiple packages.
fynworks particularly well with a lerna repo.
- Or just have to juggle a lot of packages as part of your development.
What is this? Think npm link, but better.
fyn subjects local packages to the same dependency resolution logic as those from the npm registry. Then you can test changes to any module locally as if they were published, which basically makes your disk a npm registry.
To enable, use the path to your local modules as semver in your package.json, or you can use the
fyn add command.
fyn add ../my-awesome-module
That will install
my-awesome-module into your node_modules. You can continue to develop and test
my-awesome-module in its own directory and have the changes within existing files reflected in your app directly. Unlike
npm link, your app resolves dependencies for
my-awesome-module instead of relying on having them installed under
If you add/remove files/directories in your local package, then running
fyn install would take only seconds to update.
fyn will also save a file
package-fyn.json with local dependencies in a section called
fyn. You should not commit this file and
fyn will automatically check this file when installing, but you can turn off
fynlocal mode with with the flag
As a package manager,
fyn employs a different approach that installs only one copy of every required versions of a package in a flat node_modules structure. Hence the name
fyn, which stands for Flatten Your Node_modules.
It installs a copy of each version under the directory
node_modules/.f/_/<package_name>/<version>. And it uses symlink to hoist a single version to
node_modules for visibility. A package may have their own
node_modules to resolve version differences.
This approach has the benefit of guaranteeing a single copy of a package installed and therefore slightly smaller size
With a guaranteed single copy of a package, it makes debugging easier when you have to reach into code under
node_modules installed by npm could potentially have multiple copies of an identical package. So even if you've identified the module under
node_modules to investigate your issue, you may still need to figure which copy.
node_modules design, there is only one copy of any version so it's easier for you to set your breakpoint.
fyn to your Node.js setup globally.
npm install -g fyn
Installing Your Dependencies
Change into the directory for your project with the
package.json file, and run:
- Which is a shorthand for
installis the default command.
Depending on the size of your dependencies and your network speed, this could take anywhere from a few seconds to a few minutes.
Running npm scripts
- any script -
fyn run <script-name>or
- list scripts -
fyn run -lor
If you have a lockfile, then
fyn takes sub seconds to regenerate the entire dependency tree even on very large applications. This makes it very fast to probe what's installed.
It has a
stat command that's very fast and can let you know all copies of a package installed and all others that depend on it.
> loaded lockfile > done resolving dependencies 0.157secs lodash matched these installed versions firstname.lastname@example.org => email@example.com has 15 dependents: @firstname.lastname@example.org @email@example.com @firstname.lastname@example.org @email@example.com @firstname.lastname@example.org @email@example.com firstname.lastname@example.org email@example.com firstname.lastname@example.org email@example.com firstname.lastname@example.org email@example.com firstname.lastname@example.org ~package.json => email@example.com has 258 dependency paths, showing the 18 most significant ones below: > @firstname.lastname@example.org > @email@example.com > @firstname.lastname@example.org > email@example.com > @firstname.lastname@example.org > @email@example.com > @firstname.lastname@example.org > email@example.com > @firstname.lastname@example.org > @email@example.com > @firstname.lastname@example.org > email@example.com > @firstname.lastname@example.org > @email@example.com > @firstname.lastname@example.org > email@example.com > @firstname.lastname@example.org > @email@example.com > firstname.lastname@example.org > @email@example.com > firstname.lastname@example.org > email@example.com > @firstname.lastname@example.org > email@example.com > firstname.lastname@example.org > @email@example.com > firstname.lastname@example.org > email@example.com > firstname.lastname@example.org > email@example.com > firstname.lastname@example.org > email@example.com > firstname.lastname@example.org > email@example.com > firstname.lastname@example.org > email@example.com > firstname.lastname@example.org > email@example.com > firstname.lastname@example.org > @email@example.com > firstname.lastname@example.org > email@example.com > firstname.lastname@example.org > email@example.com > firstname.lastname@example.org > email@example.com > firstname.lastname@example.org > email@example.com > firstname.lastname@example.org > @email@example.com > firstname.lastname@example.org > email@example.com > firstname.lastname@example.org > stat completed for lodash
Locking Dependencies by Time
Ever want to install your dependencies only consider packages published up to a certain date in the past?
fyn's got you covered with the
- First rename or remove
- Then run install like this:
rm fyn-lock.yaml fyn install --lock-time "12/01/2018"
fyn install --lock-time "dec 01, 2018"
fyn will only consider packages published up to Dec 01, 2018 when installing.
Refreshing Optional Dependencies
If you have any optional dependencies, then they will not be re-evaluated if you have a lock file.
You can re-evaluate optional dependencies with
fyn install --refresh-optionals
Using with Lerna
lerna actually implements its own internal
npm link like feature to support a monorepo with packages that depend on each other.
You can use fynpo's
local command to update and commit your monorepo's packages'
package.json, and you can run
fyn to install and update their dependencies without having to do it through bootstrap.
fynpo local cd packages/my-awesome-package fyn
fyn options can be listed in help:
fyn loads config from
~/.npmrc in this specified order, from highest to lowest priority.
.npmrc, only fields
_auth are read.
.fynrc file can be an ini or
YAML format. For the
YAML format, the first line must be
Below is an
YAML example, with all the options set to their default values:
--- registry: https://registry.npmjs.org "@scope:registry": https://registry.custom.com offline: false forceCache: false lockOnly: false progress: normal logLevel: info production: false centralStore: false
Or as an ini:
registry=https://registry.npmjs.org @scope:registry=https://registry.custom.com offline=false forceCache=false lockOnly=false progress=normal logLevel=info production=false centralStore=false
Command Line Option to RC Mapping
Any command line option can be converted to an option in the RC file by changing the name to camelCase form.
If there's no RC file or command line override, then these defaults are used:
Other RC Options
Scope registry can be specified in the RC files, the same as
For example, in Yaml format:
--- "@scope:registry": https://registry.custom.com
In ini format:
Inspired by pnpm,
fyn supports storing a single copy of all packages at a central location, and use hardlinks to install them into your
The main advantage of this is to save disk space and slightly faster install if the storage is primed.
However, this feature is not enabled by default due to the following drawbacks:
Creating hardlinks actually could take a lot more than trivial time.
What this means is the first time you install with
fyn, when nothing is cached in the storage, central store mode will actually take noticeably more time, but subsequent installs could be faster.
In particular, very bad on MacOS (High Sierra). For example, using hardlinks to replicate the module
nycactually takes longer than untaring the tgz file. It improves somewhat with concurrency, but still significant.
On Linux with ext4 hardlinking appears to be more than 10 times more efficient than MacOS.
You can't do your debugging and development by modifying code that's installed into
Reason being that any change you make will affect the central copy, and therefore any other
node_modulesthat's linked to it.
If you do this, then even after you blow away your
node_modulesand reinstall it, your "debugging" changes will be there again.
I imagine that this is actually a fairly big drawback for a lot of people.
However, the primary design goal of
fynis to make your module development easier with its local linking install feature. You should use that to develop and debug multiple modules locally.
Similar to 2, but if any package has
postinstallscript that modifies its own files, then those modifications would affect all installations.
- There should not be a lot of packages like this, but if you happen to use one, it's unlikely a central storage would work.
In general if disk space is not an issue for you, then it's better to avoid this and the issues that will likely creep up on you when you least expect it.
If you do have a use of this feature despite the drawbacks, then you can enable it with the
--central-store CLI option.
The recommendation is to add the following to
.fynrc because then you don't have to remember to specify the option in the CLI every time.
You can also set the env variable
1 to enable it.
If you set it to point to a directory then it will be used as the central store directory.
And to work around the issues,
fyn does the following:
- issue 2:
--copyoption that allows you to force any package to install with copying instead of hardlinking.
- issue 3:
fynwill not hard link packages from central store if they have
fyn's top level
node_modulesis 100% compatible with Node.js and 3rd party tools and modules. No special updates or changes needed.
fynuses npm's pacote to do data retrieval. That means its package data handling is the same as npm and it can use npm's cache directly.
fynwill take npm's
package-lock.jsonif its own
fyn-lock.yamlfile doesn't exist, but will save
fynhas an asynchronous and concurrent dependency resolution engine that is 100% compatible with node's nesting design, and properly handles
Node Package Manager is a very large and complex piece of software. Developing
fyn was 10 times easier because of the generous open source software from the community, especially the individual packages that are part of
Other than benefiting from the massive package ecosystem and all the documents from
npm, these are the concrete packages from
fyn is using directly.
node-tar - for untaring
- semver - for handling Semver versions.
pacote - for retrieving
ini - for handling
- npm-packlist - for filtering files according to npm ignore rules.
npm-lifecycle - for npm_config env and offering
runas a convenience.
npmlog - for offering the
runcommand as a convenience.
- And all the other packages they depend on.
Copyright (c) 2015-present, WalmartLabs
Licensed under the Apache License, Version 2.0.