Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/armed/gulp-flatten
Gulp plugin: remove or replace relative paths for files
https://github.com/armed/gulp-flatten
flatten gulp gulp-plugin javascript
Last synced: 7 days ago
JSON representation
Gulp plugin: remove or replace relative paths for files
- Host: GitHub
- URL: https://github.com/armed/gulp-flatten
- Owner: armed
- License: mit
- Created: 2014-01-11T12:46:46.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2022-12-03T03:16:09.000Z (almost 2 years ago)
- Last Synced: 2024-10-28T17:33:40.048Z (16 days ago)
- Topics: flatten, gulp, gulp-plugin, javascript
- Language: JavaScript
- Homepage:
- Size: 134 KB
- Stars: 106
- Watchers: 5
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [gulp](http://gulpjs.com)-flatten [](http://badge.fury.io/js/gulp-flatten) [](https://travis-ci.org/armed/gulp-flatten)
>Remove or replace relative path for files (gulp v3).
## Install
```
npm install gulp-flatten
```
## Usage
Example source directory with bower compoments:
```
├── angular
│ ├── README.md
│ ├── angular-csp.css
│ ├── angular.js
│ ├── angular.min.js
│ └── bower.json
├── angular-route
│ ├── README.md
│ ├── angular-route.js
│ ├── angular-route.min.js
│ ├── angular-route.min.js.map
│ └── bower.json
├── angular-sanitize
│ ├── README.md
│ ├── angular-sanitize.js
│ ├── angular-sanitize.min.js
│ ├── angular-sanitize.min.js.map
│ └── bower.json
└── bootstrap
├── DOCS-LICENSE
├── LICENSE
├── LICENSE-MIT
├── README.md
├── bower.json
└── dist
├── css
│ ├── bootstrap-theme.css
│ ├── bootstrap-theme.min.css
│ ├── bootstrap.css
│ └── bootstrap.min.css
├── fonts
│ ├── glyphicons-halflings-regular.eot
│ ├── glyphicons-halflings-regular.svg
│ ├── glyphicons-halflings-regular.ttf
│ └── glyphicons-halflings-regular.woff
└── js
├── bootstrap.js
└── bootstrap.min.js
```
By default `gulp` stores files with it's relative paths. To copy all minified javascript files from `bower_components` to `build` folder without relative paths:
```js
var flatten = require('gulp-flatten');
gulp.src('bower_components/**/*.min.js')
.pipe(flatten())
.pipe(gulp.dest('build/js'));
```
Result will be list of all `.min.js` files inside `build/js` dir:
```
build
└── js
├── angular-route.min.js
├── angular-sanitize.min.js
├── angular.min.js
└── bootstrap.min.js
```
## Options
### flatten(options)
#### options.newPath
Type: `String`
Default: `''`
Relative path for file.
#### options.includeParents
Type: `Number` or `Array` of two numbers
If passed in as positive number, it will include the number of top-level parents in the output. Using this code:
```js
gulp.src(['bower_components/**/*.css'])
.pipe(flatten({ includeParents: 1} ))
.pipe(gulp.dest('build/'));
```
will create this structure (from sample directory tree above):
```
└── bootstrap
├── bootstrap-theme.css
├── bootstrap-theme.min.css
├── bootstrap.css
└── bootstrap.min.css
```
If passed in as negative number, it will include the number of bottom-level parents in the output. Using this code:
```js
gulp.src(['bower_components/**/*.css'])
.pipe(flatten({ includeParents: -1} )) //or indludeParents: [0, 1]
.pipe(gulp.dest('build/'));
```
will create this structure:
```
└── css
├── bootstrap-theme.css
├── bootstrap-theme.min.css
├── bootstrap.css
└── bootstrap.min.css
```
If passes as array of two numbers, both parents from top and bottom will be kept in resulting path of a file.
```js
gulp.src(['bower_components/**/*.css'])
.pipe(flatten({ includeParents: [1, 1]} ))
.pipe(gulp.dest('build/'));
```
will create this structure:
```
└── bootstrap
└── css
├── bootstrap-theme.css
├── bootstrap-theme.min.css
├── bootstrap.css
└── bootstrap.min.css
```
#### options.subPath
Type: Number or Array of two Numbers [begin, end]
This options applies `Array.slice` to the array of path elements and allows you
to receive a subsequences of the path.
```js
gulp.src(['bower_components/**/*.css'])
.pipe(flatten({ subPath: [1, 1]} ))
.pipe(gulp.dest('build/'));
```
This as an example would flatten `top1/top2/bottom2/bottom1/file.txt` to `top2/file.txt`.
`[1, -1]` would flatten `top1/top2/bottom2/bottom1/file.txt` to `top2/bottom2/file.txt`.
Please refer to the [Array.slice documentation](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/slice) for a detailed description.
**!** If you're using both `options.includeParents` combined with `options.subPath`
please note that `options.includeParents` is applied first.
## License
MIT