Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/knockout/tko
🥊 Technical Knockout – The Monorepo for Knockout.js (4.0+)
https://github.com/knockout/tko
framework frontend frontend-app frontend-framework frontend-web knockout mvvm mvvm-framework tko
Last synced: 1 day ago
JSON representation
🥊 Technical Knockout – The Monorepo for Knockout.js (4.0+)
- Host: GitHub
- URL: https://github.com/knockout/tko
- Owner: knockout
- License: other
- Created: 2015-12-19T19:36:11.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2025-01-30T15:50:09.000Z (19 days ago)
- Last Synced: 2025-02-10T08:04:04.736Z (9 days ago)
- Topics: framework, frontend, frontend-app, frontend-framework, frontend-web, knockout, mvvm, mvvm-framework, tko
- Language: TypeScript
- Homepage: http://www.tko.io
- Size: 9 MB
- Stars: 282
- Watchers: 41
- Forks: 35
- Open Issues: 63
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# TKO (“Technical Knockout”)
[](https://badge.fury.io/js/tko)
[](https://gitter.im/knockout/tko?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://circleci.com/gh/knockout/tko)
[](https://coveralls.io/github/knockout/tko?branch=master)
[](https://standardjs.com)
**TKO** houses the monorepo of [Knockout](https://github.com/knockout/knockout).
## Getting Started
To install use one of the usual package managers e.g.
- $ `yarn add @tko/build.reference`
- $ `npm install @tko/build.reference`
Over CDN
- Reference Build: https://cdn.jsdelivr.net/npm/@tko/[email protected]/dist/build.reference.min.js
## Knockout Build
The Knockout build has some backwards compatibility that is not in the reference build. See the build differences, here: https://tko.io/3to4
It's available as `@tko/build.knockout`, and over CDN:
- Knockout Build https://cdn.jsdelivr.net/npm/@tko/[email protected]/dist/build.knockout.min.js
### Using the Monorepo
| Command | Effect |
| ------- | ------ |
| $ `git clone [email protected]:knockout/tko` | Clone the repository. |
| $ `npm install -g yarn` | Ensure yarn is globally available |
| $ `yarn` | Install local node packages and link tko modules |
| $ `make` | **Currently TKO use a make file** |
| $ `yarn test` | Run all tests. See below. |
| $ `yarn watch` | Run all tests and watch for changes. See below. |
| $ `yarn build` | Build tko\[.module\]\[.es6\]\[.min\].js files, where `.es6` version has not been transpiled |
| $ `lerna publish` | Bump versions and publish to npm registry |
Checkout `package.json => scripts` for more commands that can be executed with `yarn {command}`.
In each individual `packages/*/` directory, you can also run (presuming `rollup` and `karma` are installed globally):
| Command | Effect |
| --- | --- |
| $ `karma COMMAND ../../karma.conf.js [--once]` | Test the local package, where COMMAND is e.g. `start` or `run` |
| $ `rollup -c ../../rollup.config.js` | Build the package into the local `dist/` |
#### Testing with `yarn test` and `yarn watch`
### NEW
Start tests with electron: `make test`
Start tests with headless-chrome: `make test-headless`
### OLD
The `yarn test` and `yarn watch` commands can be used in the root directory, where it will run across all tests, or alternatively in any `packages/*/` directory to run tests
specific to that package.
Optional arguments to `yarn test` include:
- `--sauce` — use Sauce Labs to test a variety of platforms; requires an account at Sauce Labs and `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` to be set in the environment.
- `--noStartConnect` — Do not start a new Sauce Connect proxy instance for every
test; requires that Sauce Connect be already running.
#### `visual.html`
Note that running `karma` or `rollup` will create a `visual.html` file that shows the proportional size of imports into each package.
### Objectives
TKO aims to become a base for future versions of Knockout. The objectives include:
- Modularization into ES6 and separate projects, with compilation using an ES6 compiler like [Rollup](http://rollupjs.org/). This solves several problems with Knockout, including:
- Some folks want to roll-their-own with e.g. removing components
- Compilation is now with Closure compiler, which is actually transliterating – meaning the *debug* and *minified* versions have different code paths (mostly in the form of things exposed in *debug* being missing in the *minified* version)
- The compilation of Knockout is just concatenation, leading to difficulties with maintainance, severance, and replacement
- Documentation inline in the source code. This aims to make it easier to document, by making documentation adjacent to the code about-which it speaks. Also, we aim to have examples in the documentation.
- A more comprehensive home page. The hope is to have something fun and fancy, and we have [a rough prototype](http://brianmhunt.github.io/knockout).
- Better setup for plugins. The problems with Knockout include:
- There's no central, searchable repository for knockout
- What should be simple plugins (e.g. binding handlers or providers) are complex, including:
- Built-ins have first-class access to quite a bit of good Knockout code, but plugins generally have second-class access and often have to duplicate Knockout internals
- Quality plugins have lots of boilerplate for compilation, release, documentation, and testing
## Some WSL tricks
Install electron-deps for "make test":
```bash
sudo apt-get install build-essential clang libdbus-1-dev libgtk-3-dev \
libnotify-dev libasound2-dev libcap-dev \
libcups2-dev libxtst-dev \
libxss1 libnss3-dev gcc-multilib g++-multilib curl \
gperf bison python3-dbusmock openjdk-8-jre
```
Install Chrome for "make test-headless":
```bash
wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
sudo apt -y install ./google-chrome-stable_current_amd64.deb
```
## Next steps
There's an [issue for that](https://github.com/knockout/tko/issues/1).
## License
MIT license - [http://www.opensource.org/licenses/mit-license.php.](http://www.opensource.org/licenses/mit-license.php)
## Shout Outs
