Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 80 lines (52 sloc) 2.947 kb
17e2159 @davglass Added License and README
davglass authored
1 Shifter - Blazingly Fast YUI Builder
2 ====================================
3
463b160 @davglass Update README
davglass authored
4 The purpose of this project is to replace YUI's use of our old ant [Builder](https://github.com/yui/builder).
17e2159 @davglass Added License and README
davglass authored
5
6 We have out grown our old builder, so it was time to build a new one!
7
628d9c5 @davglass Added docs link to README
davglass authored
8 Documentation
9 -------------
10
e59793d @davglass Updated links to yui repo instead of mine
davglass authored
11 [Documentation can be found here](http://yui.github.com/shifter/)
628d9c5 @davglass Added docs link to README
davglass authored
12
0e261b2 @davglass Adding build badges after this push
davglass authored
13 Build Status
14 ------------
15
e59793d @davglass Updated links to yui repo instead of mine
davglass authored
16 [![Build Status](https://secure.travis-ci.org/yui/shifter.png?branch=master)](http://travis-ci.org/yui/shifter)
0e261b2 @davglass Adding build badges after this push
davglass authored
17
2d2e624 @davglass README updates
davglass authored
18 Install
19 -------
20
21 npm -g install shifter
22
c4687a2 @davglass Updated README
davglass authored
23 Some Options
24 ------------
25
e59793d @davglass Updated links to yui repo instead of mine
davglass authored
26 More detail can be found in the [documentation](http://yui.github.com/shifter/)
2d2e624 @davglass README updates
davglass authored
27
28 $ shifter -h
adc8d39 @davglass readme update
davglass authored
29
c4687a2 @davglass Updated README
davglass authored
30 blazingly fast builds with shifter
2d2e624 @davglass README updates
davglass authored
31
32 pass no arguments and shifter will build the module from the current directory
33
34 -v/--version show version
35 -h/--help show this stuff
36 -m/--modules <module> limit the modules to build (array: -m foo -m bar)
adc8d39 @davglass readme update
davglass authored
37 --lint [preferred|defaults|strict] (preferred is the default) lint mode: https://github.com/yui/yui-lint
2d2e624 @davglass README updates
davglass authored
38 --strict add "use strict" to module wrapper
f9c2ecc @davglass Added directory walking
davglass authored
39 --walk Walk the current directory and shift all builds. (cd yui3/src && shifter --walk)
e7463c5 @davglass Added -m to help
davglass authored
40 -m/--modules also supported here for filtering
5dc85db @davglass README update
davglass authored
41 --watch Watch the current module and rebuild on file change (if meta file, a loader build will launch)
42 --quiet to mute stdout from sub build
2d2e624 @davglass README updates
davglass authored
43
17e2159 @davglass Added License and README
davglass authored
44 Usage
45 -----
46
47 Shifter will parse your current `*.properties` files and convert them into a `build.json` file that
48 it can process. It only imports the relevant settings required to build the module.
49
50 **It does not import module meta-data**
51
52 Instead, Shifter parses the meta-data from the modules `meta/*.json` files and uses that instead.
53 So you don't have to declare your meta-data in more than one place now.
54
91554d4 @davglass updated README
davglass authored
55 Watching
56 --------
57
58 Shifter can watch your module for changes and build for you. It will only watch files in the
59 `./js`, `./css`, `./assets` and `./meta` directories. If a file is changed, it will rebuild the current
60 module. If a meta file is changes, `Loader` will also be built (*requires latest code*).
61
62
17e2159 @davglass Added License and README
davglass authored
63 Migrating
64 ---------
65
66 Shifter is designed to work side by side with our current builder (for now) so you don't have to
67 switch over to using it fully if it doesn't work properly for you. Just don't delete your `*.properties`
68 files until you are sure that Shifter builds your module properly. If it doesn't, file a ticket and
69 we'll get it fixed up ASAP.
70
71 Shifter will read a `build.json` file if it exists, if one doesn't and it finds a `*.properties` file
72 it will generate the `build.json` from them. So if you have issues with the build, just delete the `build.json`
73 file and have Shifter regenerate it after your issue is fixed.
74
75
76 GearJS
77 ------
78
463b160 @davglass Update README
davglass authored
79 Shifter is built using [GearJS](http://gearjs.org/)
Something went wrong with that request. Please try again.