fix-excel-sheet-name/README.md

This package fixes MS-Excel sheet name by limiting it to 31 characters, empty sheet name, and removing illegal characters such as :\/?*[] and more.

# Fix Excel Sheet Name
This package fixes MS-Excel sheet name by limiting it to 31 characters, empty sheet name, and removing illegal characters such as :\\/?*[] and more.
    
[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Test Coverage][coveralls-image]][coveralls-url]
[![Dependencies][dependencies-image]][dependencies-url]
[![DevDependencies][dependencies-dev-image]][dependencies-dev-url]
[![JavaScript Style Guide][standard-image]][standard-url]

## Installation (via [npm](https://www.npmjs.com/package/fix-excel-sheet-name))

```bash
$ npm install --save fix-excel-sheet-name
```

## Usage

The package supports ES5 or later.  The example below is using ES6 features.  

```javascript
const fixExcelSheetName = require('fix-excel-sheet-name')

const sheetName = 'Is it too long?? Excel/MS Excel sheets have some strange name limitations...'
fixExcelSheetName(sheetName, {
  empty: 'missing sheet name',
  omission: ' - END',
  replacement: '_'
}) // 'Is it too long__ Excel_MS - END'
```

* __sheetName__ (required) - the excel sheet name you want to fix.
* __empty__ (optional) - sheet name in case given name is missing (empty string).  Default empty sheet name: "<empty>"
* __omission__ (optional) - MS Excel sheet names are limited to 31 characters.  The last characters of the truncated sheet name are replaced with the omission string which defaults to “…”.
* __replacement__ (optional) - MS Excel sheet names cannot include some characters such as !*: and more.  The given parameter will be used to replace those illegal characters.

### License
[MIT](https://spdx.org/licenses/MIT.html)

### Author
[Oron Nadiv](https://github.com/OronNadiv) ([oron@nadiv.us](mailto:oron@nadiv.us))

[dependencies-image]: https://david-dm.org/OronNadiv/fix-excel-sheet-name/status.svg
[dependencies-url]: https://david-dm.org/OronNadiv/fix-excel-sheet-name
[dependencies-dev-image]: https://david-dm.org/OronNadiv/fix-excel-sheet-name/dev-status.svg
[dependencies-dev-url]: https://david-dm.org/OronNadiv/fix-excel-sheet-name?type=dev
[travis-image]: http://img.shields.io/travis/OronNadiv/fix-excel-sheet-name.svg?style=flat-square
[travis-url]: https://travis-ci.org/OronNadiv/fix-excel-sheet-name
[coveralls-image]: http://img.shields.io/coveralls/OronNadiv/fix-excel-sheet-name.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/OronNadiv/fix-excel-sheet-name
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[standard-url]: http://standardjs.com
[npm-image]: https://badge.fury.io/js/fix-excel-sheet-name.svg
[npm-url]: http://badge.fury.io/js/fix-excel-sheet-name