counterstrings v1.0.2

counterstrings

A simple JavaScript module for generating "counterstrings" based on the blog post "Counterstrings: Self-Describing Test Data" by James Bach.

A counterstring is a graduated string of arbitrary length. No matter where you are in the string, you always know the character position. This comes in handy when you are pasting huge strings into fields and they get truncated at a certain point. You want to know how many characters that is.

Installation

NPM

npm install counterstrings --save-dev

Yarn

yarn add counterstrings --dev

GitHub

git clone https://github.com/straurob/counterstrings.js.git project_name
cd project_name
npm run compile

In Browser

Include the script from your local file system:
<script src="counterstrings.min.js"></script>

Or use the jsDelivr CDN:
<script src="https://cdn.jsdelivr.net/npm/counterstrings@latest/dist/counterstrings.min.js"></script>

Usage

generateCounterstring(length) or
generateCounterstring(length, marker)

length: Length of the counterstring to be generated (>= 2) marker: Character used as marker

A TypeError is thrown if one of the parameters is invalid.

Examples

const cs = require("counterstrings");
result = cs.generateCounterstring(56, "*");
console.log(result);

This will generate the following where the last asterisk represents the end of a 56 character long string. 2*4*6*8*11*14*17*20*23*26*29*32*35*38*41*44*47*50*53*56*

Whereas cs.generateCounterstring(18, "*"); will generate:
2#4#6#8#11#14#17#2

How To Contribute

Open an issue (bug, feature request, whatever) for discussion. Or add your code... 1. Fork this repository. 2. Create a new feature branch: git checkout -b my-feature 3. Commit your changes: git commit -am "Add my feature" 4. Push it: git push origin my-feature 5. Open a pull request.

Issues

Please check the issue list for reporting bugs, feature requests, etc.