npmpackage.info

Gathering detailed insights and metrics for with-local-tmp-dir

with-local-tmp-dir

Creates a temporary folder inside cwd, cds inside the folder, runs a function, and removes the folder. Especially useful for testing.

5.1.1

NOASSERTION

JavaScript

2.43 kB

196,782 2.6

Installations

npm install with-local-tmp-dir

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

>=14

Node Version

16.20.2

NPM Version

7.24.2 Score

67.6

Supply Chain

96.8

Quality

77.8

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

10

Total

126

Closed

14

Merged

102

Issues

Open

0

Total

4

Closed

4

Releases

v5.1.1

Published on 12 Mar 2024

v5.1.0

Published on 02 Mar 2024

v5.0.1

Published on 09 Apr 2023

v5.0.0

Published on 08 Jan 2023

v4.1.0

Published on 19 Sept 2022

v4.0.11

Published on 12 Jan 2022

View all 32 releases

Contributors

Unable to fetch Contributors

View all 6 contributors

Languages

JavaScript

Shell

JavaScript (98.07%)

Shell (1.93%)

Developer

dword-design

Download Statistics

Total Downloads

196,782

Last Day

149

Last Week

551

Last Month

2,054

Last Year

30,188

GitHub Statistics

5 Stars

246 Commits

1 Forks

2 Watching

11 Branches

6 Contributors

Bundle Size

6.40 kB

Minified

2.43 kB

Minified + Gzipped

Bundlephobia

Sponsor this package

https://github.com/sponsors/dword-design

Maintainers

Package Meta Information

Latest Version

5.1.1

Package Id

with-local-tmp-dir@5.1.1

Unpacked Size

12.24 kB

Size

4.49 kB

File Count

NPM Version

7.24.2

Node Version

16.20.2

Publised On

12 Mar 2024

Total Downloads

Cumulative downloads

Total Downloads

196,782

Last day

132.8%

149

Compared to previous day

Last week

-1.3%

551

Compared to previous week

Last month

-32.1%

2,054

Compared to previous month

Last year

-55.3%

30,188

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@dword-design/chdir tmp-promise

Dev Dependencies

@dword-design/base @dword-design/functions fs-extra

Versions

with-local-tmp-dir

Creates a temporary folder inside cwd, cds inside the folder, runs a function, and removes the folder. Especially useful for testing.

This package can be used to write file-based tests with real files. See below for some examples.

Install

1# npm
2$ npm install with-local-tmp-dir
3
4# Yarn
5$ yarn add with-local-tmp-dir

Basic Usage

1const withLocalTmpDir = require('with-local-tmp-dir')
2const fs = require('fs-extra')
3
4await withLocalTmpDir(() => {
5  console.log(process.cwd())
6  //> /Users/max/project/tmp-18815DudQxmdn03Rz
7
8  // Create some files
9  await fs.outputFile('foo.txt', 'foo bar')
10  await fs.outputFile('bar.txt', 'foo bar')
11})
12// Now the folder does not exist anymore
13
14// The folder is removed even if an exception is thrown
15await withLocalTmpDir(() => throw new Error('File could not be found'))

Reset

Instead of a function you can reset the state yourself instead of passing a function, i.e. change to the previous folder and remove the folder:

1const withLocalTmpDir = require('with-local-tmp-dir')
2const fs = require('fs-extra')
3
4// You can still pass options
5const reset = await withLocalTmpDir()
6
7console.log(process.cwd())
8//> /Users/max/project/tmp-18815DudQxmdn03Rz
9
10// Create some files
11await fs.outputFile('foo.txt', 'foo bar')
12await fs.outputFile('bar.txt', 'foo bar')
13
14await reset()
15
16// Now the folder does not exist anymore

Options

You can specify an options object that is passed down to tmp-promise. Check the readme for details. Some default values are adjusted, but they still can be overridden.

1const withLocalTmpDir = require('with-local-tmp-dir')
2const fs = require('fs-extra')
3
4// do not cleanup if there are files
5await withLocalTmpDir(() => {
6  await fs.outputFile('foo.txt', 'foo bar')
7}, { unsafeCleanup: false })
8
9// run in a subfolder
10await withLocalTmpDir(() => {
11  console.log(process.cwd())
12  //> /Users/max/project/foo/tmp-18815DudQxmdn03Rz
13}, { dir: 'foo' })
14
15// use a different prefix
16await withLocalTmpDir(() => {
17  console.log(process.cwd())
18  //> /Users/max/project/foo-18815DudQxmdn03Rz
19}, { prefix: 'foo' })

Unit Tests with output-files and endent

The most common use case for this package is probably unit tests with Mocha or Jest. The package itself is framework-agnostic, so you can use any of them. To make life easier when writing multiple files with multi-line text content, there are two handy packages: output-files and endent.

The following is an example for Mocha:

1const withLocalTmpDir = require('with-local-tmp-dir')
2const outputFiles = require('output-files')
3const endent = require('endent')
4
5const funcToTest = require('.')
6
7beforeEach(async function () {
8  this.resetWithLocalTmpDir = await withLocalTmpDir()
9})
10
11afterEach(async function () {
12  await this.resetWithLocalTmpDir()
13})
14
15it('works', async () => {
16  await outputFiles({
17    'foo.txt': endent`
18      Lorem ipsum
19      dolor sit
20    `,
21    'index.js': endent`
22      export default {
23        foo: 1,
24        bar: 2,
25      }
26    `,
27  })
28  funcToTest()
29})

Git-based tests

It is also possible to test libraries that make use of Git. You can instantiate a local Git repository inside the temporary folder and run Git operations on it:

1const withLocalTmpDir = require('with-local-tmp-dir')
2const fs = require('fs-extra')
3const execa = require('execa')
4
5beforeEach(async function () {
6  this.resetWithLocalTmpDir = await withLocalTmpDir()
7})
8
9afterEach(async function () {
10  await this.resetWithLocalTmpDir()
11})
12
13it('works', async () => {
14  await execa.command('git init')
15  await execa.command('git config user.email "foo@bar.de"')
16  await execa.command('git config user.name "foo"')
17
18  await outputFile('foo.txt', 'foo bar')
19
20  await execa.command('git add .')
21  await execa.command('git commit -m "feat: init"')
22  funcToTest()
23})

Be careful though, if the repository is not properly initialized, your user Git config might be overridden!

Contribute

Are you missing something or want to contribute? Feel free to file an issue or a pull request! ⚙️

Support

Hey, I am Sebastian Landwehr, a freelance web developer, and I love developing web apps and open source packages. If you want to support me so that I can keep packages up to date and build more helpful tools, you can donate here:

If you want to send me a one time donation. The coffee is pretty good 😊.
Also for one time donations if you like PayPal.
Here you can support me regularly, which is great so I can steadily work on projects.

Thanks a lot for your support! ❤️

License

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

9

License

Determines if the project has defined a license.

1

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/with-local-tmp-dir/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/with-local-tmp-dir/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/with-local-tmp-dir/build.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/with-local-tmp-dir/build.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/with-local-tmp-dir/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/with-local-tmp-dir/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/with-local-tmp-dir/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deprecated-dependencies.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/with-local-tmp-dir/deprecated-dependencies.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deprecated-dependencies.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/with-local-tmp-dir/deprecated-dependencies.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deprecated-dependencies.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/with-local-tmp-dir/deprecated-dependencies.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deprecated-dependencies.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/with-local-tmp-dir/deprecated-dependencies.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deprecated-dependencies.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/with-local-tmp-dir/deprecated-dependencies.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sync-labels.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/with-local-tmp-dir/sync-labels.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/sync-labels.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/with-local-tmp-dir/sync-labels.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sync-metadata.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/with-local-tmp-dir/sync-metadata.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/sync-metadata.yml:6: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/with-local-tmp-dir/sync-metadata.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/sync-metadata.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/dword-design/with-local-tmp-dir/sync-metadata.yml/master?enable=pin
Warn: containerImage not pinned by hash: .gitpod.Dockerfile:2: pin your Docker image by updating gitpod/workspace-full:latest to gitpod/workspace-full:latest@sha256:bec45ebdcc9b9c5ec28d5c61c16bf599200aa0d2dc1e69e2ed8ab0a424bae6db
Warn: downloadThenRun not pinned by hash: .gitpod.Dockerfile:4
Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 9 third-party GitHubAction dependencies pinned
Info: 0 out of 1 containerImage dependencies pinned
Info: 0 out of 1 downloadThenRun dependencies pinned

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.6

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

with-local-tmp-dir

Installations

Developer Guide

Yes

ESM

>=14

16.20.2

7.24.2

Score

Pull Requests

10

126

14

102

Issues

0

4

4

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

dword-design

Download Statistics

GitHub Statistics

Bundle Size

6.40 kB

2.43 kB

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

196,782

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

with-local-tmp-dir

Install

Basic Usage

Reset

Options

Unit Tests with output-files and endent

Git-based tests

Contribute

Support

See also

License

10

10

9

1

0

0

0

0

0

0

0

0

0

2.6

/10