Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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