xonecas.io
142
St

startsInvasion / files

startsInvasion / libs / node_modules / qwery / build / smoosh / README.md

4.2 KB
1SMOOOOSH.
2=========
3How would you smoosh a lion and a tiger? A tialiganer, right?  
4
5![smoosh](http://f.cl.ly/items/3o0y3m3o2Z3l1e0i1V2V/Screen%20shot%202011-03-05%20at%2012.13.54%20AM.png)
6
7SMOOSH is a tool for packaging your javascript projects... it will run jshint against your files, then build and minify your files if you'd like.  
8
9to install smoosh do something like this...
10
11    npm install smoosh
12
13CONFIG
14======
15Currently, smoosh requires a config.json file to work. Your config file should look something like this (check the examples folder for a working example):
16
17	{ 
18	  "VERSION": "0.1", //<-- optional
19	  "DIST_DIR": "dist", //<-- optional
20	  "JSHINT_OPTS": { ... }
21	  "SOURCES": { 
22	    "base": [ ... ],
23	    "secondary": [ ... ]
24	  }
25	}
26
27Your config options include:
28
29  + VERSION: an optional version number which will be appended to your built files
30  + SOURCES:
31	+ key: the name of your compiled file (ie: 'mootools-core', 'base-bundle', etc.)
32	+ value: an array of file paths to be bundled (ie. ['./src/drag.js', './src/drop.js'])
33  + DIST_DIR: the directory to output your files to (if no directory is specified, 'dist' will be used)
34  + JSHINT_OPTS: the options to use if running jshint
35
36
37USING SMOOSH WITH TERMINAL
38==========================
39
40once installed with npm, smoosh can be accessed easily from the command line! Just create your config file (shown above), then run commands. Here's a list of some of them:
41
42
43	//any of these commands will execute all smoosh tasks with config.json
44	smoosh ./config.json
45	smoosh make ./config.json
46	smoosh -m ./config.json
47	
48	//executing either of these commands will destroy the dist folder
49	smoosh clean ./config.json
50	smoosh -d ./config.json
51	
52	//these will generate ugliyjs minified versions of your packaged source
53	smoosh compressed ./config.json
54	smoosh -c ./config.json
55	
56	//these will generate full, uncompressed version of your packaged source
57	smoosh uncompressed
58	smoosh -f ./config.json
59	
60	//executing either of these commands will build both compressed and uncompressed versions of your source
61	smoosh build ./config.json
62	smoosh -b ./config.json
63	
64	//these will run jshint against your uncompressed source
65	smoosh run ./config.json
66	smoosh -r ./config.json
67	
68	//the -a flag will run analyze.. you must include a build type for analyze to work
69	smoosh -ca ./config
70	smoosh -ba ./config
71	smoosh -fa ./config
72	
73	//as you might have guessed, you can specify multiple flags at the same time
74	smoosh -dba ./config //<-- this will clean the dist folder, build new files, and then analyze them
75	
76	
77
78USING SMOOSH WITH THE CODEZ 
79===========================
80
81once installed, smoosh is pretty easy to use...
82
83    var smoosh = require('smoosh');
84
85Once required there are several methods available to you:
86
87CONFIG
88------
89As stated above, smoosh requires that you pass it the path to your configuration json file. To do that, you would do:
90
91   smoosh.config('./config.json')
92
93CLEAN
94-----
95The clean method will remove your distribution directory
96
97	smoosh.clean();
98
99RUN
100---
101Run takes one argument; a string which specifies what to run. Currently run only works with jslint, therefore you can do either:
102
103    smoosh.run('jslint');
104
105	//or
106	
107	smoosh.run();
108
109In the future we may add more useful things here.
110
111BUILD
112-----
113Build is used to build your sources together. You can build uncompressed or compressed files or both! You can use it like this:
114
115	smoosh.build('uncompressed');
116	
117	//or
118	
119	smoosh.build('compressed');
120	
121	//or
122	
123	smoosh.build() // <-- this will build both compressed and uncompressed
124
125
126ANALYZE
127-------
128Analyzed is useful when you're curious if you're making your files larger or smaller. It will return relevant file size for uncompressed, compressed, or gzipped files.
129
130    smoosh.analyze('uncompressed');
131
132	//or
133	
134    smoosh.analyze('compressed');
135
136	//or
137	
138    smoosh.analyze('gzipped'); //it gzips the compressed files only
139
140	//or 
141	
142	smoosh.analyze(); //which will do analyze all types
143
144MAKE
145----
146Make can currently be used as a shortcut to run all smoosh methods... It requires one argument, the path to the config file.json.
147
148	smoosh.make('./config.json');
149	
150	//is the same as
151	
152	smoosh.config('./config.json').clean().run().build().analyze();
153	
154CHAINING
155--------
156Note: that smoosh supports chaining, if you're into that sorta thing.