Operating systems commonly add a trailing increment, or the word 'copy', or something similar to duplicate files. This strips those increments. Tested on Windows, MacOS, and Linux.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.
Install with npm (requires Node.js >=8):
$ npm install --save strip-filename-incrementconst strip = require('strip-filename-increment');Remove trailing increments from the dirname and/or stem (basename
without extension) of the given file path or object.
Params
file{Sring|Object}: If the file is an object, it must have apathproperty.options{Object}: See available options.returns{String|Object}: Returns the same type that was given.
Removes trailing increments from the given string.
Params
input{String}options{Object}: See available options.returns{String}
Example
console.log(strip.increment('foo (2)')); => 'foo'
console.log(strip.increment('foo (copy)')); => 'foo'
console.log(strip.increment('foo copy 2')); => 'foo'Removes trailing increments and returns the dirname of the given filepath.
Params
filepath{String}options{Object}: See available options.returns{String}: Returns thedirnameof the filepath, without increments.
Example
console.log(strip.dirname('foo (2)/bar.txt')); => 'foo'
console.log(strip.dirname('foo (copy)/bar.txt')); => 'foo'
console.log(strip.dirname('foo copy 2/bar.txt')); => 'foo'Removes trailing increments and returns the stem of the given filepath.
Params
filepath{String}options{Object}: See available options.returns{String}: Returns thestemof the filepath, without increments.
Example
console.log(strip.stem('foo/bar (2).txt')); //=> 'bar'
console.log(strip.stem('foo/bar (copy).txt')); //=> 'bar'
console.log(strip.stem('foo/bar copy 2.txt')); //=> 'bar'
console.log(strip.stem('foo/bar (2) copy.txt')); //=> 'bar'
console.log(strip.stem('foo/bar (2) - copy.txt')); //=> 'bar'Removes trailing increments and returns the basename of the given filepath.
Params
filepath{String}options{Object}: See available options.returns{String}: Returns thebasenameof the filepath, without increments.
Example
console.log(strip.basename('foo/bar (2).txt')); //=> 'bar.txt'
console.log(strip.basename('foo/bar (copy).txt')); //=> 'bar.txt'
console.log(strip.basename('foo/bar copy 2.txt')); //=> 'bar.txt'
console.log(strip.basename('foo/bar (2) copy.txt')); //=> 'bar.txt'
console.log(strip.basename('foo/bar (2) - copy.txt')); //=> 'bar.txt'Removes trailing increments from the dirname and stem of the given filepath.
Params
filepath{String}options{Object}: See available options.returns{String}: Returns thebasenameof the filepath, without increments.
Example
console.log(strip.path('foo copy/bar (2).txt')); //=> 'foo/bar.txt'
console.log(strip.path('foo (2)/bar (copy).txt')); //=> 'foo/bar.txt'
console.log(strip.path('foo (2)/bar copy 2.txt')); //=> 'foo/bar.txt'
console.log(strip.path('foo copy/bar (2) copy.txt')); //=> 'foo/bar.txt'
console.log(strip.path('foo copy/bar (2) - copy.txt')); //=> 'foo/bar.txt'Removes trailing increments from the dirname and stem properties of the given file.
Params
filepath{String}options{Object}: See available options.returns{String}: Returns thebasenameof the filepath, without increments.
Example
console.log(strip({ path: 'foo copy/bar (2).txt' }));
//=> { path: 'foo/bar.txt', dir: 'foo', base: 'bar.txt', name: 'bar', ext: '.txt' }
console.log(strip({ path: 'foo (2)/bar (copy).txt' }));
//=> { path: 'foo/bar.txt', dir: 'foo', base: 'bar.txt', name: 'bar', ext: '.txt' }
console.log(strip({ path: 'foo (2)/bar copy 2.txt' }));
//=> { path: 'foo/bar.txt', dir: 'foo', base: 'bar.txt', name: 'bar', ext: '.txt' }
console.log(strip({ path: 'foo copy/bar (2) copy.txt' }));
//=> { path: 'foo/bar.txt', dir: 'foo', base: 'bar.txt', name: 'bar', ext: '.txt' }
console.log(strip({ path: 'foo copy/bar (2) - copy.txt' }));
//=> { path: 'foo/bar.txt', dir: 'foo', base: 'bar.txt', name: 'bar', ext: '.txt' }Remove "raw" trailing numbers that might not actually be increments. Use this with caution.
Type: boolean
Default: undefined
Example:
console.log(strip('foo 1')); //=> 'foo 1'
console.log(strip('foo 1', { removeRawNumbers: true })); //=> 'foo'
console.log(strip('foo (1) 1')); //=> 'foo (1) 1'
console.log(strip('foo (1) 1', { removeRawNumbers: true })); //=> 'foo'
// This following example is not touched either way,
// since it's definitely not an increment.
console.log(strip('foo [1]')); //=> 'foo [1]'
console.log(strip('foo [1]', { removeRawNumbers: true })); //=> 'foo [1]'All of the following would return foo
console.log(strip('foo (1)'));
console.log(strip('foo (2)'));
console.log(strip('foo (22)')); All of the following would return foo.txt
console.log(strip('foo (1).txt'));
console.log(strip('foo (2).txt'));
console.log(strip('foo (22).txt')); All of the following would return foo
console.log(strip('foo copy'));
console.log(strip('foo copy 1'));
console.log(strip('foo copy 2'));
console.log(strip('foo copy 21'));
console.log(strip('foo copy 219 copy 219'));All of the following would return foo.txt
console.log(strip('foo copy.txt'));
console.log(strip('foo copy 1.txt'));
console.log(strip('foo copy 2.txt'));
console.log(strip('foo copy 21.txt'));
console.log(strip('foo copy 219 copy 219.txt'));Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guide for advice on opening issues, pull requests, and coding standards.
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm testBuilding docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verbJon Schlinkert
Copyright © 2019, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.8.0, on September 04, 2019.