A starter repository for Kendo UI platform agnostic components, which provides the basic directory structure and dependencies.
Structure
-
The
src
directory contains the component source code. All files should be have the.js
extensions so that the build scripts may pick them. -
The
src/main.js
file should import and re-export all public components of the package. It is used for thebuild-cdn
task. -
The
src/main.d.ts
file should export all typescript deffinitions. -
The
src/util.js
is an optional example of an additional file - you may remove it if unnecessary. -
The
test
directory contains the component tests. They are transpiled just like the source code itself, and are run with Jasmine in NodeJS. -
The
docs
directory contains markdown files that document the specifics of the component.
Gulp tasks
-
build-npm-package
- builds the scripts and styles indist/npm
in CommonJS format; -
build-cdn
- builds the scripts and styles indist/cdn
in UMD format. -
test
- runs the tests with Jasmine in NodeJS. -
watch-test
- runs the tests in watch mode. -
docs
- launches a preview server for the documentation in thedocs
directory