https://github.com/izhaki/mono.ts

A minimal example of a typescript mono repo with pre-build support (tests, vscode).
https://github.com/izhaki/mono.ts

lerna mocha monorepo typescript3 yarn-workspaces

Last synced: 4 days ago
JSON representation

A minimal example of a typescript mono repo with pre-build support (tests, vscode).

• Host: GitHub
• URL: https://github.com/izhaki/mono.ts
• Owner: Izhaki
• Created: 2018-12-28T23:53:46.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-01-15T11:50:32.000Z (almost 6 years ago)
• Last Synced: 2024-10-10T23:17:01.952Z (about 1 month ago)
• Topics: lerna, mocha, monorepo, typescript3, yarn-workspaces
• Language: TypeScript
• Homepage:
• Size: 79.1 KB
• Stars: 64
• Watchers: 3
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Oh Hello!

My name is `mono.ts`. I'm a minimal example of a typescript mono-repo.

# I'm Different

Unlike many similar examples I can do the following, **before you build anything**:

## Run Tests

`/packages/line/package.json`:

`"test": "mocha --require ts-node/register --require tsconfig-paths/register test/*.ts"`

## VSCode Package Linking

If you click on `@geo/point` (`/packages/line/src/index.ts`):

```typescript

import { Point, getDistance } from '@geo/point';

```

VScode will take you to `/packages/point/src/index.ts`

# The Stuff I'm Made Of

- [Yarn Workspaces](https://yarnpkg.com/lang/en/docs/workspaces/)

- [Lerna](https://lernajs.io/)

- [Typescript 3 Project References](https://www.typescriptlang.org/docs/handbook/project-references.html)

- [Mocha](https://mochajs.org/) (using ts-node/register)

# How do I work?

There are basically two parallel typescript configuration hierarchies.

## Pre-build

This tree is using aliases (or *paths* in typescript world). This allows VSCode to reference the correct files, and tests to run.

- `/packages/tsconfig.base.json` (common configuration for both pre-build and build configurations)

    - `/packages/tsconfig.json`

        - `/packages/line/tsconfig.json`

## Build

This tree uses typescript's project reference for optimised builds.

- `/packages/tsconfig.base.json`

    - `/packages/tsconfig.build.json` 

        - `/packages/point/tsconfig.build.json`

        - `/packages/line/tsconfig.build.json`

Note that to build the packages you run (`/package.json`):

`"build": "tsc --build packages/tsconfig.build.json"`

This is allegedly better than letting `yarn` or `lerna` build the packages in turn based on the dependency tree.