Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert to monorepo, split into 3 packages #85

Merged
merged 8 commits into from
Apr 9, 2019
Merged

Conversation

adidahiya
Copy link
Contributor

@adidahiya adidahiya commented Apr 9, 2019

⚠️ Breaking changes ⚠️

  • split functionality into two packages
    • @documentalist/compiler runs in Node (target: es2015) and compiles the data
    • @documentalist/client runs in the browser (target: es5) and contains interfaces/functions/typeguards for rendering the data

❓ Why ❓

Previously, this repo had code meant to run in two separate environments distributed together in one package, documentalist.

Users who wanted to reference documentalist types and helper functions for rendering documentation in a browser using JS had to import these symbols from a submodule like "documentalist/dist/client" (see example in @blueprintjs/docs-theme source)

In #81, documentalist switched to emitting es2015 JS syntax, which is supported in all the Node.js versions we care about, but has some unsupported features (arrow functions) in commonly supported browsers (like IE11). The JS emitted in "documentalist/dist/client" stopped working in IE11.

This PR fixes the problem by splitting up the the TS source for the different runtime environments (Node and browser) and creating separate tsconfig.json projects for each.

@blueprint-bot
Copy link

build fixes

Preview: documentation

@blueprint-bot
Copy link

Fix tests, update snapshots

Preview: documentation

@adidahiya adidahiya changed the base branch from master to develop April 9, 2019 20:56
@adidahiya adidahiya marked this pull request as ready for review April 9, 2019 21:00
@blueprint-bot
Copy link

Update docs

Preview: documentation

@blueprint-bot
Copy link

dedupe lockfile

Preview: documentation

@adidahiya adidahiya merged commit 0a8388f into develop Apr 9, 2019
@adidahiya adidahiya deleted the ad/monorepo branch April 9, 2019 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants