Skip to content
forked from thi-ng/umbrella

Mono-repository for thi.ng TypeScript/ES6 projects

Notifications You must be signed in to change notification settings

jzllove9/umbrella

 
 

Repository files navigation

@thi.ng/umbrella

Travis status Conventional Commits

Mono-repository for thi.ng TypeScript/ES6 projects, a collection of largely data / transformation oriented packages and utilities for building reactive applications (not just UI related).

All packages are:

  • distributed as ES6 modules with bundled TypeScript typings & changelogs
  • highly modular with largely only a single exported function / class per file to help w/ tree shaking
  • provide re-exports of all their publics (src/index.ts)
  • have either none or only @thi.ng internal runtime dependencies (see graph below)
  • declare public interfaces, enums & types in an src/api.ts file (larger packages only)
  • online documentation available at docs.thi.ng
  • standalone examples
  • licensed under Apache Software License 2.0

Projects

Projects Version
@thi.ng/api npm (scoped) changelog
@thi.ng/atom npm (scoped) changelog
@thi.ng/bitstream npm (scoped) changelog
@thi.ng/checks npm (scoped) changelog
@thi.ng/csp npm (scoped) changelog
@thi.ng/dcons npm (scoped) changelog
@thi.ng/diff npm (scoped) changelog
@thi.ng/hiccup npm (scoped) changelog
@thi.ng/hiccup-dom npm (scoped) changelog
@thi.ng/hiccup-dom-components npm (scoped) changelog
@thi.ng/iterators npm (scoped) changelog
@thi.ng/rle-pack npm (scoped) changelog
@thi.ng/rstream npm (scoped) changelog
@thi.ng/rstream-csp npm (scoped) changelog
@thi.ng/rstream-log npm (scoped) changelog
@thi.ng/transducers npm (scoped) changelog
@thi.ng/unionstruct npm (scoped) changelog

Dependency graph

(This graph is updated automatically after each version update)

internal dependencies

Building

git clone https://github.com/thi-ng/umbrella.git
cd umbrella
yarn build

Building example projects

# build all examples (from project root)
yarn examples

# in example dir
yarn dev

Testing

(TODO not all packages have tests yet)

yarn test
# or individually
lerna run test --scope @thi.ng/rstream

Coverage

The resulting reports will be saved under /packages/*/coverage/lcov-report/.

yarn cover

Documentation

Autogenerated documentation (using TypeDoc) will be saved under /packages/*/doc/ and is also available at docs.thi.ng.

yarn doc

About

Mono-repository for thi.ng TypeScript/ES6 projects

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 98.4%
  • Shell 1.6%