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 🙏

© 2021 – Pkg Stats / Ryan Hefner

@invisible/basic-tests

v1.1.0

Published

Basic tests for your project: requiring each file and testing environment variables

Downloads

338

Readme

@invisible/basic-tests

CircleCI

Basic tests for your project: requiring each file and testing environment variables

Installation

yarn add --dev @invisible/basic-tests

Usage

Programmatically

This module exposes two methods checkRequireAllFiles and checkEnvFromSample.

  1. checkRequireAllFiles() will attempt to require every file in your project, aside from those that are ignored by your .gitignore or are in your test directory. If it encounters any that throw an error on require, or are simply invalid javascript, this function will throw. If it encounters multiple such errors, it will throw one error at the end with all un-requirable files listed.

This test is useful because it ensures that you don't have any obvious errors in your files. It should also encourage you to not have any side effects on requiring files.

  1. checkEnvFromSample() checks that all env vars in env.sample are actually set in your environment. This is useful so that you won't try to run your package when it is missing a required environment variable.

Note: both of these methods are synchronous.

To use these methods, create a test file and call these functions


// test/index.js

'use strict'

const {
  checkEnvFromSample,
  checkRequireAllFiles,
} = require('@invisible/basic-tests')

describe('env', () => {
  it('env.sample should exist, and all env vars should be set', checkEnvFromSample)
})

describe('dependencies', () => {
  it('should be able to require all files', checkRequireAllFiles)
})
$ mocha test

  ․․

  2 passing (20ms)

CLI

For convenience, we also expose these two methods for the CLI as check-env-from-sample and check-require-all-files so you can call them from your CI as part of your checks before deploying, or you can add them to the lifecycle script itself so that even after deploy you can get immediate feedback (and your server won't start).

For example:

// package.json:
{
  "prestart": "check-env-from-sample && check-require-all-files",
  "start": "node index.js"
  ...
}

Note: check-env-from-sample requires dotenv before checking.