Currently, there are no unit tests for option {random: true}. Should discuss possible test checks for this option.

Mockingcase has a bindings for ReasonML / bucklescript, bs-mockingcase.
Issue is described here strdr4605/bs-mockingcase#1

• 1. Should the mOcKiNgCaSe be exported as default?
• 2. Should the mOcKiNgCaSe function be renamed in mockingcase?
• 3. For consistency, should the Definition file, Main file and Test file have all index or mockingcase name?

This error is showing up when the package is used from CDN

Possible CDNs to work with:

DO TO:

• Fix the error
• Add tests
• Add example of CDN usage in README

Currently, the package converts even positions of characters to lowercase and odd positions to uppercase.
firstUpper options should reverse the converting pattern.
Example:

const mOcKiNgCaSe = require('mockingcase');
mOcKiNgCaSe('example'); // eXaMpLe
mOcKiNgCaSe('example', {firstUpper: true}); //  ExAmPlE

if both random and firstUpper options are set to true first character should always be uppercase

mOcKiNgCaSe('42foo!bar', {letters: true});
//=> 'fOoBaR'
mOcKiNgCaSe('foo bar 42', {letters: true});
//=> 'fOoBaR'

❗ Maybe think about a better name for option

At the moment the String.prototype.toMockingCase() does not support packages options ({random: true, ...}).
Also better to use arrow function for it.
https://github.com/strdr4605/mockingcase/blob/master/index.js#L76

At the moment overriding default options from mOcKiNgCaSe.config

const options = overridedDefaultOptions || defaultOptions;

maybe is better to merge defaultOptions with overridedDefaultOptions and NOT just replace it?!

Description (Motivation)

As "options" param is used in several functions and writing each time

/**
 * @param {object} [options={random: false,  onlyLetters: false, firstUpper: false, upper: null, lower: null}] Conversion options.
 * @param {boolean} options.random=false - If case conversion should be randomized.
 * @param {boolean} options.onlyLetters=false - If non letters characters should be removed.
 * @param {boolean} options.firstUpper=false - If the first letter should be capitalized instead of the second when converting to mOcKiNgCaSe (e.g. MoCkInGcAsE). When combined with options.random, the first letter of the random string will be capitalized.
 * @param {(string | RegExp)} options.upper=null - Characters or substring set to change to uppercase
 * @param {(string | RegExp)} options.lower=null - Characters or substring set to change to lowercase
*/

is not good approach as somewhere it can be missed (forgotten to update), which can lead to confusion in types.
Creating a typedef and using it where it is needed is the way to go.

Possible solution

Not sure yet but maybe examples from https://jsdoc.app/tags-typedef.html can help

TODO:

• Add @typedef for options (problable at the beginning of the file)
• Replace type of params with new @typedef for options
• Check generated markdown with jsdoc2md and maybe update README

As the repo has a lot of files, it became a little messy. In discussion #52 (comment)
I think is better to add an src folder with this structure

• src
  • mockingcase.d.ts
  • mockingcase.js
  • mockingcase.test.js

TO DO:

• Create src folder
• Rename and move main files to src folder
• Update package.json
• Check that tests, pre-commit, prettier and eslint works properly
• Check that Declaration Files for Typescript works properly

https://jshint.com/ says that this is the best practice

(function () {
  'use strict';
  
  /**
   * This function receives a string input and converts it to mOcKiNgCaSe.
   * @param {string} input - string to be converted
   * @param {object} [options={random: false}] - options for converting
   * @param {boolean} options.random=false - using random for converting
   * @returns {string} string in mOcKiNgCaSe
   */
  function mOcKiNgCaSe(input, options) {
    options = Object.assign({
      random: false
    }, options);
    
    return input.replace(/./g, function (s, i) {
      if(options.random) return Math.round(Math.random()) ? s.toUpperCase() : s.toLowerCase();
      else return i % 2 ? s.toUpperCase() : s.toLowerCase();
    });
  }
  
  module.exports = mOcKiNgCaSe;
})();  

should think if to add jshint.json or eslint

Useful links:

• https://help.github.com/en/articles/creating-issue-templates-for-your-repository
• https://help.github.com/en/articles/creating-a-pull-request-template-for-your-repository
• https://embeddedartistry.com/blog/2017/8/4/a-github-pull-request-template-for-your-projects

When clicking on the Browser Usage from API table of contents it does not jump to the sections

A possible solution is to add a a tag like in this example

- [mOcKiNgCaSe(input, [options]) ⇒ <code>string</code>](#mOcKiNgCaSe)

<a name="mOcKiNgCaSe"></a>

Would be good to have a config function that can be used to create default options.
For example instead of:

const mOcKiNgCaSe = require('mockingcase');
mOcKiNgCaSe('foo bar42', {onlyLetters: true, firstUpper: true});
//=> 'FoO BaR'

mOcKiNgCaSe('foo bar', {firstUpper: true});
//=> 'FoO BaR'

to have this possibility:

const mOcKiNgCaSe = require('mockingcase').config({onlyLetters: true, firstUpper: true});
// const mOcKiNgCaSe = require('mockingcase');
// mOcKiNgCaSe.config({onlyLetters: true, firstUpper: true});

mOcKiNgCaSe('foo bar42');
//=> 'FoO BaR'

mOcKiNgCaSe('foo bar');
//=> 'FoO BaR'

and when including options for a specific case, to override selected config options:

const mOcKiNgCaSe = require('mockingcase').config({onlyLetters: true, firstUpper: true});
// const mOcKiNgCaSe = require('mockingcase');
// mOcKiNgCaSe.config({onlyLetters: true, firstUpper: true});

mOcKiNgCaSe('foo bar42');
//=> 'FoO BaR'

mOcKiNgCaSe('foo bar42', {onlyLetters: false, firstUpper: false});
//=> 'fOo bAr42'

config function should return modified mOcKiNgCaSe

TO DO:

• Add config function and its implementation.
• Comment it using jsdoc
• Add 2-3 unit tests for this behavior
• Add declaration of config function for Typescript, Declaration Files
• Add usage and describe config function in README

Add ⬆️ to every section.

[:arrow_up:](#api)

Having subsections links (Self Hosting, CDN Usage) in the table of contents for Browser Usage is not so important.

Better to remove them as Browser Usage is short enough to read every subsection.

Option object should have these fields:
upper should be of type string or instanceof RegExp
lower should be of type string or instanceof RegExp
else

throw TypeError(`options.upper: Expected string or RegExp but got "${typeof upper}"`);

The RegExp will be created as:

if (options.upper) const upperRegExp = new RegExp(options.upper, 'gi');
if (options.lower) const lowerRegExp = new RegExp(options.lower, 'gi');

Possible solution:

Step 1:
Convert the input with default behavior (even prostion: lowerCase; odd position: upperCase)
or if any option is present that do it first:

• remove non letters if onlyLetters
• odd prostion: lowerCase; even position: upperCase if firstUpper
• random case if random

Step 2:

return step1Input
.replace(lowerRegExp, toLowerCase).
.replace(upperRegExp, toUpperCase);

upper has a higher priority so convert letters that much that regex after conversion of lower

Expected:

mockingcase("Hello World", { upper: "worl" });
// "hElLo WORLd"
mockingcase("Hello World", { upper: /worl/ });
// "hElLo WORLd"

mockingcase("Hello World", { upper: "[worl]" });
// "hELLO WORLd"
mockingcase("Hello World", { upper: /[worl]/ });
// "hELLO WORLd"

mockingcase("Hello World", { upper: /[worl]/, firstUpper: true });
// "HELLO WORLd"

TO DO:

• Add upper and lower options and implement them.
• Comment options using jsdoc
• Add unit test for upper and lower options
• Add declaration of upper and lower options for Typescript, Declaration Files
• Add usage and describe upper and lower options in README

Status:

@cukejianya is working on this!

Description (Motivation)

Currently, default values for upper and lower options are null, but in jsdocs type is set to string or RegExp. Probably this is not correct.

Possible solution

Change the default value to be the empty string ''.

TODO:

• Implement changes
• Comment using jsdoc
• Update docs in README

If the input is not provided the default value for it should be something like:
iNpUt iS UnDeFiNeD

const mockingcase = require('mockingcase');
mockingcase();
// => 'iNpUt iS UnDeFiNeD'

OR maybe throw an error like for array of string case

TO DO:

• Add defaut input value for input to main function
• Add default input value in jsdoc
• Add unit test for checking default input value
• Add usage and describe about default input value in README

1. Randomness
2. Another type of randomness
3. specific offset
4. ...

Would be nice to have a function that we can call like

const mOcKiNgCaSe = require('mockingcase');

const text = mOcKiNgCaSe('foo-bar');
console.log(text); // fOo-bAr

mOcKiNgCaSe.log('foo-bar'); // fOo-bAr

example and possible solution:

function a() {
	a.log = () => console.log('A');
	return 'a';
}

let f = a;
console.log(f()); // a
f.log(); // A

Would be nice to have a functionality that overrides all console.logs.
Example:

mockingcase.overrideConsole();
console.log('Hello'); // hElLo

TO DO:

1. Let the overrideConsole return the mockingcase object as overrideString so it can be used at importing like:

const mOcKiNgCaSe = require('mockingcase').overrideConsole();
console.log('foobar')
// => 'fOoBaR'
mOcKiNgCaSe('foobar');
// => 'fOoBaR'

2. Add jsdoc and unit tests
3. Add overrideConsole in the index.d.ts file, so it can be used with typescript
4. Add usage in README after

// Optionally create String.prototype.toMockingCase
mOcKiNgCaSe.overrideString();

'foo_bar'.toMockingCase();
//=> 'fOo_bAr'

@strdr4605 Hey would be nice if you upload the linter config you are using so that everybody can use the same.

Originally posted by @RicardoE105 in #42 (comment)

The Usage section is too big and it could grow in future.
In the main Usage section only mOcKiNgCaSe(input, [options]) usage should be sampled.

Usages for others functionalities of the package should be sampled bellow the API description of functions parameters.

Would be nice to use this package as a 1st of April Joke. By using this package in any frontend library/framework build with npm.

A possible solution is to check if it is a frontend app and has HTML, them finding every text on the page and convert it to mockingcase!

Welcome for discussions on this topic! 😊

TO DO:

• Pick a good name for the function
• Implement the functionality that will change all text (after each DOM update)
• Comment the function using jsdoc
• Add unit test for the function
• Add declaration of the function for Typescript, Declaration Files
• Add usage and describe the function in README

Update:

Found a solution to select all nodes with text from a page.
https://stackoverflow.com/questions/2579666/getelementsbytagname-equivalent-for-textnodes#2579869

Update2:

related topic: https://stackoverflow.com/questions/3219758/detect-changes-in-the-dom

Another cool idea would be to call mockingcase from String object

"foobar".toMockingCase();
// => 'fOoBaR'

maybe to override String object by default when importing package

require('mockingcase');

or by calling an obvious function

require('mockingcase').overrideString();

If user somehow whats to use both implementations, overrideString() should return also main function of the package

const mOcKiNgCaSe = require('mockingcase').overrideString();
'foobar'.toMockingCase();
// => 'fOoBaR'
mOcKiNgCaSe('foobar');
// => 'fOoBaR'

TO DO:

• Add overrideString() that override String object by adding toMockingCase()
• Comment overrideString() and toMockingCase() using jsdoc
• Add unit test for toMockingCase()
• Add declaration of toMockingCase() for Typescript, Declaration Files
• Add usage and describe overrideString() and toMockingCase() in README

As discussed in #52 and as runkit sample

var mockingcase = require("@strdr4605/mockingcase")

the main function should be renamed in mockingcase

TO DO:

• Change all mOcKiNgCaSe in mockingcase for main file
• Change all mOcKiNgCaSe in mockingcase for test file
• Change all mOcKiNgCaSe in mockingcase in README

create index.d.ts file with types for params and return value
https://github.com/strdr4605/mockingcase/blob/master/index.js