tit4tat

Simple utility to replace strings in text files. The replacements are meant to be reversible, but this is not enforced

E.g. usages:

• Comment/uncomment log statements
• Simple obfuscation of variable/function names

Install

$ npm i --save-dev tit4tat

How to use

• The replacement rules must be defined in a json file specified with --config.
  E.g. to replace all occurences of AAA by BBB:

    {"rules":[
        {"s":"AAA",
         "f":"BBB" }
    ]}

• By default --order=fwd, so each rule replaces all occurence of s by f, and the rules are applied in sequence,

• If you wish to perform the reverse operation, --order=bwd will cause the rules to be applied in reverse sequence and each rule to replace f by s

... that's it

Simple example:

How to comment/uncomment console.log statements. (it wont work for multi-line statements)

unlog.json :

{

  "rules":[{
    "s":"console.log",
    "f":"//UNLOGconsole.log"
    }
  ]
}

To comment all console.log statements in all text files found in src folder and sub-folders:

$ node_modules/tit4tat/bin/tit4tat-cli.js --inplace --config=unlog.json

To restore the console.log statements:

$ node_modules/tit4tat/bin/tit4tat-cli.js --inplace --config=unlog.json  --order bwd

Explanation of default output

    reading options from tools/obfuscate-dist.json  
    src:dist/           
    * ti	./bundle.js
      ti	./index.html

    ^ ^^
    | ||
    | | \
    | |  File was (i)ncluded or(e)xcluded by filters test
    | \
    |  File type is either (t)ext or (b)inary
    \
     * in first col indicates that a replacement rule was applied
     

Options

$ node node_modules/tit4tat/bin/cli.js --help

Input selection:
--src      src folder                                [string] [default: "src"]
--filters  one or more filename filters, e.g. **/*.js                  [array]
--text     only transform text files               [boolean] [default: "true"]

Output selection:
--inplace  in place replacement (like sed -i)      [boolean] [default: "true"]
--out      output folder used when --inplace=false  [string] [default: "/tmp"]

Transformation:
--order     replacement order[string] [choices: "fwd", "bwd"] [default: "fwd"]
--encoding  encoding for text files                [string] [default: "utf-8"]
--config    configuration input file                       [string] [required]

Options:
--help     Show help                                                 [boolean]
--version  Show version number                                       [boolean]
--verbose  dumps useless traces                     [boolean] [default: false]
--quiet    dont dump anything on stdout             [boolean] [default: false]

In addition to rules, the json config file can specify the same options as in command line args. e.g.

{
   'text':false,
   'inplace':true,
    ...
   'rules':{
    ...

Caveat emptor

When using --inplace=true, this utility will modify your files ... backup recommended