https://github.com/thedaviddias/gulp-json-concat

⚡️ Combine several JSON files into one with Gulp
https://github.com/thedaviddias/gulp-json-concat

concat concatenation gulp gulp-plugin json json-concat json-files

Last synced: 3 months ago
JSON representation

⚡️ Combine several JSON files into one with Gulp

• Host: GitHub
• URL: https://github.com/thedaviddias/gulp-json-concat
• Owner: thedaviddias
• License: mit
• Created: 2015-07-29T13:53:46.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2023-02-27T16:31:00.000Z (almost 2 years ago)
• Last Synced: 2024-10-19T09:39:15.922Z (4 months ago)
• Topics: concat, concatenation, gulp, gulp-plugin, json, json-concat, json-files
• Language: JavaScript
• Homepage:
• Size: 52.7 KB
• Stars: 11
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [gulp](https://gulpjs.com)-json-concat

[![Build Status](https://travis-ci.org/thedaviddias/gulp-json-concat.svg?branch=master)](https://travis-ci.org/thedaviddias/gulp-json-concat)

[![Coverage Status](https://coveralls.io/repos/github/thedaviddias/gulp-json-concat/badge.svg?branch=master)](https://coveralls.io/github/thedaviddias/gulp-json-concat?branch=master)

[![Dependencies](https://david-dm.org/thedaviddias/gulp-json-concat.png)](https://david-dm.org/thedaviddias/gulp-json-concat)

[![Known Vulnerabilities](https://snyk.io/test/github/thedaviddias/gulp-json-concat/badge.svg)](https://snyk.io/test/github/thedaviddias/gulp-json-concat)

[![npm module downloads per month](http://img.shields.io/npm/dm/gulp-json-concat.svg)](https://www.npmjs.org/package/gulp-json-concat)

> Combine several JSON files with Gulp

gulp-json-concat is a fork of [gulp-jsoncombine](https://www.npmjs.com/package/gulp-jsoncombine) with new few options.

## Install

[![NPM](https://nodei.co/npm/gulp-json-concat.png?compact=true)](https://www.npmjs.org/package/gulp-json-concat)

```shell

$ npm install --save-dev gulp-json-concat

```

## Usage

You can combine json files that are in subfolders. The json generated will remove the name of these folders to keep only the name of the file.

```js

var gulp = require('gulp');

var jsonConcat = require('gulp-json-concat');

gulp.task('json', function () {

  return gulp.src('db/**/*.json')

    .pipe(jsonConcat('db.json',function(data){

      return new Buffer(JSON.stringify(data));

    }))

    .pipe(gulp.dest('dist/json'));

});

```

## API

### jsonConcat(fileName, processor)

#### fileName

Type: `String`

The output filename.

#### processor

Type: `Function`

The function that will be called with the dictionary containing all the data from the processes JSON files, where the keys of the dictionary, would be the names of the files (sans the '.json' postfix).

The function should return a new `Buffer` that would be writter to the output file.

## Changelog

### 0.2.0 Update

* Update dependencies

### 0.1.1 Update and corrections

* Update dependencies

* Fix relative path + filename on macOs (thanks to @cmandlbaur)

* Update travis.yml, editorconfig and package.json

* Add new badges (Coveralls, Snyk)

### 0.0.4 Add jsonlint

* Analyse json files and show exactly wehre is the error

### 0.0.1 Initial release

* initial code

## License

MIT © 2017 [David Dias](http://thedaviddias.me)