Skip to content

Visualize Your Ideas With Code

feat(vite-plugin): let plugins override config (#1054)

Jacob9b01eb58b746
diff --git a/packages/vite-plugin/src/main.ts b/packages/vite-plugin/src/main.ts
index 45e9c88a..32669e63 100644
--- a/packages/vite-plugin/src/main.ts
+++ b/packages/vite-plugin/src/main.ts
@@ -12,7 +12,7 @@ import {
settingsPlugin,
webglPlugin,
} from './partials';
-import {PLUGIN_OPTIONS, PluginOptions, isPlugin} from './plugins';
+import {PLUGIN_OPTIONS, PluginConfig, PluginOptions, isPlugin} from './plugins';
import {getProjects} from './utils';
export interface MotionCanvasPluginConfig {
@@ -104,8 +104,10 @@ export default ({
buildForEditor,
}: MotionCanvasPluginConfig = {}): Plugin[] => {
const plugins: PluginOptions[] = [];
- const outputPath = path.resolve(output);
- const projects = getProjects(project);
+ let config: PluginConfig = {
+ output: path.resolve(output),
+ projects: getProjects(project),
+ };
return [
{
@@ -116,23 +118,21 @@ export default ({
.filter(isPlugin)
.map(plugin => plugin[PLUGIN_OPTIONS]),
);
- await Promise.all(
- plugins.map(
- plugin =>
- plugin.config?.({
- output: outputPath,
- projects: projects.list,
- }),
- ),
- );
+
+ for (const plugin of plugins) {
+ const newConfig = await plugin.config?.(config);
+ if (newConfig) {
+ config = {...config, ...newConfig};
+ }
+ }
},
},
metaPlugin(),
settingsPlugin(),
scenesPlugin(),
- exporterPlugin({outputPath}),
- editorPlugin({editor, projects}),
- projectsPlugin({projects, plugins, buildForEditor}),
+ exporterPlugin({outputPath: config.output}),
+ editorPlugin({editor, projects: config.projects}),
+ projectsPlugin({projects: config.projects, plugins, buildForEditor}),
assetsPlugin({bufferedAssets}),
webglPlugin(),
corsProxyPlugin(proxy),
diff --git a/packages/vite-plugin/src/partials/editor.ts b/packages/vite-plugin/src/partials/editor.ts
index afb3747b..dc7cb56a 100644
--- a/packages/vite-plugin/src/partials/editor.ts
+++ b/packages/vite-plugin/src/partials/editor.ts
@@ -1,11 +1,11 @@
import fs from 'fs';
import path from 'path';
import {Plugin} from 'vite';
-import {Projects} from '../utils';
+import {ProjectData} from '../plugins';
interface EditorPluginConfig {
editor: string;
- projects: Projects;
+ projects: ProjectData[];
}
export function editorPlugin({editor, projects}: EditorPluginConfig): Plugin {
@@ -16,9 +16,13 @@ export function editorPlugin({editor, projects}: EditorPluginConfig): Plugin {
.replace('{{style}}', `/@fs/${path.resolve(editorPath, 'style.css')}`)
.split('{{source}}');
const createHtml = (src: string) => htmlParts[0] + src + htmlParts[1];
-
const resolvedEditorId = '\0virtual:editor';
+ const lookup = new Map<string, ProjectData>();
+ for (const project of projects) {
+ lookup.set(project.name, project);
+ }
+
return {
name: 'motion-canvas:editor',
@@ -26,11 +30,11 @@ export function editorPlugin({editor, projects}: EditorPluginConfig): Plugin {
const [, query] = id.split('?');
if (id.startsWith(resolvedEditorId)) {
- if (projects.list.length === 1) {
+ if (projects.length === 1) {
/* language=typescript */
return `\
import {editor} from '${editor}';
-import project from '${projects.list[0].url}?project';
+import project from '${projects[0].url}?project';
editor(project);
`;
}
@@ -38,11 +42,11 @@ editor(project);
if (query) {
const params = new URLSearchParams(query);
const name = params.get('project');
- if (name && projects.lookup.has(name)) {
+ if (name && lookup.has(name)) {
/* language=typescript */
return `\
import {editor} from '${editor}';
-import project from '${projects.lookup.get(name)!.url}?project';
+import project from '${lookup.get(name)!.url}?project';
editor(project);
`;
}
@@ -51,7 +55,7 @@ editor(project);
/* language=typescript */
return `\
import {index} from '${editor}';
-index(${JSON.stringify(projects.list)});
+index(${JSON.stringify(projects)});
`;
}
},
@@ -67,7 +71,7 @@ index(${JSON.stringify(projects.list)});
}
const name = url.pathname.slice(1);
- if (name && projects.lookup.has(name)) {
+ if (name && lookup.has(name)) {
res.setHeader('Content-Type', 'text/html');
res.end(createHtml(`/@id/__x00__virtual:editor?project=${name}`));
return;
diff --git a/packages/vite-plugin/src/partials/projects.ts b/packages/vite-plugin/src/partials/projects.ts
index 8138c005..dc431a09 100644
--- a/packages/vite-plugin/src/partials/projects.ts
+++ b/packages/vite-plugin/src/partials/projects.ts
@@ -1,7 +1,7 @@
import path from 'path';
import {Plugin, ResolvedConfig} from 'vite';
-import {PluginOptions} from '../plugins';
-import {Projects, createMeta} from '../utils';
+import {PluginOptions, ProjectData} from '../plugins';
+import {createMeta} from '../utils';
import {getVersions} from '../versions';
const PROJECT_QUERY_REGEX = /[?&]project\b/;
@@ -9,7 +9,7 @@ const PROJECT_QUERY_REGEX = /[?&]project\b/;
interface ProjectPluginConfig {
buildForEditor?: boolean;
plugins: PluginOptions[];
- projects: Projects;
+ projects: ProjectData[];
}
export function projectsPlugin({
@@ -83,10 +83,7 @@ import {MetaFile} from '@motion-canvas/core';
rollupOptions: {
preserveEntrySignatures: 'strict',
input: Object.fromEntries(
- projects.list.map(project => [
- project.name,
- project.url + '?project',
- ]),
+ projects.map(project => [project.name, project.url + '?project']),
),
},
},
@@ -98,7 +95,7 @@ import {MetaFile} from '@motion-canvas/core';
jsxImportSource: '@motion-canvas/2d/lib',
},
optimizeDeps: {
- entries: projects.list.map(project => project.url),
+ entries: projects.map(project => project.url),
exclude: ['preact', 'preact/*', '@preact/signals'],
},
};
diff --git a/packages/vite-plugin/src/plugins.ts b/packages/vite-plugin/src/plugins.ts
index 39862226..e21dd009 100644
--- a/packages/vite-plugin/src/plugins.ts
+++ b/packages/vite-plugin/src/plugins.ts
@@ -55,11 +55,12 @@ export interface PluginOptions {
*
* @remarks
* Invoked during `configResolved` hook of Vite, contains the Motion Canvas
- * specific configuration.
+ * specific configuration. Returned value will be merged with the current
+ * configuration.
*
* @param config - The configuration passed to the plugin.
*/
- config?(config: PluginConfig): Promise<void>;
+ config?(config: PluginConfig): Promise<Partial<PluginConfig> | void>;
/**
* Get custom configuration that will be passed to the runtime plugin.
diff --git a/packages/vite-plugin/src/utils.ts b/packages/vite-plugin/src/utils.ts
index bfcba00d..99b67bb5 100644
--- a/packages/vite-plugin/src/utils.ts
+++ b/packages/vite-plugin/src/utils.ts
@@ -3,11 +3,6 @@ import fs from 'fs';
import path from 'path';
import {ProjectData} from './plugins';
-export interface Projects {
- list: ProjectData[];
- lookup: Map<string, ProjectData>;
-}
-
export async function createMeta(metaPath: string) {
if (!fs.existsSync(metaPath)) {
await fs.promises.writeFile(
@@ -18,10 +13,8 @@ export async function createMeta(metaPath: string) {
}
}
-export function getProjects(project: string | string[]): Projects {
+export function getProjects(project: string | string[]): ProjectData[] {
const list: ProjectData[] = [];
- const lookup = new Map<string, ProjectData>();
-
const projectList = expandFilePaths(project);
for (const url of projectList) {
const {name, dir} = path.posix.parse(url);
@@ -29,10 +22,9 @@ export function getProjects(project: string | string[]): Projects {
const metaData = getMeta(path.join(dir, metaFile));
const data = {name: metaData?.name ?? name, fileName: name, url};
list.push(data);
- lookup.set(data.name, data);
}
- return {list, lookup};
+ return list;
}
function expandFilePaths(filePaths: string[] | string): string[] {