@cybozu/duck
Serves and builds an app with Google Closure Compiler/Library/Templates. An alternative to plovr.
Install
$ npm i -D @cybozu/duckUsage
duck <command>
Commands:
duck serve [entryConfigDir] Start dev server
duck build [entryConfigDir] Build Soy, deps.js and JS
duck build:js [entryConfigDir] Compile JS files
duck build:soy Compile Soy templates
duck build:deps Generate deps.js
duck clean:soy Remove all compiled .soy.js
duck clean:deps Remove generated deps.js
duck completion Generate completion script for bash/zsh
Options:
-v, --version Show version number [boolean]
-h, --help Show help [boolean]
CLI options overwrite config file
duck serve
duck serve [entryConfigDir]
Start dev server
Options:
--inputsRoot A root directory to serve [string]
--closureLibraryDir A root directory of Closure Library [string]
--depsJs A path to deps.js to save and load [string]
--depsWorkers The number of workers to analyze deps [number] [default: 4]
--config A path to duck.config.js, the extension can be ommited [string]
--nonTTY, --noTTY, -n Output in nonTTY mode [boolean] [default: false]
--skipInitialBuild, -s Skip initial building of Soy and deps.js [boolean] [default: false]
--port A port number to listen [number] [default: 9810]
--host A host to listen [string] [default: "localhost"]
-v, --version Show version number [boolean]
-h, --help Show help [boolean]
duck build
duck build [entryConfigDir]
Build Soy, deps.js and JS
Options:
--entryConfigs, -e Entry config files (this option ignores entryConfigDir) [array]
--closureLibraryDir A root directory of Closure Library [string]
--config A path to duck.config.js, the extension can be ommited [string]
--concurrency, -c Concurrency limit of Closure Compiler [number]
--batch Build in batch mode (on AWS or local for debug)[choices: "aws", "local"]
--reporters Test reporters ("text", "xunit" or "json") [array] [default: ["text"]]
--reporterOptions Test reporter options
--printConfig, -p Print effective configs for compilers [boolean] [default: false]
--depsJs A path to deps.js to save and load [string]
--nonTTY, --noTTY, -n Output in nonTTY mode [boolean] [default: false]
--depsWorkers The number of workers to analyze deps [number] [default: 4]
--skipInitialBuild, -s Skip initial building of Soy and deps.js [boolean] [default: false]
--soyJarPath A path to Soy.jar [string]
--soyFileRoots Root directories of soy files [array]
--soyClasspaths Classpaths for Closure Templates [array]
--watch, -w Re-compile incrementally when files change [boolean] [default: false]
-v, --version Show version number [boolean]
-h, --help Show help [boolean]
duck.config.js
Create a config file duck.config.js or duck.config.json on your project root.
Set every path as a relative path from the location of duck.config.js.
module.exports = {
/**
* Common settings
*/
// (Required) A path to Closure Library direcotry
closureLibraryDir: "node_modules/google-closure-library",
// (Required) A directory where entry config JSONs are stored flat
entryConfigDir: "entry-configs",
/**
* Generating and loading deps.js
*/
// A path to deps.js to save and load in build and serve commands
depsJs: "build/deps.js",
// Directories ignored when building deps.js
depsJsIgnoreDirs: ["src/third_party"],
// The number of workers to build deps.js. Node v10 uses processes and node v12+ uses threads. (default: 4)
depsWorkers: 2,
/**
* Building Soy
*/
// (Required) A path to Closure Templates JAR
soyJarPath: "lib/closure-templates.jar",
// (Required) Directories where Closure Templates .soy files are stored
soyFileRoots: ["src/soy"],
// Classpaths for Closure Templates
soyClasspaths: ["lib/plugin.jar"],
// CLI options for Closure Templates
soyOptions: {
shouldGenerateJsdoc: true,
},
/**
* Compiling JavaScript
*/
// Concurrency of Closure Compiler (default: 1,000 if AWS batch mode, otherwise 1)
concurrency: 4,
// Build in batch mode with faast.js on "aws" for production or "local" for debug (default: disabled)
batch: "aws",
// Options for faast.js in batch mode. See https://faastjs.org/docs/api/faastjs.awsoptions
batchOptions: {},
// Reporters (choose from "json", "text" or "xunit")
reporters: ["text", "xunit"],
// Options for each test reporter
reporterOptions: {
text: {
// Output errors to stderr or not
stderr: false,
// A directory where reporters output
outputDir: "test-results/text",
},
xunit: {},
},
/**
* Serve
*/
// (Required) A root directory scanned to build deps.js and delivered as static assets
inputsRoot: "src/inputs",
// Hostname for serve command (default: 0.0.0.0)
host: "localhost",
// Port number for serve command (default: 9810)
port: 1234,
// Use HTTP/2 in serve command (deafult: false)
http2: true,
// Settings for HTTPS (HTTP/2) (default: not specified, HTTP is used)
https: {
// A path to a private key
keyPath: "path/to/key.pem",
// A path to a self-signed certificate
certPath: "path/to/cert.pem",
},
}Also see examples.
Tips
Batch mode using AWS Lambda
duck provides batch mode that compiles all entry points simultaneously in parallel on AWS Lambda with faast.js.
- Setting AWS credentials in Node.js (See AWS document)
- Configure
batchOptionsinduck.config.js. It's used for faast.js as AWSOptions.
const closureVersion = require('google-closure-compiler/package.json').version;
module.exports = {
batchOptions: {
region: 'ap-northeast-1',
awsLambdaOptions: {
Runtime: 'nodejs10.x',
},
include: ['path/to/your/source/**/*.js'],
exclude: ['**/*_spec.js'],
packageJson: {
dependencies: {
'google-closure-compiler-linux': closureVersion,
'google-closure-library': closureVersion,
},
},
},
};- Run
buildorbuild:jscommand with--batch aws.
$ duck build --batch awsHow to debug in batch mode?
- Use
--batch localfor local debugging - Use
DEBUG=faast:infoor other log level to get more debug information - Get
logUrlfrom debug info and view it in CloudWatch logs - Use
FAAST_PACKAGE_DIR=foo/barto investigate a package sent to Lambda
Also see faast.js document for more information.
How to use HTTPS and HTTP2 in duck serve?
Create a self-signed certificate like
$ openssl req -x509 -newkey rsa:4096 -keyout duck-key.pem -out duck-cert.pem -days 365 -nodes -subj '/CN=localhost'Then specify them and enable http2 in duck.config.js.
module.exports = {
http2: true,
https: {
keyPath: './path/to/duck-key.pem',
certPath: './path/to/duck-cert.pem'
}
};bash/zsh-completion for commands and options
Initial setting:
$ duck completion >> ~/.bashrc
# or
$ duck completion >> ~/.zshrcThen, you can complete commands and options with TAB !
$ duck build:<TAB>
build:deps -- Generate deps.js
build:js -- Compile JS files
build:soy -- Compile Soy templatesLicense
MIT License: Cybozu, Inc.