studies

Open Tealstreet study and indicator definitions. The package is designed to hold runtime-neutral study metadata plus small adapters for supported chart engines.

This is a mirror. It's a filtered, read/write view of an upstream monorepo. Contribute here normally (branch, PR, review); accepted changes are synced upstream. Everything needed to build and test lives in this repo - you don't need upstream access.

For contributor workflow details, see CONTRIBUTING.md. For coding agents and LLM tools, see AGENTS.md.

Packages

packages/studies   Shared study metadata and runtime adapters

Develop

yarn install
yarn typecheck
yarn lint
yarn test

Using Studies

import { getPvsraPineJsStudies } from '@tealstreet/studies/pinejs';

The current adapter target is PineJS. Keep shared definitions runtime-neutral so future Tealchart-native studies can use the same metadata where possible.

Contributing

Branch off master, open a PR, and wait for a maintainer to review and merge. Merged changes sync upstream automatically; you do not need upstream access.

If Git reports a conflict, stop and ask in the PR. Do not commit directly to master.

Simple workflow with just

Install just and the GitHub CLI once:

brew install just gh
gh auth login

Start from the newest mirror master and create a feature branch:

just start feat/my-change

Do your work, then run the normal checks:

just check

Push and open a PR:

just pr

After the PR is merged, return to a clean master:

just done feat/my-change

Same workflow with plain Git

Start from the newest mirror master:

git switch master
git pull --ff-only origin master
git switch -c feat/my-change

Push and open a PR:

git push -u origin HEAD
gh pr create --fill

After the PR is merged:

git switch master
git pull --ff-only origin master
git branch -d feat/my-change

License

MIT - see LICENSE.