// copy-folder-util ~~ MIT License // // Usage in package.json: // "scripts": { // "make-dist": "copy-folder build dist" // }, // // Usage from command line: // $ npm install --save-dev copy-folder-util // $ copy-folder build dist // $ copy-folder src/web --ext=.js,.html docs // // Contributors to this project: // $ cd copy-folder-util // $ npm install // $ npm test // $ node bin/cli.js --cd=spec/fixtures source --ext=.js target/ext-js // Imports import { cliArgvUtil } from 'cli-argv-util'; import chalk from 'chalk'; import fs from 'node:fs'; import log from 'fancy-log'; import path from 'node:path'; import slash from 'slash'; // Types export type Settings = { basename: string | null, //filter files by filename ignoring the file extension cd: string | null, //change working directory before starting copy fileExtensions: string[], //filter files by file extensions, example: ['.js', '.css'] }; export type Results = { source: string, //path of origination folder target: string, //path of destination folder count: number, //number of files copied duration: number, //execution time in milliseconds files: { filename: string, origin: string, dest: string }[], }; export type ResultsFile = Results["files"][number]; export type ReporterSettings = { summaryOnly: boolean, //only print out the single line summary message }; const copyFolder = { version: '{{package.version}}', extraneous: { files: ['.DS_Store', 'Thumbs.db', 'desktop.ini'], folders: ['.git', 'node_modules'], }, assertOk(ok: unknown, message: string | null) { if (!ok) throw new Error(`[copy-folder-util] ${message}`); }, cp(sourceFolder: string, targetFolder: string, options?: Partial): Results { const defaults: Settings = { basename: null, cd: null, fileExtensions: [], }; const settings = { ...defaults, ...options }; const startTime = Date.now(); const cleanPath = (folder: string) => !folder ? '' : slash(path.normalize(folder)).replace(/\/$/, ''); const startFolder = settings.cd ? cleanPath(settings.cd) + '/' : ''; const source = cleanPath(startFolder + sourceFolder); const target = cleanPath(startFolder + targetFolder); if (targetFolder) fs.mkdirSync(target, { recursive: true }); const error = !sourceFolder ? 'Must specify the source folder path.' : !targetFolder ? 'Must specify the target folder path.' : !fs.existsSync(source) ? 'Source folder does not exist: ' + source : !fs.existsSync(target) ? 'Target folder cannot be created: ' + target : !fs.statSync(source).isDirectory() ? 'Source is not a folder: ' + source : !fs.statSync(target).isDirectory() ? 'Target is not a folder: ' + target : null; copyFolder.assertOk(!error, error); const filterOff = { base: !settings.basename, ext: !Array.isArray(settings.fileExtensions) || !settings.fileExtensions.length, }; const files: Results["files"] = []; const posixPath = (nativePath: string) => slash(nativePath.replace(/.*:/, '')); const filter = (origin: string, dest: string) => { const isFile = fs.statSync(origin).isFile(); const name = path.basename(origin); const ext = path.extname(origin); const ancestor = cliArgvUtil.calcAncestor(posixPath(origin), posixPath(dest)); const keepFolder = !isFile && !copyFolder.extraneous.folders.includes(name); const keepFile = isFile && (filterOff.base || name.replace(/[.].*/, '') === settings.basename) && (filterOff.ext || settings.fileExtensions.includes(ext)) && !copyFolder.extraneous.files.includes(name); if (keepFile) files.push({ filename: name, origin: path.dirname(ancestor.source) + '/', dest: path.dirname(ancestor.target) + '/', }); return keepFolder || keepFile; }; fs.cpSync(source, target, { filter: filter, recursive: true }) return { source: source, target: target, count: files.length, duration: Date.now() - startTime, files: files, }; }, reporter(results: Results, options?: Partial): Results { const defaults: ReporterSettings = { summaryOnly: false, }; const settings = { ...defaults, ...options }; const name = chalk.gray('copy-folder'); const version = chalk.gray('v' + copyFolder.version); const message = `(files: ${results.count}, ${results.duration}ms)`; const summary = results.count ? chalk.blue(message) : chalk.redBright(message); log(name, version, results.source, summary); const logFile = (file: ResultsFile, index: number) => log(name, chalk.magenta(index + 1), chalk.green(file.dest) + chalk.white(file.filename)); if (!settings.summaryOnly) results.files.forEach(logFile); return results; }, cli() { const validFlags = ['basename', 'cd', 'ext', 'note', 'quiet', 'summary']; const cli = cliArgvUtil.parse(validFlags); const source = cli.params[0]; const target = cli.params[1]; const error = cli.invalidFlag ? cli.invalidFlagMsg : !source ? 'Missing source folder.' : !target ? 'Missing target folder.' : cli.paramCount > 2 ? 'Extraneous parameter: ' + cli.params[2]! : null; copyFolder.assertOk(!error, error); const options: Settings = { basename: cli.flagMap.basename ?? null, cd: cli.flagMap.cd ?? null, fileExtensions: cli.flagMap.ext?.split(',') ?? [], }; const results = copyFolder.cp(source!, target!, options); if (!cli.flagOn.quiet) copyFolder.reporter(results, { summaryOnly: cli.flagOn.summary! }); }, }; export { copyFolder };