variablelab/theatre
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
theatre/CONTRIBUTING.md
Aria Minaei 3ed7e6bf6c More docs
2021-10-06 12:49:04 +02:00

6 KiB
Raw Blame History

Contributing to Theatre.js

Development workflow

Setting up the environment

Make sure you have node 14+ installed:

$ node -v
> v14.0.0

and yarn 1.22+:

$ yarn -v
> 1.22.10

Then clone the repo:

$ git clone git@github.com:AriaMinaei/theatre.git
$ cd theatre

And fetch the dependencies with yarn:

$ yarn
  • Notes about Yarn:
    • This project uses yarn workspaces so npm install will not work.
    • This repo uses Yarn v2. You don't have to install yarn v2 globally. If you do have yarn 1.22.10+ on your machine, yarn will automatically switch to v2 when you cd into theatre. Read more about Yarn v2 here.

Hacking with playground

The quickest way to start tweaking things is to run the playground package.

$ cd ./packages/playground
$ yarn serve

The playground is a bunch of ready-made projects that you can run to experiment with Theatre.js.

It uses a single ESBuild config to build all of the related packages in one go, so you don't have to run a bunch of build commands separately.

Read more at ./packages/playground/README.md.

Hacking with examples/

Other than playground, the examples/ folder contains a few small projects that use Theatre with parcel, Create react app, and other build tools. This means that unlike playground, you have to build all the packages before running the examples.

You can do that by running the build command at the root of the repo:

$ yarn build

Then build any of the examples:

$ cd examples/dom-cra
$ yarn start

Running tests

We use a single jest setup for the repo. The tests files have the .test.ts or .test.tsx extension.

You can run the tests at the root of the repo:

$ yarn test

# or run them in watch mode:
$ yarn test --watch

Type checking

The packages in this repo have full typescript coverage, so you should be able to get diagnostics and intellisense if your editor supports typescript.

You can also run a typecheck of the whole repo from the root:

$ yarn typecheck

# or in watch mode:
$ yarn typecheck --watch
  • If you're using VSCode, we have a "Typescript watch" task for VSCode that you can use by running "Run Task -> Typescript watch".
  • If you wish to contribute code without typescript annotations, that's totally fine. We're happy to add the annotations to your PR.

Linting

We're using a minimal ESLint setup for linting. If your editor supports ESLint, you should get diagnostics as you code. You can also run the lint command from the root of the repo:

$ yarn lint:all

Some lint rules have autofix, so you can run:

$ yarn lint:all --fix

Publishing to npm

Currently all packages (except for @theatre/r3f) share the same version number. In order to publish to npm, you can run the release script from the root of the repo:

$ yarn release x.y.z # npm publish version x.y.z
$ yarn release x.y.z-dev.w # npm publish version x.y.z-dev.w and tag it as "dev"
$ yarn release x.y.z-rc.w # npm publish version x.y.z-rc.w and tag it as "rc"

Generating API docs

We use API extractor to generate API docs in markdown. We put the markdown files in the theatre-docs repo, which also contains the tutorials and guides.

To generate the API docs, run the build:api-docs from the root of the repo:

$ yarn build:api-docs /path/to/theatre-docs/docs/api/ # this will empty the /api folder and regenerate the markdown files

Project structure

The monorepo consists of:

In addition, each package may contain a dotEnv/ folder that holds some dev-related files, like bundle configuration, lint setup, etc.

Commands

These commands are available at the root workspace:

# Run the playground. It's a shortcut for `cd ./playground; yarn run serve`
$ yarn playground

# Run all the tests.
$ yarn test

# Run tests in watch mode.
$ yarn test --watch

# Typecheck all the packages
$ yarn typecheck

# Typecheck all the packages in watch mode
$ yarn typecheck --watch

# Run eslint on the repo
$ yarn lint:all

# Run eslint and auto fix
$ yarn lint:all --fix

# Build all the packages
$ yarn build

# Build the api documentation
$ yarn build:api-docs /path/to/theatre-docs/docs/api/

Yarn passes all extra parameters to the internal scripts. So, for example, if you wish to run the tests in watch mode, you can run yarn test --watch.

Documentation

The libraries come bundled with typescript definitions with TSDoc comments. You can explore the API if your editor is configured to display TSDoc comments.

Other references