open-index/open-npm huggingface dataset:
npm package: @movable/studio-utilities
Description: Collection of Studio Framework Utilities
Latest version: 1.0.1

# Studio Utilities

Collects non-customer facing utilities intended for use with Studio Framework packages, apps, libraries and Tactics.

See [this document](https://www.notion.so/movableinkepd/Packages-Nailing-Down-Definitions-843bd5a1de034836872ad88623c01a53?pvs=4) to learn more about these definitions.

## Install

Clone this repo, then run `yarn install`.

## Test

This repo uses Jest with the JestDOM environment. Run `yarn run test` to run all tests. Test files should be kept alongside the utility code and end in `.spec.ts`.

## Development

### What should be included in this repo?

Studio utilities _are not_ Studio Packages, meaning they are not packaged by the [Studio Packaging Service](https://github.com/movableink/studio-packaging-service), do not depend on [Studio Framework](https://github.com/movableink/studio-framework) and are not deployed to Packagecloud. If your package needs any of these to be true, or if it needs to leverage Studio Framework to register tools, it should go in the [Studio Apps](https://github.com/movableink/studio-apps) repo.

Studio utilities _are_ independent and generic helpers than may be installed via NPM and imported into studio packages, apps and tactics.

Each utility should have its own directory under `src` and should be exported from that directory through an `index.ts` file. Utilities don't necessarily need to be single functions, but should be grouped by logical operation.

For example, `enable-client-side-app` has two utilities required to make studio apps work in a client side environment. When more than one function is grouped into a utility directory, tests should be separated into a `tests` directory.

## Deploying

_TBD_

## Help

Reach out to `#mobile-team-eng` or `#studio-apps-eng` on Slack.