2016-12-29 02:51:51 -05:00
2016-06-19 10:24:28 -07:00
2016-12-29 02:17:39 -05:00
2016-07-22 07:52:59 -07:00
2016-12-29 02:17:39 -05:00
2016-12-26 00:59:56 -05:00

gulp-shenanigans

NPM version

Unified Gulp tasks for FullScreenShenanigans projects.

Why?

There are over two dozen repositories in the FullScreenShenanigans organization. This unifies common build logic and can be updated more easily than editing each individual repository. Updates can be brought in using npm update.

shenanigans.json

gulp-shenangigans is configured a project's shenanigans.json. The settings match the IProjectSchema interface in src/definitions.ts.

Common Tasks

When working on a TypeScript project, use gulp src:tsc to just run the TypeScript compiler. Use gulp watch to trigger that whenever a file changes.

Tasks in Detail

default

The default task runs src, lib, test, docs, and any custom task groups in order.

src

Compiles source files in-place in the /src folder.

  • src:tsc - Runs the TypeScript compiler on source .ts files in-place.
  • src:tslint - Runs TSLint on source .ts files.

Sub-tasks included in the web group:

  • src:scss - Runs the Sass compiler on source .scss files in-place
  • src:scssLint - Runs scss-lint on source .scss files.

lib

Compiles source files into the /lib folder.

  • lib:tsc - Runs the TypeScript compiler on source .ts files to create /lib output.

Sub-tasks included in the web group:

  • lib:copy - Copies web resource files into the /lib folder.
  • lib:cssMin - Minifies CSS from /src into the /lib folder.
  • lib:html - Minifies HTML from /src into the /lib folder.

test

Creates test runners and runs them in the /test folder.

  • test:setupHtml - Creates an index.html that can run tests.
  • test:setupUtilities - Copies configuration and utility files into the project directory.
  • test:setupScripts - Compiles test .ts files in-place.
  • test:run - Runs tests.

docs

Generates HTML documentation under docs/ based on source file comments.

  • docs:typedoc
S
Description
No description provided
Readme 448 KiB
Languages
TypeScript 74.5%
SCSS 11.4%
HTML 10.1%
JavaScript 4%