Skip to content

🎥 Make videos programmatically with React

Add GitHub actions to composition menus

JonnyBurgerce12b599d59c
diff --git a/packages/studio/src/components/composition-menu-items.ts b/packages/studio/src/components/composition-menu-items.ts
index 8e8bf7ca35..ca102ba155 100644
--- a/packages/studio/src/components/composition-menu-items.ts
+++ b/packages/studio/src/components/composition-menu-items.ts
@@ -6,7 +6,9 @@ import {
formatContextForAgents,
formatFileLocation,
} from '../helpers/format-file-location';
+import {getGitSourceName, openGitSource} from '../helpers/get-git-menu-item';
import {
+ loadCompositionComponentInfo,
openCompositionComponentInEditor,
openOriginalPositionInEditor,
} from '../helpers/open-in-editor';
@@ -53,6 +55,14 @@ export const getCompositionMenuItems = ({
!resolvedLocation;
const openComponentInEditorDisabled =
showInEditorDisabled || !resolvedLocation?.source;
+ const gitSourceName = window.remotion_gitSource
+ ? getGitSourceName(window.remotion_gitSource)
+ : null;
+ const openCompositionInGitSourceDisabled = !composition || !resolvedLocation;
+ const openComponentInGitSourceDisabled =
+ openCompositionInGitSourceDisabled ||
+ !resolvedLocation?.source ||
+ (!readOnlyStudio && connectionStatus !== 'connected');
const copyFileLocationDisabled = !composition || !fileLocation;
return [
@@ -110,7 +120,53 @@ export const getCompositionMenuItems = ({
disabled: openComponentInEditorDisabled,
}
: null,
- editorName && includeCompositionManagementItems
+ gitSourceName
+ ? {
+ id: 'open-composition-in-git-source',
+ keyHint: null,
+ label: `Open composition in ${gitSourceName}`,
+ leftItem: null,
+ onClick: () => {
+ closeMenu();
+ openGitSource({folder: false, location: resolvedLocation});
+ },
+ quickSwitcherLabel: `Open composition in ${gitSourceName}`,
+ subMenu: null,
+ type: 'item' as const,
+ value: 'open-composition-in-git-source',
+ disabled: openCompositionInGitSourceDisabled,
+ }
+ : null,
+ gitSourceName
+ ? {
+ id: 'open-component-in-git-source',
+ keyHint: null,
+ label: `Open component in ${gitSourceName}`,
+ leftItem: null,
+ onClick: async () => {
+ closeMenu();
+ if (!composition || !resolvedLocation?.source) {
+ return;
+ }
+
+ try {
+ const info = await loadCompositionComponentInfo({
+ compositionFile: resolvedLocation.source,
+ compositionId: composition.id,
+ });
+ openGitSource({folder: false, location: info.location});
+ } catch (err) {
+ showNotification((err as Error).message, 2000);
+ }
+ },
+ quickSwitcherLabel: `Open composition component in ${gitSourceName}`,
+ subMenu: null,
+ type: 'item' as const,
+ value: 'open-component-in-git-source',
+ disabled: openComponentInGitSourceDisabled,
+ }
+ : null,
+ (editorName || gitSourceName) && includeCompositionManagementItems
? {
type: 'divider' as const,
id: 'show-in-editor-divider',
@@ -190,7 +246,7 @@ export const getCompositionMenuItems = ({
disabled: !composition || readOnlyStudio,
}
: null,
- editorName || includeCompositionManagementItems
+ editorName || gitSourceName || includeCompositionManagementItems
? {
type: 'divider' as const,
id: 'copy-actions-divider',
diff --git a/packages/studio/src/test/composition-menu-items.test.ts b/packages/studio/src/test/composition-menu-items.test.ts
index fc4ef3aa1a..d0e28359b1 100644
--- a/packages/studio/src/test/composition-menu-items.test.ts
+++ b/packages/studio/src/test/composition-menu-items.test.ts
@@ -1,4 +1,5 @@
import {afterEach, expect, mock, test} from 'bun:test';
+import type {GitSource} from '@remotion/studio-shared';
import type {_InternalTypes, ResolvedStackLocation} from 'remotion';
import {
getCompositionContextMenuItems,
@@ -48,6 +49,36 @@ const installTestWindowWithEditor = () => {
});
};
+const installTestWindowWithGitSource = ({
+ readOnly,
+}: {
+ readonly readOnly: boolean;
+}) => {
+ const openedUrls: string[] = [];
+ const gitSource: GitSource = {
+ name: 'project',
+ org: 'example',
+ ref: 'main',
+ relativeFromGitRoot: '',
+ type: 'github',
+ };
+ Object.defineProperty(globalThis, 'window', {
+ configurable: true,
+ value: {
+ open: (url: string) => {
+ openedUrls.push(url);
+ return null;
+ },
+ remotion_cwd: '/project',
+ remotion_editorName: readOnly ? null : 'Code',
+ remotion_gitSource: gitSource,
+ remotion_isReadOnlyStudio: readOnly,
+ },
+ });
+
+ return openedUrls;
+};
+
const composition = {
id: 'ConnectedComposition',
durationInFrames: 100,
@@ -217,3 +248,46 @@ test('read-only composition menus keep navigation and copy actions enabled', ()
expect(itemById('duplicate').disabled).toBe(true);
expect(itemById('delete').disabled).toBe(true);
});
+
+test('composition context menus can open source locations on GitHub', () => {
+ const openedUrls = installTestWindowWithGitSource({readOnly: true});
+ const items = getCompositionContextMenuItems({
+ ...commonArgs,
+ editorId: null,
+ editorName: null,
+ includeCompositionManagementItems: true,
+ readOnlyStudio: true,
+ resolvedLocation,
+ });
+ const compositionItem = items.find(
+ (item) => item.id === 'open-composition-in-git-source',
+ );
+ const componentItem = items.find(
+ (item) => item.id === 'open-component-in-git-source',
+ );
+ if (compositionItem?.type !== 'item' || componentItem?.type !== 'item') {
+ throw new Error('Expected GitHub composition actions');
+ }
+
+ expect(compositionItem.label).toBe('Open composition in GitHub');
+ expect(componentItem.label).toBe('Open component in GitHub');
+ expect(compositionItem.disabled).toBe(false);
+ expect(componentItem.disabled).toBe(false);
+ compositionItem.onClick(compositionItem.id, null);
+ expect(openedUrls).toEqual([
+ 'https://github.com/example/project/blob/main/src/Composition.tsx#L10',
+ ]);
+});
+
+test('interactive composition context menus retain GitHub actions', () => {
+ installTestWindowWithGitSource({readOnly: false});
+ const items = getCompositionContextMenuItems({
+ ...commonArgs,
+ includeCompositionManagementItems: false,
+ resolvedLocation,
+ });
+
+ expect(ids(items)).toContain('show-in-editor');
+ expect(ids(items)).toContain('open-composition-in-git-source');
+ expect(ids(items)).toContain('open-component-in-git-source');
+});