junk

What is junk?

The 'junk' npm package is a small utility that helps in filtering out system files and other non-essential files from an array of filenames. It is particularly useful when dealing with file listings that may include unwanted files like '.DS_Store' on macOS or 'Thumbs.db' on Windows.

What are junk's main functionalities?

Filter out junk files from a list

This feature allows you to remove common system-generated files from an array of filenames, ensuring that only relevant files are processed or displayed.

const junk = require('junk');

const files = ['file1.txt', '.DS_Store', 'file2.txt', 'Thumbs.db'];
const cleanFiles = files.filter(junk.not);
console.log(cleanFiles); // Output: ['file1.txt', 'file2.txt']

Identify if a file is considered junk

This function checks if a single filename is considered 'junk' by comparing it against a predefined list of junk file names.

const junk = require('junk');

console.log(junk.is('.DS_Store')); // Output: true
console.log(junk.is('file1.txt')); // Output: false

Other packages similar to junk

ignore

Similar to 'junk', the 'ignore' package is used to manage and filter files based on rules specified in a .gitignore file. While 'junk' specifically filters out system and hidden files, 'ignore' provides a more flexible approach allowing users to define custom patterns for what should be ignored.

glob

The 'glob' package provides functionality to match file paths against specified patterns. Although it's not specifically for filtering out junk files, it can be configured to exclude certain patterns similar to junk files, offering a broader file filtering capability compared to 'junk'.

README

junk

Filter out system junk files like .DS_Store and Thumbs.db

Install

$ npm install junk

Usage

import fs from 'node:fs/promises';
import {isNotJunk} from 'junk';

const files = await fs.readdir('some/path');

console.log(files);
//=> ['.DS_Store', 'test.jpg']

console.log(files.filter(isNotJunk));
//=> ['test.jpg']

API

isJunk(filename)

Returns true if filename matches a junk file.

isNotJunk(filename)

Returns true if filename does not match a junk file.

junkRegex

Regex used for matching junk files.