Googkit
Overview
Googkit is a tool that boosts development cycle of your web app with Google Closure Library. You can setup your project only two steps so start developing quickly. You can also do such a complicated compiling... by one command!
Requirements
Googkit requires Following commands. Install them if not installed yet.
Git: | downloads Closure Library |
---|---|
Python: | executes Closure Tools |
Install Googkit
First, you need to install Googkit.
Linux or OS X
-
Download and extract the latest version of Googkit
-
Put it into a preferred place:
$ mv googkit /opt
-
Add environment variables:
export GOOGKIT_HOME=/opt/googkit export PATH=$PATH:$GOOGKIT_HOME/bin
Windows
-
Download and extract the latest version of Googkit
-
Put it into a preferred place:
$ move googkit C:\
-
Add environment variables
Variable
Value
GOOGKIT_HOME
C:\googkit
PATH
Append
;%GOOGKIT_HOME%\bin
Getting Started
-
Create a project directory and initialize:
$ mkdir my_project $ cd my_project $ googkit init
-
Download Closure Tools:
$ googkit setup
-
Develop your web app in
development/
Modify existing scripts, or add your awesome scripts to
development/js_dev
.After adding/removing scripts, you need to update dependency information:
$ googkit ready
-
Build your project
Building the project including JavaScript files compilation improves performance and makes them unreadable:
$ googkit build
If it succeed, output files will be stored in
production/
.
Project Structure
googkit.cfg: | config file of the project |
---|---|
closure/: | stores Closure Tools |
development/: | for development |
debug/: | for debug (it will be created if debug is enabled) |
production/: | for production |
Running Unit Tests
You can run jsunit-style unit tests.
-
Create a HTML file for testing
Copy example_test.html into the same directory as the target, then rename it to
{target_name}_test.html
.If you don't like the default name
{target_name}_test.html
, you can change it bytest_file_pattern
ingoogkit.cfg
. -
Write unit tests
-
Apply config changes and update dependency information:
$ googkit ready
-
Run unit tests
Open the test html file in your browser.
If you want to run all tests, open
development/all_tests.html
in your browser with http scheme (doesn't work with file scheme).
Tips
Renaming a Compiled Script
Edit compiled_js
in googkit.cfg
.
After editing, apply it with a following command:
$ googkit ready
Preventing Some Scripts from Compiling
Place them outside development/js_dev
.
Scripts that are in it will be compiled and removed in production.
Debugging a Compiled Source
Build with --debug
option:
$ googkit build --debug
Then you can use debugging features in debug/
.
Using Source Map
Googkit generates a source map file script.min.js.map
within debug/
,
so you can use Source Map V3
if your browser supports it.
For reason of obfuscation, source map file will NOT be stored
in production/
.
Misc
The Googkit team
- cocopon (cocopon@me.com)
- OrgaChem (orga.chem.job@gmail.com)
License
Googkit are licensed under MIT License.
See LICENSE.txt
for more information.