Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
directory-fixture-provider
Advanced tools
Readme
npm install directory-fixture-provider --save-dev
..comes to write something like this, when your library that work with files and directories and you want to test the results.
Directory-fixture-provider has its own limited DSL that gives you a few options for now, but can be handy to know about.
const fixturesRoot = '/paht/to/your/fixture/directories/files'
/*
contains files and direcories for examnple:
- file-a.js
- file-b.js
- directory1/file-c.js
- directory2/contains-a-lot-of-files.js
- directory2/directory3/contains-a-lot-of-files-as-well.js
*/
const dfp = require('directory-fixture-provider')
const fixtureDirectoryProvider = dfp(fixturesRoot)()
const fixtureData = fixtureDirectoryProvider.get('directory2')
// fixtureData contains an object where
/*
{ dir: '/tmp/directory-fixture-provider-destination/KzXwBFDdtAmh/',
fixturePath: '/home/it/dev/misc/dsl-toolkit/packages/directory-fixture-provider/tests/directory-fixtures/',
getFixtureFiles: [Function: getFixtureFiles],
getDestinationFiles: [Function: getDestinationFiles],
getStatus: [Function: getStatus],
getFixtureContent: [Function] }
}
*/
This is how you start working with the tool, but the real fun starts. So you receive all files and subdirectories of the fixtures that subset what you were requesting too so in the example above the directory2 will be given back.
We have a random part of the path that is unique per fixture provider, so if you need clean data, create another directory-fixture-provider.
Imagine a situation, when you are testing a small application that uses your framework, and you want to test your frameworks behaviour in the wild. In this case, you have your sample application, and you want to have installed its the dependencies, but the package.json does not change too often. In this case, it was nice overwriting the files, so you don't need that random part in the deployed directory.
const fixtureDirectoryProvider = dfp(fixturesRoot)('permanent')()
If you like the concept that your temporary files are in a fixed place, but rather you
would empty the destination directory first you type:
const fixtureDirectoryProvider = dfp(fixturesRoot)('permanent','cleanFirst')()
const fixtureDirectoryProvider = dfp(fixturesRoot)()
const fixtureData = fixtureDirectoryProvider.get('./')
const fixtureDir = fixtureData.dir
// Work with the files
// add/remove/modify files, and you will get relevant info about them
fixtureData.getStatus().changed
// true if something is changed.
fixtureData.getStatus().changeTotals
// gives you the number of files changed
If a new file is added, deleted or an existing changed each count as a change here.
fixtureData.getStatus().changeNumbers
/*
Returns an object like this:
{
deleted: 0
changed: 0
new: 0
}
*/
Where it tells you how many files changed, deleted or new
If a file is deleted it will increase the changed data tag too.
Create an excellent diff module for the getStatus resulting object.
This library helps you find changes modifications between your working and original fixture files. More examples are coming for more information, please check the tests
FAQs
Provides directories for testing.
The npm package directory-fixture-provider receives a total of 111 weekly downloads. As such, directory-fixture-provider popularity was classified as not popular.
We found that directory-fixture-provider demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.