Type Link Model (TLM) Monorepo

TLM is a simple modelling technique inspired by Object Role Modelling that is suitable for working with web APIs and the typical simple tree structures used in web documents.

This is an unfinished hobby project. Use at your own risk.

Prerequisites

• latest LTS node
• recent pnpm, if you have node, try corepack enable
• docker cli installed and connected

Rust version

• latest stable rust

Build

pnpm install
pnpm run setup
pnpm run test

Rust version

cargo build
cargo test
cargo clippy -- -D warnings

or run tests with coverage:

brew install cargo-llvm-cov
cargo llvm-cov

Code

TypeScript

Code style follows Prettier.

Commits

Follow

https://conventionalcommits.org/

with types:

• build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
• ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
• docs: Documentation only changes
• feat: A new feature
• fix: A bug fix
• perf: A code change that improves performance
• refactor: A code change that neither fixes a bug nor adds a feature
• revert: undoing (an)other commit(s)
• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• test: Adding missing tests or correcting existing tests
• improvement: Improves code in some other way (that is not a feat or fix)
• chore: Changes that take care of some other kind of chore that doesn't impact the main code

(based on angular conventions https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit)

Dependency management

• Run pnpm update -r to do minor dependency updates
• Run pnpm up -L -r to do major dependency updates
• Run pnpm run x dedupe-deps to add overrides to package.json to try and pin transitive dependencies to later versions

More info

See docs/.