diff options
Diffstat (limited to 'node_modules/import-local/readme.md')
| -rw-r--r-- | node_modules/import-local/readme.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/node_modules/import-local/readme.md b/node_modules/import-local/readme.md new file mode 100644 index 0000000..cc5244f --- /dev/null +++ b/node_modules/import-local/readme.md @@ -0,0 +1,37 @@ +# import-local + +> Let a globally installed package use a locally installed version of itself if available + +Useful for CLI tools that want to defer to the user's locally installed version when available, but still work if it's not installed locally. For example, [AVA](https://avajs.dev) and [XO](https://github.com/xojs/xo) uses this method. + +## Install + +```sh +npm install import-local +``` + +## Usage + +```js +import importLocal from 'import-local'; + +if (importLocal(import.meta.url)) { + console.log('Using local version of this package'); +} else { + // Code for both global and local version here… +} +``` + +You can also pass in `__filename` when used in a CommonJS context. + +--- + +<div align="center"> + <b> + <a href="https://tidelift.com/subscription/pkg/npm-import-local?utm_source=npm-import-local&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a> + </b> + <br> + <sub> + Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies. + </sub> +</div> |