Git Product home page Git Product logo

isolated's Introduction

isolated

isolated provides one-time folders for unit tests.

Status

Category Status
Version npm
Dependencies David
Dev dependencies David
Build GitHub Actions
License GitHub

Installation

$ npm install isolated

Quick Start

Using isolated is easy. All you need to do is to add a reference to it within your Node.js application:

const { isolated } = require('isolated');

If you use TypeScript, use the following code instead:

import { isolated } from 'isolated';

Then you can use it within your tests. In its simplest form, isolated provides a one-time folder for your test and guarantees to clean up later.

test('...', async () => {
  const directory = await isolated();
});

Additionally, you may want to specify a file or a directory that isolated shall copy to the one-time directory before running your test.

test('...', async () => {
  const directory = await isolated({
    files: 'foo.txt'
  });
});

If you need to copy multiple files or directories, specify an array instead of a single item.

test('...', async () => {
  const directory = await isolated({
    files: [ 'foo.txt', 'bar.txt' ]
  });
});

Sometimes you may want isolate to preserve the sources' timestamps. For that additionally provide the preserveTimestamps option and set it to true.

test('...', async () => {
  const directory = await isolated({
    files: [ 'foo.txt', 'bar.txt' ],
    preserveTimestamps: true
  });
});

Running quality assurance

To run quality assurance for this module use roboter:

$ npx roboter

isolated's People

Contributors

dependabot-preview[bot] avatar dependabot[bot] avatar semantic-release-bot avatar goloroden avatar yeldirium avatar grundhoeferj avatar

Stargazers

Lex avatar Sebastian Landwehr avatar Cat  avatar  avatar  avatar Gabriel Birke avatar André König avatar

Watchers

James Cloos avatar  avatar Susanna Roden avatar Stefan Brandys avatar  avatar

Forkers

the-cc-dev

isolated's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.