Yet another text obfuscator and the biggest enemy of the spellchecker
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build
src
tests
.gitignore
LICENSE.txt Added LICENSE.TXT Apr 29, 2017
README.md
gulpfile.js
package.json

README.md

Install

npm install spellfucker --save

Include

NodeJS

const spellfucker = require('spellfucker');

Browser

<script src='node_modules/spellfucker/build/spellfucker.js' type='text/javascript'></script>

...or use ES6 import

Use

const result = spellfucker('your string of text'); 
// returns something like "jor stryngue hoph thexd"

Contribute

Fork the project. The most challenging part is the replacement library. It is suggested to polish the original English version first. The perfect shape of the replacement matrix should look like this:

---------------
|"ck","k","kh"|
|"k","ck","kh"|
|"kh","ck","k"|
---------------

The size of the sample matrix above is N=3. The bigger N is, the better. You get the point.

Source files are in src folder. Please leave the build folder untouched to avoid merge conflicts.

# run a quick test
npm run quicktest
# or run a custom test
node -e 'console.log(require("./src/spellfucker.js")("to test some text"))'
# or run a custom test with debugging
node -e 'console.log(require("./src/spellfucker.js")("division",{debug:3}))'

Contributors

  • @dawsbot - Improved Readme
  • @DennyDai - The very first contributor, fixed a nasty bug in the library

Learn more

https://spellfucker.com/