From 984a61347f07cdbc30dc1e4db01bb5de3c3ccf78 Mon Sep 17 00:00:00 2001 From: Cole Lawrence Date: Fri, 22 Jul 2022 11:19:48 -0400 Subject: [PATCH] Use "Theatre.js" for name consistency MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fülöp --- .github/workflows/publish-prerelease.yml | 4 ++-- CONTRIBUTING.md | 6 +++--- README.md | 4 ++-- packages/playground/src/shared/dom/index.tsx | 2 +- .../r3f/src/extension/components/EditableProxy.tsx | 4 ++-- theatre/core/README.md | 6 +++--- theatre/core/src/index.ts | 2 +- theatre/core/src/projects/TheatreProject.ts | 2 +- theatre/core/src/sequences/TheatreSequence.ts | 10 +++++----- theatre/shared/src/_logger/logger.shouldLog.test.ts | 2 +- theatre/shared/src/_logger/logger.test.ts | 2 +- theatre/shared/src/_logger/logger.ts | 2 +- theatre/studio/README.md | 6 +++--- theatre/studio/src/Scrub.ts | 2 +- theatre/studio/src/UI.ts | 2 +- theatre/studio/src/UIRoot/UIRoot.tsx | 4 ++-- theatre/studio/src/index.ts | 2 +- 17 files changed, 31 insertions(+), 31 deletions(-) diff --git a/.github/workflows/publish-prerelease.yml b/.github/workflows/publish-prerelease.yml index 78e4f58..4349754 100644 --- a/.github/workflows/publish-prerelease.yml +++ b/.github/workflows/publish-prerelease.yml @@ -23,11 +23,11 @@ jobs: restore-keys: | ${{ runner.os }}-yarn- - run: yarn install - - name: Build the theatre packages + - name: Build the Theatre.js packages run: yarn build - name: Update .yarnrc.yml with the auth config for the npmPublishRegistry run: cat .github/.yarnrc.publish.yml >> .yarnrc.yml - - name: Publish the theatre packages + - name: Publish the Theatre.js packages env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} # LATEST_COMMIT_HASH: ${{ github.event.pull_request.head.sha }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d2c2b9..870420b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,7 +64,7 @@ Read more at ### Hacking with `examples/` Other than `playground`, the [`examples/`](./examples) folder contains a few -small projects that use Theatre with [parcel](https://parceljs.org), +small projects that use Theatre.js with [parcel](https://parceljs.org), [Create react app](create-react-app.dev), and other build tools. This means that unlike `playground`, you have to build all the packages before running the examples. @@ -177,7 +177,7 @@ The [monorepo](https://en.wikipedia.org/wiki/Monorepo) consists of: [`./theatre/studio`](./theatre/studio). - `@theatre/dataverse` – The reactive dataflow library at [`./packages/dataverse`](./packages/dataverse). -- `@theatre/react` – Utilities for using Theatre with React at +- `@theatre/react` – Utilities for using Theatre.js with React at [`./packages/react`](./packages/react). - `@theatre/r3f` – The react-three-fiber extension at [`./packages/r3f`](./packages/r3f). @@ -278,4 +278,4 @@ Squash & merge should be preferred most of the time to keep the main branch clea Always update your feature branch with a rebase from the main branch to make sure that you don't accidentally break main with an undetected conflict. -Branches belonging to merged PRs should be deleted. \ No newline at end of file +Branches belonging to merged PRs should be deleted. diff --git a/README.md b/README.md index 7fdbd1f..7987919 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Theatre.js is an animation library for high-fidelity motion graphics. It is designed to help you express detailed animation, enabling you to create intricate movement, and convey nuance. -Theatre can be used both programmatically _and_ visually. +Theatre.js can be used both programmatically _and_ visually. --- @@ -65,7 +65,7 @@ The docs are at [docs.theatrejs.com](https://docs.theatrejs.com): - [Animating with music](https://www.youtube.com/watch?v=QoS4gMxwq_4) - [Yuri Artiukh](https://twitter.com/akella)'s [stream](https://youtu.be/qmRqgFbNprM?t=3462) with a section on using - Theatre with THREE.js + Theatre.js with THREE.js - \ ## Community and support diff --git a/packages/playground/src/shared/dom/index.tsx b/packages/playground/src/shared/dom/index.tsx index a14ef37..9d1549d 100644 --- a/packages/playground/src/shared/dom/index.tsx +++ b/packages/playground/src/shared/dom/index.tsx @@ -4,7 +4,7 @@ import studio from '@theatre/studio' import {getProject} from '@theatre/core' import {Scene} from './Scene' /** - * This is a basic example of using Theatre for manipulating the DOM. + * This is a basic example of using Theatre.js for manipulating the DOM. * * It also uses {@link IStudio.selection | studio.selection} to customize * the selection behavior. diff --git a/packages/r3f/src/extension/components/EditableProxy.tsx b/packages/r3f/src/extension/components/EditableProxy.tsx index e909c85..e5f2bfc 100644 --- a/packages/r3f/src/extension/components/EditableProxy.tsx +++ b/packages/r3f/src/extension/components/EditableProxy.tsx @@ -125,7 +125,7 @@ const EditableProxy: VFC = ({storeKey, object}) => { useExtensionStore.getState().editables[storeKey].sheetObject if (!theatreObject) { - console.log('no theatre object for', storeKey) + console.log('no Theatre.js object for', storeKey) } else { studio.setSelection([theatreObject]) } @@ -172,7 +172,7 @@ const EditableProxy: VFC = ({storeKey, object}) => { useExtensionStore.getState().editables[storeKey].sheetObject if (!theatreObject) { - console.log('no theatre object for', storeKey) + console.log('no Theatre.js object for', storeKey) } else { studio.setSelection([theatreObject]) } diff --git a/theatre/core/README.md b/theatre/core/README.md index 3aa12f1..9ba58cc 100644 --- a/theatre/core/README.md +++ b/theatre/core/README.md @@ -2,7 +2,7 @@ Theatre.js is an animation library for high-fidelity motion graphics. It is designed to help you express detailed animation, enabling you to create intricate movement, and convey nuance. -Theatre can be used both programmatically _and_ visually. +Theatre.js can be used both programmatically _and_ visually. You can use Theatre.js to: @@ -38,7 +38,7 @@ Join us on [Discord](https://discord.gg/bm9f8F9Y9N), follow the updates on [twit ## `@theatre/core` -Theatre comes in two packages: `@theatre/core` (the library) and `@theatre/studio` (the editor). This package is the core library. +Theatre.js comes in two packages: `@theatre/core` (the library) and `@theatre/studio` (the editor). This package is the core library. ## Bundle size @@ -46,4 +46,4 @@ Theatre comes in two packages: `@theatre/core` (the library) and `@theatre/studi ## License -Apache 2.0 \ No newline at end of file +Apache 2.0 diff --git a/theatre/core/src/index.ts b/theatre/core/src/index.ts index 09e70fb..5998343 100644 --- a/theatre/core/src/index.ts +++ b/theatre/core/src/index.ts @@ -77,7 +77,7 @@ function registerCoreBundle() { */ throw new Error( `It seems that the module '@theatre/core' is loaded more than once. This could have two possible causes:\n` + - `1. You might have two separate versions of theatre in node_modules.\n` + + `1. You might have two separate versions of Theatre.js in node_modules.\n` + `2. Or this might be a bundling misconfiguration, in case you're using a bundler like Webpack/ESBuild/Rollup.\n\n` + `Note that it **is okay** to import '@theatre/core' multiple times. But those imports should point to the same module.`, ) diff --git a/theatre/core/src/projects/TheatreProject.ts b/theatre/core/src/projects/TheatreProject.ts index a6c2e3f..3893bf3 100644 --- a/theatre/core/src/projects/TheatreProject.ts +++ b/theatre/core/src/projects/TheatreProject.ts @@ -39,7 +39,7 @@ export type IProjectConfig = { // } /** - * A Theatre project + * A Theatre.js project */ export interface IProject { readonly type: 'Theatre_Project_PublicAPI' diff --git a/theatre/core/src/sequences/TheatreSequence.ts b/theatre/core/src/sequences/TheatreSequence.ts index c749ea5..b8e2199 100644 --- a/theatre/core/src/sequences/TheatreSequence.ts +++ b/theatre/core/src/sequences/TheatreSequence.ts @@ -136,7 +136,7 @@ export interface ISequence { * Usage: * ```ts * // Loads and decodes audio from the URL and then attaches it to the sequence - * await sheet.sequence.attachAudio({source: "https://localhost/audio.ogg"}) + * await sheet.sequence.attachAudio({source: "https://localhost:3000/audio.mp3"}) * sheet.sequence.play() * * // Providing your own AudioAPI Context, destination, etc @@ -147,9 +147,9 @@ export interface ISequence { * await sheet.sequence.attachAudio({source: audioBuffer, audioContext, destinationNode}) * ``` * - * Note: It's better to provide the `audioContext` rather than allow Theatre to create it. + * Note: It's better to provide the `audioContext` rather than allow Theatre.js to create it. * That's because some browsers [suspend the audioContext](https://developer.chrome.com/blog/autoplay/#webaudio) - * unless it's initiated by a user gesture, like a click. If that happens, Theatre will + * unless it's initiated by a user gesture, like a click. If that happens, Theatre.js will * wait for a user gesture to resume the audioContext. But that's probably not an * optimal user experience. It is better to provide a button or some other UI element * to communicate to the user that they have to initiate the animation. @@ -190,7 +190,7 @@ export interface ISequence { destinationNode: AudioNode /** - * This is an intermediate GainNode that Theatre feeds its audio to. It is by default + * This is an intermediate GainNode that Theatre.js feeds its audio to. It is by default * connected to destinationNode, but you can disconnect the gainNode and feed it to your own graph. * * @example @@ -241,7 +241,7 @@ export default class TheatreSequence implements ISequence { if (process.env.NODE_ENV !== 'production') { console.warn( `You seem to have called sequence.play() before the project has finished loading.\n` + - `This would **not** a problem in production when using '@theatre/core', since Theatre loads instantly in core mode. ` + + `This would **not** a problem in production when using '@theatre/core', since Theatre.js loads instantly in core mode. ` + `However, when using '@theatre/studio', it takes a few milliseconds for it to load your project's state, ` + `before which your sequences cannot start playing.\n` + `\n` + diff --git a/theatre/shared/src/_logger/logger.shouldLog.test.ts b/theatre/shared/src/_logger/logger.shouldLog.test.ts index 8073843..87e8855 100644 --- a/theatre/shared/src/_logger/logger.shouldLog.test.ts +++ b/theatre/shared/src/_logger/logger.shouldLog.test.ts @@ -1,7 +1,7 @@ import {TheatreLoggerLevel, _LoggerLevel} from './logger' import {_loggerShouldLog} from './logger' -describe('Theatre internal logger: shouldLog', () => { +describe('Theatre.js internal logger: shouldLog', () => { testIncludes( 'TRACE dev/internal', { diff --git a/theatre/shared/src/_logger/logger.test.ts b/theatre/shared/src/_logger/logger.test.ts index af3cd87..6aea0bb 100644 --- a/theatre/shared/src/_logger/logger.test.ts +++ b/theatre/shared/src/_logger/logger.test.ts @@ -1,7 +1,7 @@ import {TheatreLoggerLevel} from './logger' import {describeLogger} from './logger.test-helpers' -describeLogger('Theatre internal logger', (setup) => { +describeLogger('Theatre.js internal logger', (setup) => { describe('default logger', () => { test('it reports public messages', () => { const t = setup().t() diff --git a/theatre/shared/src/_logger/logger.ts b/theatre/shared/src/_logger/logger.ts index 656dbcb..4e3e3a8 100644 --- a/theatre/shared/src/_logger/logger.ts +++ b/theatre/shared/src/_logger/logger.ts @@ -159,7 +159,7 @@ export enum TheatreLoggerLevel { } /** - * @internal Theatre internal "dev" levels are odd numbers + * @internal Theatre.js internal "dev" levels are odd numbers * * You can check if a level is odd quickly by doing `level & 1 === 1` */ diff --git a/theatre/studio/README.md b/theatre/studio/README.md index a48607e..1332a4c 100644 --- a/theatre/studio/README.md +++ b/theatre/studio/README.md @@ -2,7 +2,7 @@ Theatre.js is an animation library for high-fidelity motion graphics. It is designed to help you express detailed animation, enabling you to create intricate movement, and convey nuance. -Theatre can be used both programmatically _and_ visually. +Theatre.js can be used both programmatically _and_ visually. You can use Theatre.js to: @@ -38,11 +38,11 @@ Join us on [Discord](https://discord.gg/bm9f8F9Y9N), follow the updates on [twit ## `@theatre/studio` -Theatre comes in two packages: `@theatre/core` (the library) and `@theatre/studio` (the editor). This package is the editor, which is only used during design/development. +Theatre.js comes in two packages: `@theatre/core` (the library) and `@theatre/studio` (the editor). This package is the editor, which is only used during design/development. ## License Your use of Theatre.js is governed under the Apache License Version 2.0: * Theatre's core (`@theatre/core`) is released under the Apache License. -* The studio (`@theatre/studio`) is released under the AGPL 3.0 License. This is the package that you use to edit your animations, setup your scenes, etc. You only use the studio during design/development. Your project's final bundle only includes `@theatre/core`, so only the Apache License applies. \ No newline at end of file +* The studio (`@theatre/studio`) is released under the AGPL 3.0 License. This is the package that you use to edit your animations, setup your scenes, etc. You only use the studio during design/development. Your project's final bundle only includes `@theatre/core`, so only the Apache License applies. diff --git a/theatre/studio/src/Scrub.ts b/theatre/studio/src/Scrub.ts index ae5b10a..5e43705 100644 --- a/theatre/studio/src/Scrub.ts +++ b/theatre/studio/src/Scrub.ts @@ -21,7 +21,7 @@ type State = let lastScrubIdAsNumber = 0 /** - * The scrub API is a simple construct for changing values in Theatre in a history-compatible way. + * The scrub API is a simple construct for changing values in Theatre.js in a history-compatible way. * Primarily, it can be used to create a series of value changes using a temp transaction without * creating multiple transactions. * diff --git a/theatre/studio/src/UI.ts b/theatre/studio/src/UI.ts index c39518e..890cc0d 100644 --- a/theatre/studio/src/UI.ts +++ b/theatre/studio/src/UI.ts @@ -16,7 +16,7 @@ export default class UI { readonly containerShadow: ShadowRoot & HTMLElement constructor(readonly studio: Studio) { - // @todo we can't bootstrap theatre (as in, to design theatre using theatre), if we rely on IDed elements + // @todo we can't bootstrap Theatre.js (as in, to design Theatre.js using theatre), if we rely on IDed elements this.containerEl.id = 'theatrejs-studio-root' this.containerEl.style.cssText = ` diff --git a/theatre/studio/src/UIRoot/UIRoot.tsx b/theatre/studio/src/UIRoot/UIRoot.tsx index 80d06a2..b484009 100644 --- a/theatre/studio/src/UIRoot/UIRoot.tsx +++ b/theatre/studio/src/UIRoot/UIRoot.tsx @@ -60,7 +60,7 @@ export default function UIRoot() { dev: INTERNAL_LOGGING, internal: INTERNAL_LOGGING, }) - const logger = uiRootLogger.getLogger().named('Theatre UIRoot') + const logger = uiRootLogger.getLogger().named('Theatre.js UIRoot') useKeyboardShortcuts() @@ -68,7 +68,7 @@ export default function UIRoot() { useEffect(() => { if (visiblityState === 'everythingIsHidden') { console.warn( - `Theatre Studio is hidden. Use the keyboard shortcut 'alt + \\' to restore the studio, or call studio.ui.restore().`, + `Theatre.js Studio is hidden. Use the keyboard shortcut 'alt + \\' to restore the studio, or call studio.ui.restore().`, ) } return () => {} diff --git a/theatre/studio/src/index.ts b/theatre/studio/src/index.ts index 2d463c6..5d18d79 100644 --- a/theatre/studio/src/index.ts +++ b/theatre/studio/src/index.ts @@ -40,7 +40,7 @@ function registerStudioBundle() { ) { throw new Error( `It seems that the module '@theatre/studio' is loaded more than once. This could have two possible causes:\n` + - `1. You might have two separate versions of theatre in node_modules.\n` + + `1. You might have two separate versions of Theatre.js in node_modules.\n` + `2. Or this might be a bundling misconfiguration, in case you're using a bundler like Webpack/ESBuild/Rollup.\n\n` + `Note that it **is okay** to import '@theatre/studio' multiple times. But those imports should point to the same module.`, )