npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

symlink-or-copy

v1.3.1

Published

Symlink files or directories, falling back to copying on Windows

Downloads

2,277,746

Readme

node-symlink-or-copy

Build Status Build status

Symlink a file or directory to another place. Fall back to copying on Windows. Made for use with Broccoli plugins, for "do what I mean" behavior.

Installation

npm install --save symlink-or-copy

Example

const symlinkOrCopySync = require('symlink-or-copy').sync;

symlinkOrCopySync('src_dir/some_file.txt', 'dest_dir/some_file.txt');
symlinkOrCopySync('src_dir/some_dir', 'dest_dir/some_dir');

Description

symlinkOrCopySync(srcPath, destPath);

Create a symlink at destPath pointing to srcPath.

On Windows, we may fall back to copying srcPath to destPath, preserving last-modified times. However, do not rely on always getting a copy on Windows (see Notes below).

If you pass a relative srcPath, it will be resolved relative to process.cwd(), akin to a copy function. Note that this is unlike fs.symlinkSync, whose srcPath is relative to destPath.

If srcPath does not exist or is a broken symlink, we might throw an exception, or we might create a broken symlink.

When we fall back to copying, symlinks at or beneath srcPath will be dereferenced, and broken symlinks will cause exceptions.

We will throw an exception if destPath already exists. Thus in contrast to Unix cp or ln, the following will fail:

// dest_dir already exists, and we might expect dest_dir/some_dir to be
// created. This does not work; pass 'dest_dir/some_dir' instead.
symlinkOrCopySync('src_dir/some_dir', 'dest_dir');

It is an error if the parent directory of destPath does not already exist.

When we symlink, if the file at srcPath is a symlink as well, it will be dereferenced before symlinking, to avoid runaway symlink indirection.

Notes

  • Symlinks technically work on Windows, but they require special rights. For users with those rights, symlinks are used, but when not available, a combination of junctions and copying is used to mimic the behavior somewhat performantly.

  • There intentionally isn't an asynchronous version. It's not clear that we need or want one. Before sending a patch to add an async version, please share your use case on the issue tracker.