README
Picklr
"
Pick
l
ine &r
eplace"A simple, zero dependency, recursive, single-line text replacer for NodeJS >= 8.
Use to update a specific, single line of text across multiple file types in a project. Finds just the first matching line in a file, and runs a text replacement on just that one line. Synchronous processing.
You might be reading this because you're in a pickle where you have to change a line across a big project. No worries, picklr allows you to test behavior prior to any updates with actions echo
and audit
. It's good to see what would happen prior to any file being updated, and also what files will get omitted from the change set.
API
Picklr exports a single function that starts synchronous file processing when invoked.
function (startDir, options)
Options
A brief description of the options that control file selection and processing:
action
- {String}echo|audit|update
The action taken on each file. Defaults toecho
. Useecho
andaudit
actions to test the results of picklr with options prior to runningupdate
.echo
- Just output what files could be affected by a change. TestsincludeExts
andexcludeDirsRe
options.audit
- Must use withtargetText
andreplacementText
. Outputs lines found and the change plus any files that would be omitted. TestsincludeExts
,excludeDirsRe
,targetText
andreplacementText
options.update
- Does the actual update on the files in place. Use only if you have version control.
includeExts
- {Array} File extensions used to include files in processing. Must include the dot.excludeDirsRe
- {RegExp} A regular expression used to exclude directories from processing. A match is an exclusion.targetText
- {String} The string used to identify the line to process.replacementText
- {String} The string used to replace thetargetText
.logger
- {Function} A log function to receive output. Defaults toconsole.log
.
Example Usage
// Example use for a copyright banner text update:
const picklr = require('picklr');
// Output what files WOULD be affected by includes/excludes:
picklr('.', {
action: 'echo',
includeExts: ['.js', '.jsx', '.scss'],
excludeDirsRe: /\/\.|node_modules|dist|tmp|reports/i
});
// Output what WOULD be processed using targetText/replacementText:
picklr('.', {
action: 'audit',
targetText: 'Copyright (c) 2015',
replacementText: 'Copyright (c) 2015, 2016',
includeExts: ['.js', '.jsx', '.scss'],
excludeDirsRe: /\/\.|node_modules|dist|tmp|reports/i
});
// Got it. Now, actually perform the pick line and replacement.
picklr('.', {
action: 'update',
targetText: 'Copyright (c) 2015',
replacementText: 'Copyright (c) 2015, 2016',
includeExts: ['.js', '.jsx', '.scss'],
excludeDirsRe: /\/\.|node_modules|dist|tmp|reports/i
});
Omitted
To see only what files would be omitted, set your picklr script to use action 'audit', then grep the output for 'Omitted'.
// myPicklrScript.js
const picklr = require('picklr');
picklr('.', {
action: 'audit',
targetText: 'Copyright (c) 2015',
replacementText: 'Copyright (c) 2015, 2016',
includeExts: ['.js', '.jsx', '.scss'],
excludeDirsRe: /\/\.|node_modules|dist|tmp|reports/i
});
node myPicklrScript.js | grep 'Omitted'
License
MIT