├── .editorconfig
├── .gitignore
├── .npmignore
├── .travis.yml
├── README.md
├── asset
└── Notifier.app
│ └── Contents
│ ├── Info.plist
│ ├── MacOS
│ └── Notifier
│ ├── PkgInfo
│ └── Resources
│ ├── Terminal.icns
│ └── en.lproj
│ ├── Credits.rtf
│ ├── InfoPlist.strings
│ └── MainMenu.nib
├── bin
├── .gitattributes
├── mod
├── mod-debug.cmd
└── mod-dev.cmd
├── doc
├── README.md
├── api
│ ├── README.md
│ ├── exports.md
│ ├── file.md
│ ├── template.md
│ └── utils.md
├── tasks
│ ├── README.md
│ ├── build.md
│ ├── cat.md
│ ├── compile.md
│ ├── cp.md
│ ├── create.md
│ ├── deploy.md
│ ├── download.md
│ ├── hash.md
│ ├── help.md
│ ├── init.md
│ ├── lint.md
│ ├── min.md
│ ├── mkdir.md
│ ├── mv.md
│ ├── pack.md
│ ├── replace.md
│ ├── rev.md
│ ├── rm.md
│ ├── server.md
│ ├── strip.md
│ └── watch.md
├── template
│ ├── README-api.md
│ ├── README-task.md
│ ├── README.md
│ ├── api.md
│ └── task.md
└── tutorial
│ ├── configuring-tasks.md
│ ├── creating-plugins.md
│ └── getting-started.md
├── example
├── buildmobile
│ ├── Modfile.js
│ ├── README.md
│ ├── css
│ │ ├── base.css
│ │ └── main.css
│ ├── img
│ │ └── icon.png
│ ├── index.html
│ └── js
│ │ ├── ios.js
│ │ ├── main.js
│ │ └── var
│ │ ├── document.js
│ │ ├── location.js
│ │ ├── navigator.js
│ │ └── zepto.js
├── buildnormal
│ ├── Modfile.js
│ ├── README.md
│ ├── css
│ │ ├── base.css
│ │ └── main.css
│ ├── img
│ │ └── icon.png
│ ├── index.html
│ └── js
│ │ ├── bar.js
│ │ ├── baz.js
│ │ ├── corge.js
│ │ ├── foo.js
│ │ ├── quux.js
│ │ └── qux.js
├── buildrequirejs
│ ├── Modfile.js
│ ├── README.md
│ ├── css
│ │ ├── base.css
│ │ └── main.css
│ ├── index.html
│ └── js
│ │ ├── $.js
│ │ ├── main.js
│ │ └── standalone.js
├── buildseajs
│ ├── Modfile.js
│ ├── README.md
│ ├── css
│ │ └── style.css
│ ├── index.html
│ └── js
│ │ ├── main.js
│ │ └── spinning.js
├── catcss
│ ├── Modfile.js
│ ├── bar.css
│ ├── foo.css
│ └── foo.png
├── catjs
│ ├── Modfile.js
│ ├── bar.js
│ └── foo.js
├── compileamd
│ ├── Modfile.js
│ ├── README.md
│ ├── index.html
│ └── js
│ │ ├── asyncModule.js
│ │ ├── main.js
│ │ ├── syncModule.js
│ │ └── var
│ │ ├── $.js
│ │ ├── document.js
│ │ ├── location.js
│ │ └── navigator.js
├── compilecmd
│ ├── Modfile.js
│ ├── index.html
│ └── js
│ │ ├── a.js
│ │ ├── b.js
│ │ ├── c.js
│ │ ├── config.js
│ │ └── main.js
├── compilecss
│ ├── Modfile.js
│ └── conditional.css
├── compilehtml
│ ├── Modfile.js
│ └── conditional.html
├── compilejs
│ ├── Modfile.js
│ └── conditional.js
├── compilemultipage
│ ├── Modfile.js
│ ├── README.md
│ ├── js
│ │ ├── app
│ │ │ ├── controller
│ │ │ │ ├── Base.js
│ │ │ │ ├── c1.js
│ │ │ │ └── c2.js
│ │ │ ├── lib.js
│ │ │ ├── main1.js
│ │ │ ├── main2.js
│ │ │ └── model
│ │ │ │ ├── Base.js
│ │ │ │ ├── m1.js
│ │ │ │ └── m2.js
│ │ ├── common.js
│ │ └── lib
│ │ │ ├── backbone.js
│ │ │ ├── jquery.js
│ │ │ └── underscore.js
│ ├── page1.html
│ └── page2.html
├── configasync
│ ├── Modfile.js
│ ├── foobar.css
│ └── foobar.js
├── configgroup
│ ├── Modfile.js
│ ├── foobar.css
│ └── foobar.js
├── confignestedtargets
│ └── Modfile.js
├── configoptions
│ └── Modfile.js
├── configtemplate
│ ├── Modfile.js
│ ├── bar
│ │ └── b.js
│ ├── baz
│ │ └── c.js
│ └── foo
│ │ └── a.js
├── cp
│ └── Modfile.js
├── datauri
│ ├── Modfile.js
│ ├── test.css
│ └── test.png
├── deployhttp
│ ├── .testskip
│ └── Modfile.js
├── deployssh
│ ├── .testskip
│ └── Modfile.js
├── download
│ └── Modfile.js
├── mincss
│ ├── Modfile.js
│ ├── foo.png
│ └── test.css
├── minhtml
│ ├── Modfile.js
│ └── index.html
├── minjs
│ ├── Modfile.js
│ └── js
│ │ ├── unminify.js
│ │ └── unminify.min.js
├── mkdir
│ └── Modfile.js
├── plugingrunttask
│ ├── Modfile.js
│ ├── bar.js
│ └── foo.js
├── plugininlinetask
│ └── Modfile.js
├── pluginlocaltask
│ ├── Modfile.js
│ └── mytask.js
├── pluginnpmtask
│ ├── Modfile.js
│ └── test.styl
├── replace
│ ├── Modfile.js
│ └── foo.js
├── stripcode
│ ├── Modfile.js
│ └── foo.js
├── stripeol
│ ├── Modfile.js
│ └── foo.js
├── striptab
│ ├── Modfile.js
│ └── foo.js
└── watchstyl
│ ├── .testskip
│ ├── Modfile.js
│ └── styl
│ ├── bar.styl
│ └── foo.styl
├── index.js
├── lib
├── builtin.js
├── config.js
├── generators
│ ├── git
│ │ ├── .gitattributes
│ │ └── .gitignore
│ ├── jquery
│ │ ├── index.js
│ │ ├── {{name}}.jquery.json
│ │ └── {{name}}.js
│ ├── json
│ │ ├── index.js
│ │ └── templates
│ │ │ └── package.json
│ ├── licenses
│ │ ├── Apache-2.0-LICENSE.txt
│ │ ├── GPL-2.0-LICENSE.txt
│ │ ├── MIT-LICENSE.txt
│ │ ├── MPL-2.0-LICENSE.txt
│ │ └── index.js
│ ├── mocha
│ │ └── test
│ │ │ ├── index.html
│ │ │ ├── lib
│ │ │ ├── chai.js
│ │ │ ├── expect.js
│ │ │ └── mocha
│ │ │ │ ├── mocha.css
│ │ │ │ └── mocha.js
│ │ │ ├── runner
│ │ │ └── mocha.js
│ │ │ └── spec
│ │ │ └── spec.js
│ ├── modfile
│ │ └── Modfile.js
│ ├── plugin
│ │ ├── Modfile.js
│ │ ├── README.md
│ │ ├── index.js
│ │ └── {{main_name}}.js
│ ├── readme
│ │ └── README.md
│ └── webview
│ │ ├── index.html
│ │ ├── index.js
│ │ ├── main.css
│ │ └── main.js
├── options.js
├── plugins.js
├── runner.js
├── tasks
│ ├── build.js
│ ├── cat.js
│ ├── compile.js
│ ├── cp.js
│ ├── datauri.js
│ ├── deploy.js
│ ├── download.js
│ ├── exec.js
│ ├── help.js
│ ├── htmlminifier.js
│ ├── init.js
│ ├── min.js
│ ├── mkdir.js
│ ├── mv.js
│ ├── optimizecss.js
│ ├── replace.js
│ ├── rev.js
│ ├── rm.js
│ ├── search.js
│ ├── strip.js
│ ├── template.js
│ ├── uglifyjs.js
│ └── watch.js
└── utils
│ ├── file.js
│ ├── format.js
│ ├── github.js
│ ├── htmlparser.js
│ ├── index.js
│ ├── logger.js
│ ├── notifier.js
│ ├── sea.js
│ ├── sshclient.js
│ ├── suggester.js
│ └── template.js
├── package.json
└── test
├── apitesting
├── Modfile.js
└── apitesting.js
└── testrunner.js
/.editorconfig:
--------------------------------------------------------------------------------
1 | # This file is for unifying the coding style for different editors and IDEs
2 | # editorconfig.org
3 |
4 | root = true
5 |
6 | [*]
7 | end_of_line = lf
8 | charset = utf-8
9 | trim_trailing_whitespace = true
10 | insert_final_newline = true
11 | indent_style = space
12 | indent_size = 4
13 |
14 | [package.json]
15 | indent_style = space
16 | indent_size = 2
17 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Include your project-specific ignores in this file
2 | # Read about how to use .gitignore: https://help.github.com/articles/ignoring-files
3 |
4 | # Numerous always-ignore extensions
5 | *.diff
6 | *.err
7 | *.orig
8 | *.log
9 | *.rej
10 | *.swo
11 | *.swp
12 | *.vi
13 | *~
14 | *.sass-cache
15 |
16 | # OS or Editor folders
17 | .DS_Store
18 | ._*
19 | Thumbs.db
20 | .cache
21 | .project
22 | .settings
23 | .tmproj
24 | nbproject
25 | *.sublime-project
26 | *.sublime-workspace
27 |
28 | # Dreamweaver added files
29 | _notes
30 | dwsync.xml
31 |
32 | # Komodo
33 | *.komodoproject
34 | .komodotools
35 |
36 | # Espresso
37 | *.esproj
38 | *.espressostorage
39 |
40 | # Rubinius
41 | *.rbc
42 |
43 | # Folders to ignore
44 | .hg
45 | .svn
46 | .CVS
47 | intermediate
48 | publish
49 | .idea
50 | node_modules
51 | dist
52 |
53 |
--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | doc/
2 | test/
3 | example/
4 | node_modules/
5 | .*
6 | *~
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: node_js
2 |
3 | node_js:
4 | - 0.8
5 | - 0.10
6 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | Stopped developping on modjs and switched to
2 |
3 |
4 |
5 |
7 |
8 |
9 |
10 |
13 |
14 | Mod.js is a [task-based](https://github.com/taskjs/spec) workflow tooling for web, it helps developers quickly build robust and high-performance HTML5 applications.
15 |
16 | ## Why Mod.js?
17 | * Focus on the workflow of web development
18 | * Much built-in tasks, most pleasant out-of-the-box experience
19 | - Built-in source minify: `JS, CSS, HTML`
20 | - Built-in modular JS compile: `AMD, CMD (will support ES6 Module, CommonJS Module soon)`
21 | - Built-in CSS @import file combination
22 | - Built-in source stripping, automatically remove debugging code
23 | - Built-in basic file operation: `cat, rm, mv, mkdir, cp, rev`
24 | - Built-in file watcher, trigger custom tasks when file change
25 | * More simplicity plugin mechanism, auto-install plugins
26 | * Configuration less(even zero), do more
27 | - Build by html: `mod build index.html`
28 | * Compatible with [Grunt](http://gruntjs.com) plugins, with literally hundreds of plugins to choose from
29 |
30 | ## Installation
31 | [Mod.js](https://npmjs.org/package/modjs) is installed using [NPM(Node Package Manager)](http://npmjs.org/)
32 | ```sh
33 | $ npm install modjs -g
34 | ```
35 |
36 | ## Tutorials
37 | * [Getting Started](https://github.com/modjs/mod/tree/master/doc/tutorial/getting-started.md)
38 | * [Configuring Tasks](https://github.com/modjs/mod/blob/master/doc/tutorial/configuring-tasks.md)
39 | * [Creating Plugins](https://github.com/modjs/mod/tree/master/doc/tutorial/creating-plugins.md)
40 |
41 | ## Documents
42 | * [Built-in Task](https://github.com/modjs/mod/tree/master/doc/tasks)
43 | * [Plugin API](https://github.com/modjs/mod/tree/master/doc/api)
44 |
45 | ## Quick Build Demo
46 | * [Plain Project Build](https://github.com/modjs/mod/tree/master/example/buildnormal)
47 | * [Mobile Project Build](https://github.com/modjs/mod/tree/master/example/buildmobile)
48 | * [RequireJS Project Build](https://github.com/modjs/mod/tree/master/example/buildrequirejs)
49 |
50 | ## Built-in Task Examples
51 | * [Concatenate JS Files](https://github.com/modjs/mod/tree/master/example/catjs)
52 | * [Concatenate CSS Files](https://github.com/modjs/mod/tree/master/example/catcss)
53 | * [AMD Modules Compile](https://github.com/modjs/mod/tree/master/example/compileamd)
54 | * [CMD Modules Compile](https://github.com/modjs/mod/tree/master/example/compilecmd)
55 | * [Mutil-page Modules Compile](https://github.com/modjs/mod/tree/master/example/compilemultipage)
56 | * [JS Conditional Compilation](https://github.com/modjs/mod/tree/master/example/compilejs)
57 | * [CSS Conditional Compilation](https://github.com/modjs/mod/tree/master/example/compilecss)
58 | * [HTML Conditional Compilation](https://github.com/modjs/mod/tree/master/example/compilehtml)
59 | * [JS Minify](https://github.com/modjs/mod/tree/master/example/minjs)
60 | * [CSS Minify](https://github.com/modjs/mod/tree/master/example/mincss)
61 | * [HTML Minify](https://github.com/modjs/mod/tree/master/example/minhtml)
62 | * [Code Stripping](https://github.com/modjs/mod/tree/master/example/stripcode)
63 | * [EOL Stripping](https://github.com/modjs/mod/tree/master/example/stripeol)
64 | * [Tab Stripping](https://github.com/modjs/mod/tree/master/example/striptab)
65 | * [Inline Images DataURI](https://github.com/modjs/mod/tree/master/example/datauri)
66 | * [Make Dir](https://github.com/modjs/mod/tree/master/example/mkdir)
67 | * [Copy Files](https://github.com/modjs/mod/tree/master/example/cp)
68 | * [String Replace](https://github.com/modjs/mod/tree/master/example/replace)
69 |
70 | ## Plugins Examples
71 | * [NPM Task: mod-stylus](https://github.com/modjs/mod/tree/master/example/pluginnpmtask)
72 | * [Local Task: mytask.js](https://github.com/modjs/mod/tree/master/example/pluginlocaltask)
73 | * [Grunt Task: grunt-contrib-concat](https://github.com/modjs/mod/tree/master/example/plugingrunttask)
74 |
75 | ## IDE Support
76 | * [Sublime-Mod](https://github.com/yuanyan/sublime-mod)
77 |
78 | ## Platform Support
79 | Mod support Windows, OS X, Linux...
80 |
81 | ## Issue Submission
82 | Submit a [new issue](https://github.com/modjs/mod/issues/new).
83 |
84 | ## Release History
85 |
86 | * 2014-02-28 v0.4.6 Fix r.js build error.
87 | * 2014-02-20 v0.4.5 Remove built-in `server` task.
88 |
89 | ## About
90 | Mod is an open-source project by [Tencent](http://www.tencent.com/en-us/) which builds on top of [Node.js](https://nodejs.org).
91 | We utilize a number of useful open-source solutions including:
92 |
93 | * UglifyJS
94 | * CleanCSS
95 | * HTMLMinifiler
96 | * RequireJS
97 |
98 | ## Used by people within (JOIN US)
99 | 
100 |
101 | ## License
102 | Mod.js is released under a [MIT](http://yuanyan.mit-license.org/) license.
103 |
--------------------------------------------------------------------------------
/asset/Notifier.app/Contents/Info.plist:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | BuildMachineOSBuild
6 | 13A2093
7 | CFBundleDevelopmentRegion
8 | en
9 | CFBundleExecutable
10 | Notifier
11 | CFBundleIconFile
12 | Terminal
13 | CFBundleIdentifier
14 | nl.superalloy.oss.Notifier
15 | CFBundleInfoDictionaryVersion
16 | 6.0
17 | CFBundleName
18 | Notifier
19 | CFBundlePackageType
20 | APPL
21 | CFBundleShortVersionString
22 | 1.5.1
23 | CFBundleSignature
24 | ????
25 | CFBundleVersion
26 | 9
27 | DTCompiler
28 | com.apple.compilers.llvm.clang.1_0
29 | DTPlatformBuild
30 | 5A2053
31 | DTPlatformVersion
32 | GM
33 | DTSDKBuild
34 | 13A595
35 | DTSDKName
36 | macosx10.9
37 | DTXcode
38 | 0501
39 | DTXcodeBuild
40 | 5A2053
41 | LSMinimumSystemVersion
42 | 10.8
43 | LSUIElement
44 | NSHumanReadableCopyright
46 | Copyright © 2012 Eloy Durán. All rights reserved.
47 | NSMainNibFile
48 | MainMenu
49 | NSPrincipalClass
50 | NSApplication
51 |
52 |
53 |
--------------------------------------------------------------------------------
/asset/Notifier.app/Contents/MacOS/Notifier:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/modjs/mod/e1215bd34e5f8d610e8ae17542c8e1cbd3c0a75f/asset/Notifier.app/Contents/MacOS/Notifier
--------------------------------------------------------------------------------
/asset/Notifier.app/Contents/PkgInfo:
--------------------------------------------------------------------------------
1 | APPL????
--------------------------------------------------------------------------------
/asset/Notifier.app/Contents/Resources/Terminal.icns:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/modjs/mod/e1215bd34e5f8d610e8ae17542c8e1cbd3c0a75f/asset/Notifier.app/Contents/Resources/Terminal.icns
--------------------------------------------------------------------------------
/asset/Notifier.app/Contents/Resources/en.lproj/Credits.rtf:
--------------------------------------------------------------------------------
1 | {\rtf0\ansi{\fonttbl\f0\fswiss Helvetica;}
2 | {\colortbl;\red255\green255\blue255;}
3 | \paperw9840\paperh8400
4 | \pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\ql\qnatural
5 |
6 | \f0\b\fs24 \cf0 Engineering:
7 | \b0 \
8 | Some people\
9 | \
10 |
11 | \b Human Interface Design:
12 | \b0 \
13 | Some other people\
14 | \
15 |
16 | \b Testing:
17 | \b0 \
18 | Hopefully not nobody\
19 | \
20 |
21 | \b Documentation:
22 | \b0 \
23 | Whoever\
24 | \
25 |
26 | \b With special thanks to:
27 | \b0 \
28 | Mom\
29 | }
30 |
--------------------------------------------------------------------------------
/asset/Notifier.app/Contents/Resources/en.lproj/InfoPlist.strings:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/modjs/mod/e1215bd34e5f8d610e8ae17542c8e1cbd3c0a75f/asset/Notifier.app/Contents/Resources/en.lproj/InfoPlist.strings
--------------------------------------------------------------------------------
/asset/Notifier.app/Contents/Resources/en.lproj/MainMenu.nib:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/modjs/mod/e1215bd34e5f8d610e8ae17542c8e1cbd3c0a75f/asset/Notifier.app/Contents/Resources/en.lproj/MainMenu.nib
--------------------------------------------------------------------------------
/bin/.gitattributes:
--------------------------------------------------------------------------------
1 | * text eol=lf
2 |
--------------------------------------------------------------------------------
/bin/mod:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env node
2 |
3 | var utils = require('../lib/utils/index');
4 | var logger = require('../lib/utils/logger');
5 | var runner = require('../lib/runner');
6 | var config = require('../lib/config');
7 | var colors = require('colors');
8 | var _ = require('lodash');
9 |
10 | var argv = process.argv;
11 | for (var i = 0; i < process.argv.length; i += 1) {
12 | var arg = argv[i];
13 | if (arg === '--debug') {
14 | process.argv.splice(i, 1);
15 | logger.level = 'debug';
16 | } else if (arg === '--no-color' || arg === '--no-colors') {
17 | process.argv.splice(i, 1);
18 | colors.mode = 'none';
19 | var originLog = console.log;
20 | console.log = function () {
21 | var args = _.toArray(arguments);
22 | args.map(function (arg) {
23 | return colors.stripColors(arg);
24 | });
25 | originLog.apply(this, args);
26 | };
27 | } else if (arg === '--force') {
28 | process.argv.splice(i, 1);
29 | logger.force = true;
30 | }
31 | }
32 |
33 | var cmd = argv.slice(2).shift();
34 | if (cmd === '-h' || cmd === '--help') {
35 | cmd = 'help';
36 | }
37 |
38 | if (cmd === '-v' || cmd === '--version') {
39 | var ver = utils.getVersion();
40 | console.log(ver.green);
41 | } else {
42 | config.load({
43 | cmd: cmd
44 | }, function (rc) {
45 | runner.run({
46 | rc: rc,
47 | cmd: cmd
48 | });
49 | })
50 | }
51 |
--------------------------------------------------------------------------------
/bin/mod-debug.cmd:
--------------------------------------------------------------------------------
1 | @IF EXIST "%~dp0\node.exe" (
2 | "%~dp0\node.exe --debug-brk" "%~dp0\mod" %*
3 | ) ELSE (
4 | node --debug-brk "%~dp0\mod" %*
5 | )
--------------------------------------------------------------------------------
/bin/mod-dev.cmd:
--------------------------------------------------------------------------------
1 | @IF EXIST "%~dp0\node.exe" (
2 | "%~dp0\node.exe" "%~dp0\mod" %*
3 | ) ELSE (
4 | node "%~dp0\mod" %*
5 | )
--------------------------------------------------------------------------------
/doc/README.md:
--------------------------------------------------------------------------------
1 | # Documents
2 | ## Tutorials
3 | * [Getting Started](https://github.com/modjs/mod/tree/master/doc/tutorial/getting-started.md)
4 | * [Configuring Tasks](https://github.com/modjs/mod/blob/master/doc/tutorial/configuring-tasks.md)
5 | * [Creating Plugins](https://github.com/modjs/mod/tree/master/doc/tutorial/creating-plugins.md)
6 |
7 | ## Built-in Tasks
8 | Mod supports a powerful set of high-level tasks:
9 |
10 | * [help](https://github.com/modjs/mod/tree/master/doc/tasks/help.md) - get help on mod
11 | * [build](https://github.com/modjs/mod/tree/master/doc/tasks/build.md) - build project with html
12 | * [init](https://github.com/modjs/mod/tree/master/doc/tasks/init.md) - generate project skeleton from template
13 | * [watch](https://github.com/modjs/mod/tree/master/doc/tasks/watch.md) - run predefined tasks whenever watched files change
14 | * [deploy](https://github.com/modjs/mod/tree/master/doc/tasks/deploy.md) - remote deployment via ssh
15 | * [download](https://github.com/modjs/mod/tree/master/doc/tasks/download.md) - download resource from URI
16 | * [compile](https://github.com/modjs/mod/tree/master/doc/tasks/compile.md) - compile JavaScript/CSS/HTML source
17 | * [min](https://github.com/modjs/mod/tree/master/doc/tasks/min.md) - minify JavaScript/CSS/HTML source
18 | * [replace](https://github.com/modjs/mod/tree/master/doc/tasks/replace.md) - replace the contents of files
19 | * [cat](https://github.com/modjs/mod/tree/master/doc/tasks/cat.md) - concatenate the content of files
20 | * [cp](https://github.com/modjs/mod/tree/master/doc/tasks/cp.md) - copy one or more files to another location
21 | * [mkdir](https://github.com/modjs/mod/tree/master/doc/tasks/mkdir.md) - make a new directory
22 | * [mv](https://github.com/modjs/mod/tree/master/doc/tasks/mv.md) - move or rename files or directories
23 | * [rm](https://github.com/modjs/mod/tree/master/doc/tasks/rm.md) - remove files
24 | * [rev](https://github.com/modjs/mod/tree/master/doc/tasks/rev.md) - rename file with it hash value
25 | * [strip](https://github.com/modjs/mod/tree/master/doc/tasks/strip.md) - source stripping
26 |
27 | ## API
28 |
29 | * [exports](https://github.com/modjs/mod/tree/master/doc/api/exports.md) - The exports API
30 | * [exports.file](https://github.com/modjs/mod/tree/master/doc/api/file.md) - There are many provided methods for reading and writing files, traversing the filesystem and finding files by matching globbing patterns. Many of these methods are wrappers around built-in Node.js file functionality, but with additional error handling, logging and character encoding normalization.
31 | * [exports.utils](https://github.com/modjs/mod/tree/master/doc/api/utils.md) - Miscellaneous utilities
32 | * [exports.template](https://github.com/modjs/mod/tree/master/doc/api/template.md) - Compiles templates into strings
33 | * [exports._](http://underscorejs.org/) - Underscore provides 80-odd functions that support both the usual functional suspects: map, select, invoke — as well as more specialized helpers: function binding, javascript templating, deep equality testing, and so on. It delegates to built-in functions, if present, so modern browsers will use the native implementations of forEach, map, reduce, filter, every, some and indexOf.
34 | * [exports.async](https://github.com/caolan/async) - Async provides around 20 functions that include the usual 'functional' suspects (map, reduce, filter, each…) as well as some common patterns for asynchronous control flow (parallel, series, waterfall…). All these functions assume you follow the node.js convention of providing a single callback as the last argument of your async function.
35 | * [exports.request](https://github.com/mikeal/request) - Simplified HTTP request method
36 | * [exports.prompt](https://github.com/flatiron/prompt) - Using prompt is relatively straight forward. There are two core methods you should be aware of: prompt.get() and prompt.addProperties(). There methods take strings representing property names in addition to objects for complex property validation (and more).
37 |
38 |
39 |
--------------------------------------------------------------------------------
/doc/api/README.md:
--------------------------------------------------------------------------------
1 | ## API
2 |
3 | * [exports](https://github.com/modjs/mod/tree/master/doc/api/exports.md) - The exports API
4 | * [exports.file](https://github.com/modjs/mod/tree/master/doc/api/file.md) - There are many provided methods for reading and writing files, traversing the filesystem and finding files by matching globbing patterns. Many of these methods are wrappers around built-in Node.js file functionality, but with additional error handling, logging and character encoding normalization.
5 | * [exports.utils](https://github.com/modjs/mod/tree/master/doc/api/utils.md) - Miscellaneous utilities
6 | * [exports.template](https://github.com/modjs/mod/tree/master/doc/api/template.md) - Compiles templates into strings
7 | * [exports._](http://underscorejs.org/) - Underscore provides 80-odd functions that support both the usual functional suspects: map, select, invoke — as well as more specialized helpers: function binding, javascript templating, deep equality testing, and so on. It delegates to built-in functions, if present, so modern browsers will use the native implementations of forEach, map, reduce, filter, every, some and indexOf.
8 | * [exports.async](https://github.com/caolan/async) - Async provides around 20 functions that include the usual 'functional' suspects (map, reduce, filter, each…) as well as some common patterns for asynchronous control flow (parallel, series, waterfall…). All these functions assume you follow the node.js convention of providing a single callback as the last argument of your async function.
9 | * [exports.request](https://github.com/mikeal/request) - Simplified HTTP request method
10 | * [exports.prompt](https://github.com/flatiron/prompt) - Using prompt is relatively straight forward. There are two core methods you should be aware of: prompt.get() and prompt.addProperties(). There methods take strings representing property names in addition to objects for complex property validation (and more).
11 |
--------------------------------------------------------------------------------
/doc/api/exports.md:
--------------------------------------------------------------------------------
1 | ## exports
2 | > The exports API
3 |
4 |
5 | ### Properties
6 |
7 | #### exports.taskName
8 | Describe: Current task's name
9 | Describe: Compiles templates into strings
13 | Describe: Miscellaneous utilities
17 | Describe: Provided many methods for reading and writing files, traversing the filesystem and finding files by matching globbing patterns. Many of these methods are wrappers around built-in Node.js file functionality, but with additional error handling, logging and character encoding normalization.
21 | Describe: Tons of super-useful array, function and object utility methods.
25 | Describe: Async utilities for node and the browser
29 | Describe: An array of all file paths that match the given wildcard patterns.
33 | Describe: Load a task
42 | Return: {object}
43 |
44 | Describe: Run task
48 |
49 |
50 | Describe: Run targets
54 |
55 |
56 | Describe: Get peoject config
60 | Return: {*}
61 |
62 | Describe: Logging object
66 |
67 |
68 | Describe: Print log
72 |
73 |
74 | Describe: Print debug
78 |
79 |
80 | Describe: Print error
84 |
85 |
86 | Describe: Print warning
90 |
91 |
92 | Describe: Push message to OSX notification system
96 |
97 | Example:
98 | ```js
99 | exports.notify({
100 | title: 'Hi',
101 | message: 'I am ok'
102 | });
103 | ```
104 |
105 | Describe: Print task help
109 |
110 |
111 | Describe: Simplified HTTP request method
115 |
116 | Example:
117 | ```js
118 | request('http://www.google.com', function (error, response, body) {
119 | if (!error && response.statusCode == 200) {
120 | console.log(body) // Print the google web page.
121 | }
122 | })
123 | ```
124 |
125 | Describe: Using prompt is relatively straight forward. There are two core methods you should be aware of: prompt.get() and prompt.addProperties(). There methods take strings representing property names in addition to objects for complex property validation (and more).
129 |
130 | Example:
131 | ```js
132 | // Start the prompt
133 | prompt.start();
134 | // Get two properties from the user: username and email
135 | prompt.get(['username', 'email'], function (err, result) {
136 | // Log the results.
137 | console.log('Command-line input received:');
138 | console.log(' username: ' + result.username);
139 | console.log(' email: ' + result.email);
140 | });
141 | ```
142 |
143 | file
2 | > There are many provided methods for reading and writing files, traversing the filesystem and finding files by matching globbing patterns. Many of these methods are wrappers around built-in Node.js file functionality, but with additional error handling, logging and character encoding normalization.
3 |
4 |
5 |
6 |
7 | ### Methods
8 |
9 | #### file.exists(filepath)
10 | Describe: File exists
11 |
12 |
13 | Describe: Is the given path a file? Returns a boolean.
17 |
18 |
19 | Describe: Is the given path a plaintext file? Returns a boolean.
23 |
24 |
25 | Describe: Is the given path a UTF8 encoding file? Returns a boolean.
29 |
30 |
31 | Describe: File suffix append
35 | Return: {*}
36 | Example:
37 | ```js
38 | file.suffiex("jquery.js", "min") // => jquery.min.js
39 | ```
40 |
41 | Describe: Is the given path a directory? Returns a boolean.
45 |
46 |
47 | Describe: Is dir format name
51 |
52 |
53 | Describe: Read a file from the filesystem and parse as JSON
57 |
58 |
59 | Describe: Looks for a project's package.json file. Walks up the directory tree untilit finds a package.json file or hits the root. Does not throw when nopackages.json is found, just returns null.
63 |
64 |
65 | Describe: Read a package.json file's contents, parsing the data as JSON and returning the result
69 |
70 |
71 | Describe: List directories within a directory.
75 |
76 |
77 | Describe: Get the pattern matched files, default root dir is cwd
81 |
82 |
83 | Describe: Return a unique array of all file or directory paths that match the given globbing pattern(s).
87 | Return: {array} matche files
88 | Example:
89 | ```js
90 | file.expand(['!./foo/.css', './foo/'])
91 | ```
92 |
93 | Describe: Delete the specified filepath. Will delete files and folders recursively.
97 |
98 |
99 | Describe: Read and return a file's contents.
103 |
104 |
105 | Describe: Write the specified contents to a file, creating intermediate directories if necessary
109 |
110 |
111 | Describe: Write the specified contents to a temp file
115 |
116 |
117 | Describe: Copy a source file or directory to a destination path, creating intermediate directories if necessary
121 |
122 |
123 | Describe: Search for a filename in the given directory or all parent directories.
127 | Return: {string}
128 |
129 | Describe: Given a path to a directory, create it, and all the intermediate directories as well
133 |
134 | Example:
135 | ```js
136 | file.mkdir("/tmp/dir", 755)
137 | ```
138 |
139 | Describe: Create temp dir
143 | Return: {string}
144 |
145 | Describe: Recurse into a directory, executing callback for each file.
149 |
150 | Example:
151 | ```js
152 | file.walkdir("/tmp", function(error, path, dirs, name) {
153 | // path is the current directory we're in
154 | // dirs is the list of directories below it
155 | // names is the list of files in it
156 | })
157 | ```
158 |
159 | template
2 | > Compiles templates into strings
3 |
4 |
5 | ### Properties
6 |
7 | #### template.settings
8 | Describe: By default, uses ERB-style template delimiters, change the following template settings to use alternative delimiters.
9 | Describe: Compiles templates into strings
18 |
19 | Example:
20 | ```js
21 | template("hello <%= foo %>", {foo:"modjs"}) // => hello modjs
22 | ```
23 |
24 | Describe: Helpers can be accessed from any context in a template
28 |
29 | Example:
30 | ```js
31 | template.registerHelper("echo", function(val){
32 | console.log(val);
33 | })
34 | ```
35 |
36 | utils
2 | > miscellaneous utilities
3 |
4 |
5 |
6 |
7 | ### Methods
8 |
9 | #### utils.getHttpProxy( hostname )
10 | Describe: Get the system's http proxy
11 |
12 |
13 | Describe: Is a relative URI?
17 |
18 | Example:
19 | ```js
20 | utils.isRelativeURI("../path/to"); // => return true
21 | utils.isRelativeURI("path/to"); // => return true
22 | utils.isRelativeURI("#id"); // => return false
23 | utils.isRelativeURI("http://www.qq.com"); // => return false
24 | utils.isRelativeURI("/relative/to/root"); // => return false
25 | utils.isRelativeURI("//without/protocol"); // => return false
26 | utils.isRelativeURI("data:image/gif;base64,lGODlhEAA..."); // => return false
27 | ```
28 |
29 | Describe: Download file
33 |
34 |
35 | Describe: Check to see if an object is a plain object (created using “{}” or “new Object”).
39 |
40 |
41 | Describe: Deep copy of the object
45 |
46 |
47 | Describe: Recurse through objects and arrays, executing fn for each non-object.
51 |
52 |
53 | Describe: Get the value of a deeply-nested property exist in an object.
57 |
58 |
59 | Describe: Deep merge for JSON objects, overwrites conflicting properties
63 |
64 |
65 | Describe: Convert 'a,b,c' to [a,b,c]
69 |
70 |
71 | Describe: Reads the version property from modjs's package.json
75 |
76 |
77 | Describe: Open application
81 |
82 |
83 | build
2 | > Build project with html
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod build [options]
8 | ```
9 |
10 | ### Options
11 |
12 | #### dest
13 |
14 | Default: dist
15 | Describe: Destination build directory
16 | Default: true
21 | Describe: Insert a hash of the file content into the filename end
22 | Default: utf-8
27 | Describe: File encoding type
28 | Default: false
33 | Describe: Wrap any build bundle in a start and end text specified by wrap
34 | Default:
39 | Describe: Url prepend with relative address
40 | Default: false
45 | Describe: Strip all definitions in generated source
46 | cat
2 | > Concatenate the content of files
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod cat [options]
8 | ```
9 |
10 | ### Options
11 |
12 | #### dest
13 |
14 | Default:
15 | Describe: Destination file
16 | Default: utf-8
21 | Describe: File encoding type
22 | Default:
27 |
28 | Describe: Make sure each file endings with newline
29 | cp
2 | > Copy one or more files to another location
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod cp [options]
8 | ```
9 |
10 | ### Options
11 |
12 | #### dest
13 |
14 |
15 | Describe: Destination directory or file
16 | Describe: Remove all path parts from generated dest paths
22 | Default: true
27 | Describe: Copy directories recursively
28 | Default: true
33 | Describe: Shows file/directory names after they are copied
34 | Default: true
39 | Describe: Force overwriting the existing files
40 | Default: false
45 | Describe: Copy only when the SOURCE file is newer than the destination file or when the destination file is missing
46 | Default: true
51 | Describe: Make a backup of each existing destination file
52 | Default: false
57 | Describe: Full path to be copied to the destination directory
58 | create
2 | > Generate project skeleton and create project directory
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod create [options]
8 | ```
9 |
10 | ### Options
11 |
12 | #### template
13 |
14 |
15 | Describe: Destination template
16 | Default: .
21 | Describe: Target project directory
22 | Type: Boolean
26 |
27 | Describe: Create a mod files in target directory
28 | Type: Boolean
32 |
33 | Describe: Create a package.json file in target directory
34 | Type: Boolean
38 |
39 | Describe: Create git files in target directory
40 | Type: Boolean
44 |
45 | Describe: Create a README.md file in target directory
46 | Type: Boolean
50 |
51 | Describe: Create test files in target directory
52 | deploy
2 | > Remote deployment via ssh
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod deploy [options]
8 | ```
9 |
10 | ### Options
11 |
12 | #### src
13 |
14 |
15 | Describe: Local file or directory
16 | Describe: Local file base dir
22 | Describe: The remote, eg. username:password@host:/path/to/
28 | Default: 22
33 | Describe: The port to connect to on the remote host.
34 | Describe: The remote username
40 | Describe: The remote password
46 | Describe: The remote host
52 | Describe: The remote path
58 | Default: ssh
63 | Describe: Deploy tunnel protocol, ssh or http
64 | Describe: The upload url
70 | Default: true
75 | Describe: Overwrite existed file
76 | download
2 | > Download resource from URI
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod download [options]
8 | ```
9 |
10 | ### Options
11 |
12 | #### src
13 |
14 |
15 | Describe: The URI which to download a resource
16 | Default: ./
21 | Describe: The file or directory where to store the requested resource(s)
22 | Describe: Show verbose progress information
28 | hash
2 | > Rename file with it hash value
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod hash [options]
8 | ```
9 |
10 | ### Options
11 |
12 | #### algorithm
13 |
14 | Default: md5
15 | Describe: Target build level
16 | Default: hex
21 | Describe: File encoding type
22 | help
2 | > Get help on mod
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod help [command]
8 | ```
9 |
10 |
11 |
12 |
13 |
14 |
15 |
--------------------------------------------------------------------------------
/doc/tasks/init.md:
--------------------------------------------------------------------------------
1 | ## init
2 | > Generate project skeleton from template
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod init [options]
8 | ```
9 |
10 | ### Options
11 |
12 | #### template
13 |
14 |
15 | Describe: Destination template
16 | Default: .
21 | Describe: Target project directory
22 | lint
2 | > Validate JavaScript/CSS source
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod lint
8 | ```
9 |
10 | ### Options
11 |
12 | #### charset
13 |
14 | Default: utf-8
15 | Describe: File encoding type
16 | min
2 | > Minify JavaScript/CSS/HTML source
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod min [options]
8 | ```
9 |
10 | ### Options
11 |
12 | #### dest
13 |
14 |
15 | Describe: Destination directory or file
16 | Describe: Destination file suffix append, default suffix is ".min" when "dest" parameter is not set
22 | Default: utf-8
27 | Describe: File encoding type
28 | mkdir
2 | > Make a new directory
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod mkdir [options]
8 | ```
9 |
10 | ### Options
11 |
12 | #### dest
13 |
14 |
15 | Describe: The name of the directory one wants to create
16 | Default: 0777
21 | Describe: Specify the octal permissions of directory
22 | mv
2 | > Move or rename files or directories
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod mv
8 | ```
9 |
10 |
11 |
12 |
13 |
14 |
15 |
--------------------------------------------------------------------------------
/doc/tasks/pack.md:
--------------------------------------------------------------------------------
1 | ## pack
2 | > Create a tarball from a module
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod pack [options]
8 | ```
9 |
10 | ### Options
11 |
12 | #### dest
13 |
14 |
15 | Describe: Target pack file path
16 | replace
2 | > Replace the contents of files
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod replace [options]
8 | ```
9 |
10 | ### Options
11 |
12 | #### dest
13 |
14 | Default:
15 | Describe: Destination directory or file
16 | Describe: A string or regular expression that will be replaced by the new value
22 | Describe: A string that replaces the search string or a function to be invoked to create the new string
28 | Default: gm
33 | Describe: A String containing any combination of the RegExp flags: g - global match, i - ignore case, m - match over multiple lines. This parameter is only used if the search parameter is a string
34 | Default: file
39 | Describe: Specify output type: file pipe
40 | Default: utf-8
45 | Describe: File encoding type
46 | rev
2 | > Rename file with it hash value
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod rev [options]
8 | ```
9 |
10 | ### Options
11 |
12 | #### algorithm
13 |
14 | Default: md5
15 | Describe: Target build level
16 | Default: hex
21 | Describe: File encoding type
22 | rm
2 | > Remove files
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod rm
8 | ```
9 |
10 |
11 |
12 |
13 |
14 |
15 |
--------------------------------------------------------------------------------
/doc/tasks/server.md:
--------------------------------------------------------------------------------
1 | ## server
2 | > Start a static web server
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod server [options]
8 | ```
9 |
10 | ### Options
11 |
12 | #### target
13 |
14 | Default: .
15 | Describe: Target directory
16 | Default: 3000
21 | Describe: Server port
22 | Default: false
27 | Describe: Log requests
28 | Type: number
32 |
33 | Describe: Bandwidth delay
34 | Default: false
39 | Describe: Enable live reload changed files
40 | Describe: Files be watched and reloaded
46 | Default: false
51 | Describe: Enable remote logging service
52 | Type: array
56 |
57 | Describe: Enable request proxy
58 | Default: true
63 | Describe: Open the default browser after server starting
64 | Describe: Start as a deploy server
70 | Describe: Remote deploy token
76 | strip
2 | > Source stripping
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod strip [options]
8 | ```
9 |
10 | ### Options
11 |
12 | #### dest
13 |
14 |
15 | Describe: Destination directory or file
16 | Default: utf-8
21 | Describe: File encoding type
22 | Type: boolean
26 | Default: true
27 | Describe: Strip bom
28 | Default: false
33 | Describe: Convert tab (default replace by 4 spaces if enable)
34 | Default: false
39 | Describe: Convert line ending (default replace by lf if enable)
40 | Default: false
45 | Describe: Strip code (default remove alert call if enable)
46 | Default: file
51 | Describe: Specify output type: file pipe
52 | watch
2 | > Run predefined tasks whenever watched files change
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod watch [options]
8 | ```
9 |
10 | ### Options
11 |
12 | #### src
13 |
14 |
15 | Describe: Files to be watched
16 | Describe: Tasks to run whenever files change
22 | Default: false
27 | Describe: Run predefined tasks for whole files whatever watched files change
28 | Default: 1000
33 | Describe: Tasks debounce delay time
34 | Default: true
39 | Describe: Print watched files
40 | <%= name %>
2 | > <%= summary %>
3 |
4 | <% if(typeof properties !== 'undefined' && !_.isEmpty(properties)){ %>
5 | ### Properties
6 | <% _.each(properties, function(property) { %>
7 | #### <%= property.name %>
8 | <% if(typeof property.describe !== 'undefined'){ %> Describe: <%= property.describe.ucfirst() %>
<% } %>
9 | Describe: <%= method.describe.ucfirst() %>
<% } %>
18 | <% if(method.ret){ %> Return: <%= method.ret %>
<% } %>
19 | <% if(method.example){ %> Example:
20 | ```js
21 | <%= method.example %>
22 | ```
23 | <% } %>
24 | <%= taskName %>
2 | > <%= summary %>
3 |
4 | ### Usage
5 |
6 | ```sh
7 | $ mod <%= taskName %> <%= usage %>
8 | ```
9 | <% if(typeof options !== 'undefined' && !_.isEmpty(options)){ %>
10 | ### Options
11 | <% _.each(options, function(option, name) { %>
12 | #### <%= name %>
13 | <% if(typeof option.type !== 'undefined'){ %> Type: <%= option.type %>
<% } %>
14 | <% if(typeof option.default !== 'undefined'){ %> Default: <%= option.default %>
<% } %>
15 | <% if(typeof option.describe !== 'undefined'){ %> Describe: <%= option.describe.ucfirst() %>
<% } %>
16 | [options]';
10 |
11 | exports.options = {
12 | "dest" : {
13 | alias : 'd'
14 | ,default : ''
15 | ,describe : 'destination file'
16 | },
17 |
18 | "charset" : {
19 | alias : 'c'
20 | ,default : 'utf-8'
21 | ,describe : 'file encoding type'
22 | }
23 | };
24 |
25 | exports.run = function (options, done) {
26 | var target = options.target;
27 | // ...
28 | done();
29 | };
30 | ```
31 |
32 | ## Options
33 |
34 | ```
35 | exports.usage = ' [options]';
36 |
37 | exports.options = {
38 | "dest" : {
39 | alias : 'd'
40 | ,default : ''
41 | ,describe : 'destination file'
42 | },
43 |
44 | "charset" : {
45 | alias : 'c'
46 | ,default : 'utf-8'
47 | ,describe : 'file encoding type'
48 | }
49 | };
50 | ```
51 |
52 | ## Done callback
53 |
54 | General task is asynchronous, how mod know task is run over? We use done callback.
55 | When a asynchronous task is over, call the `done()` method.
56 |
57 | ```js
58 | exports.run = function (options, done) {
59 | exec(function(){
60 | // balabal...
61 | done();
62 | });
63 | };
64 | ```
65 |
66 | If task is a synchronous, the done callback is optional:
67 | ```js
68 | exports.run = function (options) {
69 | console.log('run done');
70 | };
71 | ```
72 |
73 | ## Plugin API
74 |
75 | Mod plugin API are provided directly on the `exports` object for convenience. See the individual api section docs for detailed explanations and examples.
76 |
77 | ```js
78 | exports.taskName
79 | exports.files
80 | exports.loadTask()
81 | exports.runTask()
82 | exports.config()
83 |
84 | exports.log()
85 | exports.error()
86 | exports.warn()
87 | exports.debug()
88 |
89 | exports.file
90 | exports.utils
91 |
92 | exports._
93 | exports.async
94 | exports.request
95 | exports.prompt
96 | ```
97 |
98 |
99 | ## Plugin publish
100 | 1. Author project's `package.json`.
101 | 1. Run `npm publish` to publish the mod plugin to npm
102 |
--------------------------------------------------------------------------------
/doc/tutorial/getting-started.md:
--------------------------------------------------------------------------------
1 | # Getting started
2 |
3 | Mod and mod plugins are installed and managed via [npm](https://npmjs.org/), the [Node.js](http://nodejs.org/) package manager.
4 |
5 | _Mod 0.4.x requires Node.js version `>= 0.8.0`._
6 |
7 | ## Installing
8 |
9 | In order to get started, you'll want to install Mod globally. You may need to use sudo (for OSX, *nix, BSD etc) or run your command shell as Administrator (for Windows) to do this.
10 |
11 | ```shell
12 | npm install -g modjs
13 | ```
14 |
15 | This will put the `mod` command in your system path, allowing it to be run from any directory.
16 |
17 | ## How mod works
18 |
19 | Each time `mod` is run, it looks for `Modfile` deeply. Because of this, you can run `mod` from any subfolder in your project.
20 |
21 | If a `Modfile` is found, mod applies the configuration from your `Modfile`, and if there is a configuration of plugins, mod will automatically install the uninstlled plugins, if a plugin is your own custom task, mod load it by node's `require()` system, then executes any tasks you've requested for it to run.
22 |
23 | If you don't specify a target or task, but the only defined target or task will run by default.
24 |
25 | Installed Mod tasks can be listed by running `mod --help` but it's usually a good idea to start with the project's documentation.
26 |
27 | ## Preparing a new mod project
28 | A typical setup will involve adding only one file to your project: `Modfile`.
29 |
30 | **Modfile**: This file used to configure tasks and plugins.
31 |
32 | ## The Modfile
33 | The `Modfile` or `Modfile.js` file is a valid JavaScript file that belongs in the root directory of your project.
34 |
35 | A Modfile is comprised of the following parts:
36 |
37 | * The "runner" object
38 | * The plugins configuration
39 | * The tasks configuration
40 | * The targets configuration
41 |
42 | ### An example Modfile
43 | In the following Modfile, the [mod-sprite] plugin's `sprite` task is configured to generate css sprite. When mod is run on the command line, the `sprite` task will be run by default.
44 |
45 | ```js
46 | module.exports = {
47 | // Load the plugin that provides the "sprite" task.
48 | plugins: {
49 | sprite: "mod-sprite"
50 | },
51 |
52 | // Project configuration.
53 | tasks: {
54 | sprite: {
55 | "src": "./css/find.css", // required
56 | "dest": "./dist/css/find.css", // required
57 | "destImageRoot": "./sprites/", // optional relative to dest path, default "./sprites/"
58 | "maxSize": 60, // optional "kb"
59 | "margin": 5, // optional default 0
60 | "prefix": "sprite_", // optional
61 | "igts": true // optional
62 | },
63 | "min" : {
64 | "css": {
65 | "src": "./dist/css/*.css",
66 | "dest": "./dist/css"
67 | },
68 | "html": {
69 | "src": "*.html",
70 | "dest": "./dist/"
71 | },
72 | "js": {
73 | "src": "./dist/js/*.js",
74 | "dest": "./dist/js"
75 | }
76 | }
77 | },
78 |
79 | // Target task(s).
80 | targets: {
81 | dist: "sprite min"
82 | }
83 | };
84 | ```
85 |
86 | It's so easy to start working with Mod. Because `Modfile` is a JavaScript file, you're not limited to JSON, can use any valid JS here. You can even programmatically generate the configuration if necessary.
87 |
88 | Now that you've seen the whole Modfile, let's look at its component parts.
89 |
90 |
91 | ### Plugins configuration
92 |
93 | ```js
94 | module.exports = {
95 | plugins: {
96 | // Plugin task
97 | sprite: "mod-sprite",
98 | // Custom task
99 | mytask: "./tasks/mytask"
100 | }
101 | }
102 | ```
103 |
104 | ### Tasks configuration
105 |
106 | ```js
107 | module.exports = {
108 | tasks: {
109 | pkg: {
110 | name: "foo"
111 | },
112 | min: {
113 | source: 'src/{{pkg.name}}.js',
114 | dest: 'build/{{pkg.name}}.min.js'
115 | }
116 | }
117 |
118 | };
119 | ```
120 |
121 | ### Targets configuration
122 |
123 | ```js
124 | module.exports = {
125 | targets: {
126 | dev: "cat min:js",
127 | dist: "sprite min"
128 | }
129 | };
130 | ```
131 |
132 |
133 | ## Further Reading
134 |
135 | * The [Configuring Tasks](https://github.com/modjs/mod/blob/master/doc/tutorial/configuring-tasks.md) guide has an in-depth explanation on how to configure tasks, targets, options and files inside the Modfile, along with an explanation of templates, globbing patterns.
136 | * For more information about writing [custom tasks or Mod plugins](https://github.com/modjs/mod/blob/master/doc/tutorial/creating-plugins.md).
137 |
--------------------------------------------------------------------------------
/example/buildmobile/Modfile.js:
--------------------------------------------------------------------------------
1 | // Mod.js
2 | // More info at https://github.com/modjs/mod/
3 |
4 | module.exports = {
5 | tasks: {
6 | build: {
7 | src: "./index.html",
8 | stripDefine: true
9 | }
10 | }
11 | };
--------------------------------------------------------------------------------
/example/buildmobile/README.md:
--------------------------------------------------------------------------------
1 | ### Usage
2 |
3 | super easy:
4 |
5 | ```sh
6 | $ mod
7 | ```
8 |
9 |
--------------------------------------------------------------------------------
/example/buildmobile/css/base.css:
--------------------------------------------------------------------------------
1 | body{
2 | color: grey
3 | }
--------------------------------------------------------------------------------
/example/buildmobile/css/main.css:
--------------------------------------------------------------------------------
1 | @import "base.css";
2 | #only {
3 | love: u;
4 | }
5 |
--------------------------------------------------------------------------------
/example/buildmobile/img/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/modjs/mod/e1215bd34e5f8d610e8ae17542c8e1cbd3c0a75f/example/buildmobile/img/icon.png
--------------------------------------------------------------------------------
/example/buildmobile/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Build Demo
6 | Build Demo
6 | Build Demo
6 | Hello SeaJS
6 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
Build Demo
6 |
7 |
8 | Load Async Module
10 | CMD
6 |
7 |
8 | Controller ' + this.id + ' says "' +
13 | this.model.getTitle() + '"');
14 | }
15 | };
16 |
17 | return controllerBase;
18 | });
19 |
--------------------------------------------------------------------------------
/example/compilemultipage/js/app/controller/c1.js:
--------------------------------------------------------------------------------
1 | define(['./Base'], function (Base) {
2 | var c1 = new Base('Controller 1');
3 | return c1;
4 | });
5 |
--------------------------------------------------------------------------------
/example/compilemultipage/js/app/controller/c2.js:
--------------------------------------------------------------------------------
1 | define(['./Base'], function (Base) {
2 | var c2 = new Base('Controller 2');
3 | return c2;
4 | });
5 |
--------------------------------------------------------------------------------
/example/compilemultipage/js/app/lib.js:
--------------------------------------------------------------------------------
1 | define(['jquery'], function ($) {
2 | return {
3 | getBody: function () {
4 | return $('body');
5 | }
6 | }
7 | });
8 |
--------------------------------------------------------------------------------
/example/compilemultipage/js/app/main1.js:
--------------------------------------------------------------------------------
1 | define(function (require) {
2 | var $ = require('jquery'),
3 | lib = require('./lib'),
4 | controller = require('./controller/c1'),
5 | model = require('./model/m1'),
6 | backbone = require('backbone'),
7 | underscore = require('underscore');
8 |
9 | //A fabricated API to show interaction of
10 | //common and specific pieces.
11 | controller.setModel(model);
12 | $(function () {
13 | controller.render(lib.getBody());
14 |
15 | //Display backbone and underscore versions
16 | $('body')
17 | .append(' backbone version: ' + backbone.VERSION + '
')
18 | .append('underscore version: ' + underscore.VERSION + '
');
19 | });
20 | });
21 |
--------------------------------------------------------------------------------
/example/compilemultipage/js/app/main2.js:
--------------------------------------------------------------------------------
1 | define(function (require) {
2 | var $ = require('jquery'),
3 | lib = require('./lib'),
4 | controller = require('./controller/c2'),
5 | model = require('./model/m2');
6 |
7 | //A fabricated API to show interaction of
8 | //common and specific pieces.
9 | controller.setModel(model);
10 | $(function () {
11 | controller.render(lib.getBody());
12 | });
13 | });
14 |
--------------------------------------------------------------------------------
/example/compilemultipage/js/app/model/Base.js:
--------------------------------------------------------------------------------
1 | define(function () {
2 | function modelBase(title) {
3 | this.title = title;
4 | }
5 |
6 | modelBase.prototype = {
7 | getTitle: function () {
8 | return this.title;
9 | }
10 | };
11 |
12 | return modelBase;
13 | });
14 |
--------------------------------------------------------------------------------
/example/compilemultipage/js/app/model/m1.js:
--------------------------------------------------------------------------------
1 | define(['./Base'], function (Base) {
2 | var m1 = new Base('This is the data for Page 1');
3 | return m1;
4 | });
5 |
--------------------------------------------------------------------------------
/example/compilemultipage/js/app/model/m2.js:
--------------------------------------------------------------------------------
1 | define(['./Base'], function (Base) {
2 | var m2 = new Base('This is the data for Page 2');
3 | return m2;
4 | });
5 |
--------------------------------------------------------------------------------
/example/compilemultipage/js/common.js:
--------------------------------------------------------------------------------
1 | //The build will inline common dependencies into this file.
2 |
3 | //For any third party dependencies, like jQuery, place them in the lib folder.
4 |
5 | //Configure loading modules from the lib directory,
6 | //except for 'app' ones, which are in a sibling
7 | //directory.
8 | requirejs.config({
9 | baseUrl: 'js/lib',
10 | paths: {
11 | app: '../app'
12 | },
13 | shim: {
14 | backbone: {
15 | deps: ['jquery', 'underscore'],
16 | exports: 'Backbone'
17 | },
18 | underscore: {
19 | exports: '_'
20 | }
21 | }
22 | });
23 |
24 | define(['jquery', 'app/lib', 'app/controller/Base', 'app/model/Base'], function(){
25 |
26 | })
27 |
--------------------------------------------------------------------------------
/example/compilemultipage/page1.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Page 1
5 |
6 |
18 |
19 |
20 | Go to Page 2
21 |
22 |
23 |
--------------------------------------------------------------------------------
/example/compilemultipage/page2.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Page 2
5 |
6 |
18 |
19 |
20 | Go to Page 1
21 |
22 |
23 |
--------------------------------------------------------------------------------
/example/configasync/Modfile.js:
--------------------------------------------------------------------------------
1 | module.exports = function(options, done){
2 |
3 | var runner = {
4 | tasks: {
5 | cat: {
6 | options: {
7 | // Task-level options may go here, overriding task defaults.
8 | },
9 | test: {
10 | options: {
11 | // "bar" target options may go here, overriding task-level options.
12 | },
13 | group: [
14 | {src: ['../catjs/foo.js', '../catjs/bar.js'], dest: './dist/foobar.js'},
15 | {src: ['../catcss/foo.css', '../catcss/bar.css'], dest: './dist/foobar.css'},
16 | ]
17 | }
18 | }
19 | },
20 | targets: {
21 | dist: 'cat:test'
22 | }
23 | };
24 |
25 | done(runner);
26 | }
--------------------------------------------------------------------------------
/example/configasync/foobar.css:
--------------------------------------------------------------------------------
1 | .foo{background-image: url("./img/foo.png")}
2 | .bar{background-image: url("./img/bar.png")}
3 |
--------------------------------------------------------------------------------
/example/configasync/foobar.js:
--------------------------------------------------------------------------------
1 | var foo='';
2 | var bar= '';
3 |
--------------------------------------------------------------------------------
/example/configgroup/Modfile.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | tasks: {
3 | cat: {
4 | options: {
5 | // Task-level options may go here, overriding task defaults.
6 | },
7 | test: {
8 | options: {
9 | // "bar" target options may go here, overriding task-level options.
10 | },
11 | group: [
12 | {src: ['../catjs/foo.js', '../catjs/bar.js'], dest: './dist/foobar.js'},
13 | {src: ['../catcss/foo.css', '../catcss/bar.css'], dest: './dist/foobar.css'},
14 | ]
15 | }
16 | }
17 | },
18 | targets: {
19 | dist: 'cat:test'
20 | }
21 | };
--------------------------------------------------------------------------------
/example/configgroup/foobar.css:
--------------------------------------------------------------------------------
1 | .foo{background-image: url("./img/foo.png")}
2 | .bar{background-image: url("./img/bar.png")}
3 |
--------------------------------------------------------------------------------
/example/configgroup/foobar.js:
--------------------------------------------------------------------------------
1 | var foo='';
2 | var bar= '';
3 |
--------------------------------------------------------------------------------
/example/confignestedtargets/Modfile.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | plugins: {
3 | echo: function(options){
4 | console.log(options.text)
5 | }
6 | },
7 | tasks: {
8 | echo: {
9 | text: "echo a echo"
10 | },
11 | cp: {
12 | options: {
13 | // Task-level options may go here, overriding task defaults.
14 | dest: './dist'
15 | },
16 | test: {
17 | options: {
18 | // "bar" target options may go here, overriding task-level options.
19 | },
20 | group: [
21 | {src: ['../catjs/foo.js', '../catjs/bar.js']},
22 | {src: ['../catcss/foo.css', '../catcss/bar.css']},
23 | ]
24 | }
25 | }
26 | },
27 | targets: {
28 | dist: 'cp:test',
29 | default: ["dist", "echo"]
30 | }
31 | };
--------------------------------------------------------------------------------
/example/configoptions/Modfile.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | tasks: {
3 | cp: {
4 | options: {
5 | // Task-level options may go here, overriding task defaults.
6 | dest: './dist'
7 | },
8 | test: {
9 | options: {
10 | // "bar" target options may go here, overriding task-level options.
11 | },
12 | group: [
13 | {src: ['../catjs/foo.js', '../catjs/bar.js']},
14 | {src: ['../catcss/foo.css', '../catcss/bar.css']},
15 | ]
16 | }
17 | }
18 | },
19 | targets: {
20 | dist: 'cp:test'
21 | }
22 | };
--------------------------------------------------------------------------------
/example/configtemplate/Modfile.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | tasks: {
3 | cat: {
4 | test: {
5 | src: ['{{ qux.src }}', 'baz/*.js'], // [['foo/*.js', 'bar/*.js'], 'baz/*.js']
6 | dest: 'dist/abc.js' // 'dist/abc.js'
7 | }
8 | },
9 | // Arbitrary properties used in task configuration templates.
10 | foo: 'foo',
11 | bar: '{{ foo }}/*', // 'foo/*'
12 | baz: '{{ bar }}.js', // 'foo/*.js'
13 | qux: {
14 | src: ['{{ baz }}', 'bar/*.js']
15 | }
16 | },
17 | targets: {
18 | dist: 'cat:test'
19 | }
20 | };
--------------------------------------------------------------------------------
/example/configtemplate/bar/b.js:
--------------------------------------------------------------------------------
1 | var b = 2;
--------------------------------------------------------------------------------
/example/configtemplate/baz/c.js:
--------------------------------------------------------------------------------
1 | var c = 3;
--------------------------------------------------------------------------------
/example/configtemplate/foo/a.js:
--------------------------------------------------------------------------------
1 | var a = 1;
--------------------------------------------------------------------------------
/example/cp/Modfile.js:
--------------------------------------------------------------------------------
1 |
2 | module.exports = {
3 | tasks: {
4 | cp: {
5 | file: {
6 | src: ["../catjs/*.js", "../catcss/*.css"],
7 | dest: "./dist/a",
8 | filter: /foobar/
9 | },
10 | dir: {
11 | src: ["./dist/a/"],
12 | dest: "./dist/b"
13 | },
14 | subdir: {
15 | src: ["../catjs/foo.js"],
16 | dest: "./dist/b/bb",
17 | backup: false
18 | },
19 | fileAndDir: {
20 | src: ["./dist/b"],
21 | dest: "./dist/c"
22 | },
23 | fileAndDirFlatten: {
24 | src: ["./dist/b"],
25 | flatten: true,
26 | dest: "./dist/d"
27 | },
28 | flattenSrc: {
29 | src: ["./dist/b/**/*.js"],
30 | dest: "./dist/e"
31 | },
32 | fileCopyRoot: {
33 | src: "./dist",
34 | dest: "./dist/f"
35 | }
36 | }
37 | },
38 | targets: {
39 | default: "cp"
40 | }
41 | };
42 |
--------------------------------------------------------------------------------
/example/datauri/Modfile.js:
--------------------------------------------------------------------------------
1 |
2 | module.exports = {
3 | tasks: {
4 | datauri: {
5 | src: "test.css",
6 | dest: "dist/test.datauri.css",
7 | igts: true
8 | }
9 | }
10 | };
--------------------------------------------------------------------------------
/example/datauri/test.css:
--------------------------------------------------------------------------------
1 | .logo {
2 | background-image: url("test.png");
3 | }
4 |
5 | .logo2 {
6 | background-image: url("test.png?20130630520");
7 | }
--------------------------------------------------------------------------------
/example/datauri/test.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/modjs/mod/e1215bd34e5f8d610e8ae17542c8e1cbd3c0a75f/example/datauri/test.png
--------------------------------------------------------------------------------
/example/deployhttp/.testskip:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/modjs/mod/e1215bd34e5f8d610e8ae17542c8e1cbd3c0a75f/example/deployhttp/.testskip
--------------------------------------------------------------------------------
/example/deployhttp/Modfile.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | tasks:{
3 | watch: {
4 | tasks: 'deploy'
5 | },
6 | deploy: {
7 | src: './dist/**/*',
8 | basedir: './dist/',
9 | token: 'private',
10 | dest: '/Users/yuanyan/Github/modjs/test/deployhttp/tmp',
11 | protocol: 'http',
12 | url: 'http://localhost:3000/upload'
13 | },
14 | server: {
15 | deploy: true,
16 | token: 'private'
17 | }
18 | },
19 |
20 | targets: {
21 | default: 'deploy watch',
22 | server: 'server'
23 | }
24 | };
25 |
--------------------------------------------------------------------------------
/example/deployssh/.testskip:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/modjs/mod/e1215bd34e5f8d610e8ae17542c8e1cbd3c0a75f/example/deployssh/.testskip
--------------------------------------------------------------------------------
/example/deployssh/Modfile.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | tasks:{
3 | watch: {
4 | src: './dist/',
5 | tasks: 'deploy'
6 | },
7 | deploy: {
8 | src: './dist/',
9 | dest: 'username:password@host:path' // replace with your own ssh server
10 | }
11 | },
12 |
13 | targets: {
14 | default: 'deploy watch'
15 | }
16 | };
17 |
--------------------------------------------------------------------------------
/example/download/Modfile.js:
--------------------------------------------------------------------------------
1 |
2 | module.exports = {
3 | plugins: {
4 | tar: "mod-tar"
5 | },
6 | tasks: {
7 | download: {
8 | jquery: {
9 | src: ["http://code.jquery.com/jquery-1.8.2.js"],
10 | dest: "./dist/js"
11 | },
12 | github: {
13 | src: "jquery/jquery",
14 | dest: "./dist/lib/jquery"
15 | }
16 | }
17 | },
18 | targets: {
19 | dist: "download"
20 | }
21 | };
22 |
--------------------------------------------------------------------------------
/example/mincss/Modfile.js:
--------------------------------------------------------------------------------
1 |
2 | module.exports = {
3 | tasks: {
4 | min: {
5 | src: "test.css",
6 | dest: "dist/test.min.css"
7 | }
8 | }
9 | };
--------------------------------------------------------------------------------
/example/mincss/foo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/modjs/mod/e1215bd34e5f8d610e8ae17542c8e1cbd3c0a75f/example/mincss/foo.png
--------------------------------------------------------------------------------
/example/mincss/test.css:
--------------------------------------------------------------------------------
1 | @import "../catcss/foo.css";
2 | .a {font-family: monospace;}
3 | .b {font-family: monospace;}
4 | .d {font-family: monospace;}
5 | .c {font-family: monospace;}
6 | #main{}
--------------------------------------------------------------------------------
/example/minhtml/Modfile.js:
--------------------------------------------------------------------------------
1 |
2 | module.exports = {
3 | tasks: {
4 | min: {
5 | src: "*.html",
6 | dest: "./dist"
7 | }
8 | }
9 | };
--------------------------------------------------------------------------------
/example/minhtml/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Build Demo
6 | Mocha Spec Runner
6 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 | 
chajs
6 |
7 | 
11 | 
12 | 
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/example/buildnormal/js/bar.js:
--------------------------------------------------------------------------------
1 | (function stand(status){
2 | window['console'] && console.log(status);
3 | })('bar');
--------------------------------------------------------------------------------
/example/buildnormal/js/baz.js:
--------------------------------------------------------------------------------
1 | (function stand(status){
2 | window['console'] && console.log(status);
3 | })('baz');
--------------------------------------------------------------------------------
/example/buildnormal/js/corge.js:
--------------------------------------------------------------------------------
1 | (function stand(status){
2 | window['console'] && console.log(status);
3 | })('corge');
--------------------------------------------------------------------------------
/example/buildnormal/js/foo.js:
--------------------------------------------------------------------------------
1 | (function stand(status){
2 | window['console'] && console.log(status);
3 | })('foo');
--------------------------------------------------------------------------------
/example/buildnormal/js/quux.js:
--------------------------------------------------------------------------------
1 | (function stand(status){
2 | window['console'] && console.log(status);
3 | })('quux');
--------------------------------------------------------------------------------
/example/buildnormal/js/qux.js:
--------------------------------------------------------------------------------
1 | (function stand(status){
2 | window['console'] && console.log(status);
3 | })('quz');
--------------------------------------------------------------------------------
/example/buildrequirejs/Modfile.js:
--------------------------------------------------------------------------------
1 | // Mod.js
2 | // More info at https://github.com/modjs/mod/
3 |
4 | module.exports = {
5 | tasks: {
6 | build: {
7 | src: "./index.html"
8 | }
9 | }
10 | };
--------------------------------------------------------------------------------
/example/buildrequirejs/README.md:
--------------------------------------------------------------------------------
1 | ### Usage
2 |
3 | super easy:
4 |
5 | ```sh
6 | $ mod build index.html
7 | ```
8 |
9 |
--------------------------------------------------------------------------------
/example/buildrequirejs/css/base.css:
--------------------------------------------------------------------------------
1 | body{
2 | color: grey
3 | }
--------------------------------------------------------------------------------
/example/buildrequirejs/css/main.css:
--------------------------------------------------------------------------------
1 | @import "base.css";
2 | #only {
3 | love: u;
4 | }
5 |
--------------------------------------------------------------------------------
/example/buildrequirejs/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | 
11 | 
12 | 
13 | 
14 | 
15 | 
16 | 
17 | 
18 | 
19 | 
20 | 
21 |