README

Proder

Proder is a tiny DevOps tool to build a production version of development directory smartly. (less than 3 kb !)

Proder simply separates your production version of working directory without garbadge files, source files, modules and confidential files. Rename, move and exclude files using custom configuration file. You can compress your production into zip / tar too.

All everything is in a single command!

Installation

Use the package manager npm to install Proder from your terminal

npm i -g proder

Install Proder globally to use CLI functionalities from your terminal

Commands

Show help

proder --help
# or
proder -h

Show version

proder --version
# or
proder -v

Build directory

proder --build
# or
proder -b

Compress

proder -b --compress
# or
proder -b -c       #will compress into zip

Compress custom format

proder -b --compress=tar       # zip|tar|false

Configuration

Initialize configuration

proder --init
# or
proder -i

Initilizing proder will create the default configuration file in root directory

If your configuration file is proder.config.js, then you don't need to mention file path to CLI

Configuration explaination

module.exports = {
    "src": "",                  // path to root working directory, "" means current directory; default is ""
    "build": "build",           // path to build directory or compressed file name; default is current directory name
    "compress": {               // set false to disable compressing; default is true
        "extension": "zip",     // zip | tar ; default is zip
        "level" : "high"        // high | low | medium; default is high
     },
    "exclude": [                // exclude files and directory from build; default is []
        "node_modules",
        ".git",
        "src/scss/*"            // supports regular expression
    ],          
    "move": [                   // move or rename directories or files; default is []
        [
            "from/path/block.js", "to/path/index.js"
        ] 
    ]              
}

Custom Configuration

Supports custom configuration, just mention new configuration file to cli

proder -b --config=path/to/config

You can use common_excludes list from Proder

const { common_excludes } = require("proder) 

module.exports = { 
    "build": "build",
    "exclude": [...common_excludes]
}

You can try console.log(common_excludes) to show that exactly inside the list

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Make a request at Proder GIT on github public repository

Please make sure to update tests as appropriate.

Published by Jafran Hasan

License

MIT Public

Usage no npm install needed!