zengxianbing / modjs

JavaScript Workflow Tooling For Web

Mod is a task-based workflow tooling for web, it helps developers quickly build robust and high-performance HTML5 applications.

Why modjs?

• Focus on the workflow of web development
• Much built-in tasks, most pleasant out-of-the-box experience
  • Built-in source minify: JS, CSS, HTML
  • Built-in modular JS compile: AMD, CMD (will support ES6 Module, CommonJS Module soon)
  • Built-in CSS @import file combination
  • Built-in source stripping, automatically remove debugging code
  • Built-in basic file operation: cat, rm, mv, mkdir, cp, rev
  • Built-in file watcher, trigger custom tasks when file change
  • Built-in live browser reloads, instantly see changes in your browser
  • Built-in web server with very useful feature like remote logging for mobile development
• More simplicity plugin mechanism, auto-install plugins
• Configuration less(even zero), do more
  • Build by html: mod build index.html
• Compatible with Grunt plugins, with literally hundreds of plugins to choose from

Installation

Mod is installed using NPM(Node Package Manager)

$ npm install modjs -g

Tutorials

• Getting Started
• Configuring Tasks
• Creating Plugins

Documents

• Built-in Task
• Plugin API

Quick Build Demo

• Plain Project Build
• Mobile Project Build
• RequireJS Project Build
• SeaJS Project Build

Built-in Task Examples

• Concatenate JS Files
• Concatenate CSS Files
• AMD Modules Compile
• CMD Modules Compile
• Mutil-page Modules Compile
• JS Conditional Compilation
• CSS Conditional Compilation
• HTML Conditional Compilation
• JS Minify
• CSS Minify
• HTML Minify
• Code Stripping
• EOL Stripping
• Tab Stripping
• Inline Images DataURI
• Make Dir
• Copy Files
• String Replace

Plugins Examples

• NPM Task: mod-stylus
• Local Task: mytask.js
• Grunt Task: grunt-contrib-concat

Built-in Web Server Examples

• Server with remote logging for mobile development
• Server with proxy setting

IDE Support

• Sublime-Mod

Platform Support

Mod support Windows, OS X, Linux...

Issue Submission

Submit a new issue.

About

Mod is an open-source project by Tencent which builds on top of Node.js. We utilize a number of useful open-source solutions including:

• UglifyJS
• CleanCSS
• HTMLMinifiler
• RequireJS
• SeaJS
• JSConsole

Used by people within (JOIN US)

License

Mod is released under a MIT license.