Skip to content
This repository
Newer
Older
100644 57 lines (38 sloc) 2.12 kb
17e21593 » davglass
2012-08-20 Added License and README
1 Shifter - Blazingly Fast YUI Builder
2 ====================================
3
463b1608 » davglass
2012-08-20 Update README
4 The purpose of this project is to replace YUI's use of our old ant [Builder](https://github.com/yui/builder).
17e21593 » davglass
2012-08-20 Added License and README
5
6 We have out grown our old builder, so it was time to build a new one!
7
2d2e624d » davglass
2012-08-20 README updates
8 Install
9 -------
10
11 npm -g install shifter
12
13 Options
14 -------
15
16 $ shifter -h
adc8d396 » davglass
2012-08-21 readme update
17
18 blazingly fast builds with shifter@0.0.4
2d2e624d » davglass
2012-08-20 README updates
19
20 pass no arguments and shifter will build the module from the current directory
21
22 -v/--version show version
23 -h/--help show this stuff
24 -m/--modules <module> limit the modules to build (array: -m foo -m bar)
adc8d396 » davglass
2012-08-21 readme update
25 --lint [preferred|defaults|strict] (preferred is the default) lint mode: https://github.com/yui/yui-lint
2d2e624d » davglass
2012-08-20 README updates
26 --strict add "use strict" to module wrapper
f9c2ecc9 » davglass
2012-08-21 Added directory walking
27 --walk Walk the current directory and shift all builds. (cd yui3/src && shifter --walk)
e7463c5f » davglass
2012-08-21 Added -m to help
28 -m/--modules also supported here for filtering
2d2e624d » davglass
2012-08-20 README updates
29
17e21593 » davglass
2012-08-20 Added License and README
30 Usage
31 -----
32
33 Shifter will parse your current `*.properties` files and convert them into a `build.json` file that
34 it can process. It only imports the relevant settings required to build the module.
35
36 **It does not import module meta-data**
37
38 Instead, Shifter parses the meta-data from the modules `meta/*.json` files and uses that instead.
39 So you don't have to declare your meta-data in more than one place now.
40
41 Migrating
42 ---------
43
44 Shifter is designed to work side by side with our current builder (for now) so you don't have to
45 switch over to using it fully if it doesn't work properly for you. Just don't delete your `*.properties`
46 files until you are sure that Shifter builds your module properly. If it doesn't, file a ticket and
47 we'll get it fixed up ASAP.
48
49 Shifter will read a `build.json` file if it exists, if one doesn't and it finds a `*.properties` file
50 it will generate the `build.json` from them. So if you have issues with the build, just delete the `build.json`
51 file and have Shifter regenerate it after your issue is fixed.
52
53
54 GearJS
55 ------
56
463b1608 » davglass
2012-08-20 Update README
57 Shifter is built using [GearJS](http://gearjs.org/)
Something went wrong with that request. Please try again.