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

load-any-file

v1.3.0

Published

Load any file you want to load in any format.

Downloads

567

Readme

Load Any File!

NPM version Build Status Test Coverage Dependency Status DevDependency Status License PR Welcome

Load any file you want to load in any format.

Design Philosophy

The design philosophy behind this package is allowing developer to use any language he/she preferred to write configuration files.

And this utility is mean to be used by packages that require configuration files.

It's not recommended to use this for loading program files.

Installation

npm i load-any-file -s

Usage

To load this package, for javaScript:

const loadFile = require('load-any-file');

For TypeScript:

import loadFile from 'load-any-file';

Load Any File supports a wide variety of formats.

/foo
├── aries.json
├── taurus.js
├── gemini.ts
├── leo.cson
├── virgo.coffee
└── libra.yaml
const myJsonModule = loadFile('./aries.json');
const myJsModule = loadFile('./taurus.js');
const myTsModule = loadFile('./gemini.ts');
const myCsonModule = loadFile('./leo.cson');
const myCoffeeModule = loadFile('./virgo.coffee');
const myYamlModule = loadFile('./libra.yaml');

Most of times, you don't need to specify the extension. Having Load Any File figure out the extension and format for you.

/foo
├── .babelrc.json
├── package.json
└── server.js
const babelConfig = loadFile('./.babelrc'); // resolves to the json config
/foo
├── .babelrc.yaml
├── package.json
└── server.js
const babelConfig = loadFile('./.babelrc'); // resolves to the yaml config

If a directory with the name user specified exists, Load Any File tries to load the index file.

/foo
└── myModule
    └── index.ts
const babelConfig = loadFile('./myModule'); // resolves to 'myModule/index.ts'

If a file exists but without extension, Load Any File treats it as a data file. This means, Load Any File tries to load it as 'json', 'cson' or 'yaml'. If it can't be parsed by any parser, it throws an error. This enables configuration files without extension to be written in any format.

/foo
└── .eslintrc
// figure out the file type and load it
const babelConfig = loadFile('./.eslintrc');

API

loadFile(location: string): any;

Returns the module exported by the file.

loadFile.resolve(location: string): string;

Returns the module's file system location.

Change Log

  • 1.1.0 (2019-05-10)
    • added loadFile.resolve for returning file location
  • 1.0.1 (2019-04-23)
    • added documentation for requiring this package
    • added change log
  • 1.0.0 (2019-04-23)
    • basic functionality

License

MIT © Zhang Kai Yu