Skip to content

⛱ Broadly scoped ecosystem & mono-repository of 199 TypeScript projects (and ~180 examples) for general purpose, functional, data driven development

License

Notifications You must be signed in to change notification settings

thi-ng/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 building blocks reactive applications, components (not just UI related), dataflow.

All/most packages:

  • have detailed, individual README files w/ small usage examples
  • versioned independently
  • distributed as ES6 (CommonJS modules) with bundled TypeScript typings & changelogs
  • highly modular with largely only a few closely related functions / single class per file to help w/ tree shaking
  • provide re-exports of all their publics for full library imports
  • 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)
  • autogenerated online documentation at docs.thi.ng
  • licensed under Apache Software License 2.0

There's a steadily growing number of standalone examples (different difficulties, many combining functionality from several packages) in the examples directory.

Projects

Projects Version
@thi.ng/api npm (scoped) changelog
@thi.ng/associative 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/dgraph npm (scoped) changelog
@thi.ng/diff npm (scoped) changelog
@thi.ng/hdom npm (scoped) changelog
@thi.ng/hdom-components npm (scoped) changelog
@thi.ng/hiccup npm (scoped) changelog
@thi.ng/hiccup-css npm (scoped) changelog
@thi.ng/hiccup-svg npm (scoped) changelog
@thi.ng/interceptors npm (scoped) changelog
@thi.ng/iterators npm (scoped) changelog
@thi.ng/paths npm (scoped) changelog
@thi.ng/pointfree npm (scoped) changelog
@thi.ng/pointfree-lang npm (scoped) changelog
@thi.ng/rle-pack npm (scoped) changelog
@thi.ng/resolve-map npm (scoped) changelog
@thi.ng/router npm (scoped) changelog
@thi.ng/rstream npm (scoped) changelog
@thi.ng/rstream-csp npm (scoped) changelog
@thi.ng/rstream-gestures npm (scoped) changelog
@thi.ng/rstream-graph 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