<commit_before># Cartridge SVGs [![Build Status][travis-image]][travis-url]

> SVG expansion pack for [Cartridge](https://github.com/cartridge/cartridge)

To use this module, you will need cartridge-cli installed and have a cartridge project setup.

## Installation
```sh
npm install cartridge-svgs --save-dev
```

```sh
npm uninstall cartridge-svgs --save-dev
```

## Dependencies

This module adds the following to a project:

* Prevent pipe breaking caused by errors from gulp plugins using [gulp-plumber](https://www.npmjs.com/package/gulp-plumber)
* Create SVG sprites using [gulp-svg-sprite](https://www.npmjs.com/package/gulp-svg-sprite)
* Allow node files to be prepended with [prepend-file](https://www.npmjs.com/package/prepend-file)

## Config

This module uses many of the same options that are available in the gulp-svg-sprite plugin. The [documentation](https://github.com/jkphl/gulp-svg-sprite) for this plugin may provide some useful information on the usage and configuration of this module. 

Once installed, the config file `task.svgs.js` is created and stored in the _config directory in the root of your cartridge project. Use this file to alter the config of the module.

# Default config options

```
var taskConfig = {
		src: projectConfig.paths.src.svgs + '*.svg', // Source of SVGs
		dest: projectConfig.paths.dest.svgs + '/_objects/_objects', // Output directory for SVGs

		mode: {
        	css: { // Activate the «css» mode
            	dest: '_source/styles/_objects', // Output of SVG sprite CSS file
            	render: {
                	scss: true, // Activate SCSS output
            	},
            	example: false // Deactivate example HTML file
        	},

        	// Deactivated output modes
        	view: false,
        	defs: false,
        	symbol: false,
        	stack: false
    	},
	};
```

### Commit message standards [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
Try and adhere as closely as possible to the [Angular commit messages guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines).

[Commitizen](https://github.com/commitizen/cz-cli) is a command line tool which can help with this:
```sh
npm install -g commitizen
```
Now, simply use `git cz` instead of `git commit` when committing.


[travis-url]: https://travis-ci.org/cartridge/base-module
[travis-image]: https://travis-ci.org/cartridge/base-module.svg?branch=master
<commit_msg>WIP. Readme<commit_after># Cartridge SVGs [![Build Status][travis-image]][travis-url]

> SVG expansion pack for [Cartridge](https://github.com/cartridge/cartridge)

To use this module, you will need cartridge-cli installed and have a cartridge project setup.

## Installation
```sh
npm install cartridge-svgs --save-dev
```

```sh
npm uninstall cartridge-svgs --save-dev
```

## Dependencies

This module adds the following to a project:

* Prevent pipe breaking caused by errors from gulp plugins using [gulp-plumber](https://www.npmjs.com/package/gulp-plumber)
* Create SVG sprites using [gulp-svg-sprite](https://www.npmjs.com/package/gulp-svg-sprite)
* Allow node files to be prepended with [prepend-file](https://www.npmjs.com/package/prepend-file)

## Config

This module uses many of the same options that are available in the gulp-svg-sprite plugin. The [documentation](https://github.com/jkphl/gulp-svg-sprite) for this plugin may provide some useful information on the usage and configuration of this module. 

Once installed, the config file `task.svgs.js` is created and stored in the _config directory in the root of your cartridge project. Use this file to alter the config of the module.

### Default config options

```
var taskConfig = {
		src: projectConfig.paths.src.svgs + '*.svg', // Source of SVGs
		dest: projectConfig.paths.dest.svgs + '/_objects/_objects', // Output directory for SVGs

		mode: {
        	css: { // Activate the «css» mode
            	dest: '_source/styles/_objects', // Output of SVG sprite CSS file
            	render: {
                	scss: true, // Activate SCSS output
            	},
            	example: false // Deactivate example HTML file
        	},

        	// Deactivated output modes
        	view: false,
        	defs: false,
        	symbol: false,
        	stack: false
    	},
	};
```

#### Header 4

### Commit message standards [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
Try and adhere as closely as possible to the [Angular commit messages guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines).

[Commitizen](https://github.com/commitizen/cz-cli) is a command line tool which can help with this:
```sh
npm install -g commitizen
```
Now, simply use `git cz` instead of `git commit` when committing.


[travis-url]: https://travis-ci.org/cartridge/base-module
[travis-image]: https://travis-ci.org/cartridge/base-module.svg?branch=master

{'fraction_non_alphanumeric': 0.1198893936401343, 'fraction_numerical': 0.00019751135690302193, 'mean_word_length': 3.4073107049608353, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 20, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6376933', 'n_tokens_mistral': 1597, 'n_tokens_neox': 1499, 'n_words': 483}