TCompile v0.4.8

TCompile is a compress/merge tool for ctrip/Taocan project. It will compress the module and merge the dependent modules into the main module.

Quick Start

• Install: Run the npm command: npm install -g tcompile
• Run the Tcompile init command to initialize the tool configuration.
• Run the Tcompile command in shell.

Commands

Tcompile [filename1][,filename2][,..].

This command will excute the follow steps:

• First, compress the source files in the src directory;
• Second, merge the dependences required in the source files;
• Last, write content into the target files and check in.

Tcompile -tools [filename1][,..] or Tcompile -mods [filename1][,..].

Used in the situation that compile the tool modules and common business modules.

Tcompile -compress [filename1][,..]

Compress the specified files that doesnt rely on the directories which were defined in the config file.

Tcompile -init

This command will help you initialize the tool.

• config: build a repl to set tool configuration.
• showConfig: show out the currently used config object.
• setProject <project>: use the specified configuation.

Tcompile -help

It will show you the usage of the commands.

Tcompile -doc

It will make the documents of your project codes by using jsdoc3. The source path and destination path are both configuated in the config.json. If you want to use this feature, make sure you write comments in jsdoc style.

Tcompile -watch

Monitor the view files in specified directory, if the file change, compile it into the views.js.

Config details

• mail: the email signature which will be added to the head of the compressed file

• jsdoc: see how to configuate it in http://usejsdoc.org/about-configuring-jsdoc.html

• template: the configuation used when compiling related view templates

• projectConfig: the projects table

    {
        "mail": "[email protected]",
        "CRLF": "\r\n",
        "checkinAfterSave": false,
        "path": {
            "project": "d:\\Users\\shiz\\Desktop\\T-compile\\test",
            "docs": "d:\\Users\\shiz\\Desktop\\T-compile\\test\\docs"
        },
        "projectConfig": {
            "online": "d:\\Users\\shiz\\Desktop\\online.json",
            "test": "d:\\Users\\shiz\\Desktop\\test.json"
        },
        "jsdoc": {
            "source": {
                "includePattern": ".+\\.js$",
                "excludePattern": "(^|\\/|\\\\)_|(docs|min)\\\\"
            }
        },
        "template": {
            "name": "handlebars",
            "partialExt": "partial.html",
            "ext": "html"
        }
    }

Tips

• In order to merge the dependences into the main module, make sure that the module definition match the seajs CMD pattern.
• The tool will also checkout/checkin the target file. So you dont have to care about the tfs stuff.