Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonschlinkert/strip-filename-increment
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.
https://github.com/jonschlinkert/strip-filename-increment
conflicts dirent duplicate file filename filepath increment javascript jonschlinkert name node nodejs number path rename strip vinyl
Last synced: 3 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/jonschlinkert/strip-filename-increment
- Owner: jonschlinkert
- License: mit
- Created: 2017-07-11T05:25:14.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-04T06:30:45.000Z (over 5 years ago)
- Last Synced: 2024-11-02T09:32:00.394Z (4 months ago)
- Topics: conflicts, dirent, duplicate, file, filename, filepath, increment, javascript, jonschlinkert, name, node, nodejs, number, path, rename, strip, vinyl
- Language: JavaScript
- Homepage: https://github.com/jonschlinkert
- Size: 16.6 KB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# strip-filename-increment [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W8YFZ425KND68) [](https://www.npmjs.com/package/strip-filename-increment) [](https://npmjs.org/package/strip-filename-increment) [](https://npmjs.org/package/strip-filename-increment) [](https://travis-ci.org/jonschlinkert/strip-filename-increment)
> 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](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/) (requires [Node.js](https://nodejs.org/en/) >=8):
```sh
$ npm install --save strip-filename-increment
```
## Usage
```js
const strip = require('strip-filename-increment');
```
## API
### [strip](index.js#L34)
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 a `path` property.
* `options` **{Object}**: See [available options](#options).
* `returns` **{String|Object}**: Returns the same type that was given.
### [.increment](index.js#L62)
Removes trailing increments from the given string.
**Params**
* `input` **{String}**
* `options` **{Object}**: See [available options](#options).
* `returns` **{String}**
**Example**
```js
console.log(strip.increment('foo (2)')); => 'foo'
console.log(strip.increment('foo (copy)')); => 'foo'
console.log(strip.increment('foo copy 2')); => 'foo'
```
### [.dirname](index.js#L86)
Removes trailing increments and returns the `dirname` of the given `filepath`.
**Params**
* `filepath` **{String}**
* `options` **{Object}**: See [available options](#options).
* `returns` **{String}**: Returns the `dirname` of the filepath, without increments.
**Example**
```js
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'
```
### [.stem](index.js#L107)
Removes trailing increments and returns the `stem` of the given `filepath`.
**Params**
* `filepath` **{String}**
* `options` **{Object}**: See [available options](#options).
* `returns` **{String}**: Returns the `stem` of the filepath, without increments.
**Example**
```js
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'
```
### [.basename](index.js#L128)
Removes trailing increments and returns the `basename` of the given `filepath`.
**Params**
* `filepath` **{String}**
* `options` **{Object}**: See [available options](#options).
* `returns` **{String}**: Returns the `basename` of the filepath, without increments.
**Example**
```js
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'
```
### [.path](index.js#L151)
Removes trailing increments from the `dirname` and `stem` of the given `filepath`.
**Params**
* `filepath` **{String}**
* `options` **{Object}**: See [available options](#options).
* `returns` **{String}**: Returns the `basename` of the filepath, without increments.
**Example**
```js
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'
```
### [.file](index.js#L181)
Removes trailing increments from the `dirname` and `stem` properties of the given `file`.
**Params**
* `filepath` **{String}**
* `options` **{Object}**: See [available options](#options).
* `returns` **{String}**: Returns the `basename` of the filepath, without increments.
**Example**
```js
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' }
```
## Options
### removeRawNumbers
Remove "raw" trailing numbers that might not actually be increments. Use this with caution.
**Type**: `boolean`
**Default**: `undefined`
**Example**:
```js
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]'
```
## Examples
### Windows path increments
All of the following would return `foo`
```js
console.log(strip('foo (1)'));
console.log(strip('foo (2)'));
console.log(strip('foo (22)'));
```
All of the following would return `foo.txt`
```js
console.log(strip('foo (1).txt'));
console.log(strip('foo (2).txt'));
console.log(strip('foo (22).txt'));
```
### MacOS path increments
All of the following would return `foo`
```js
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`
```js
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'));
```
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Please read the [contributing guide](.github/contributing.md) 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:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Author
**Jon Schlinkert**
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
### License
Copyright © 2019, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on September 04, 2019._