From a57b4e43332a73a042239ed16f61474288e63b34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcus=20P=C3=B6hls?= Date: Sat, 4 May 2024 05:19:06 +0200 Subject: [PATCH] minor refactorings and file renaming --- packages/vite/src/backend/vite.ts | 2 +- packages/vite/src/index.ts | 6 +++--- .../src/plugin/{hotfile.ts => vite-hotfile.ts} | 2 +- .../plugin/{types.ts => vite-plugin-types.ts} | 7 +++++++ .../src/plugin/{plugin.ts => vite-plugin.ts} | 16 ++++++++++------ 5 files changed, 22 insertions(+), 11 deletions(-) rename packages/vite/src/plugin/{hotfile.ts => vite-hotfile.ts} (95%) rename packages/vite/src/plugin/{types.ts => vite-plugin-types.ts} (83%) rename packages/vite/src/plugin/{plugin.ts => vite-plugin.ts} (94%) diff --git a/packages/vite/src/backend/vite.ts b/packages/vite/src/backend/vite.ts index 89bd3931..0d5e32fc 100644 --- a/packages/vite/src/backend/vite.ts +++ b/packages/vite/src/backend/vite.ts @@ -5,7 +5,7 @@ import { Arr } from '@supercharge/arrays' import { ViteConfig } from './vite-config.js' import { ViteManifest } from './vite-manifest.js' import { HtmlString } from '@supercharge/support' -import { HotReloadFileContent } from '../plugin/types.js' +import { HotReloadFileContent } from '../plugin/vite-plugin-types.js' export type ViteTagAttributes = Record diff --git a/packages/vite/src/index.ts b/packages/vite/src/index.ts index 8cec626b..ce90cfd1 100644 --- a/packages/vite/src/index.ts +++ b/packages/vite/src/index.ts @@ -1,5 +1,5 @@ -import { supercharge } from './plugin/plugin.js' +import { supercharge } from './plugin/vite-plugin.js' export default supercharge export { supercharge } @@ -11,5 +11,5 @@ export { ViteServiceProvider } from './vite-service-provider.js' export { resolvePageComponent } from './inertia/inertia-helpers.js' export { InertiaPageNotFoundError } from './inertia/inertia-page-not-found-error.js' -export { HotReloadFile } from './plugin/hotfile.js' -export { PluginConfigContract, DevServerUrl } from './plugin/types.js' +export { HotReloadFile } from './plugin/vite-hotfile.js' +export { PluginConfigContract, DevServerUrl } from './plugin/vite-plugin-types.js' diff --git a/packages/vite/src/plugin/hotfile.ts b/packages/vite/src/plugin/vite-hotfile.ts similarity index 95% rename from packages/vite/src/plugin/hotfile.ts rename to packages/vite/src/plugin/vite-hotfile.ts index fdff7e8f..3a985864 100644 --- a/packages/vite/src/plugin/hotfile.ts +++ b/packages/vite/src/plugin/vite-hotfile.ts @@ -1,7 +1,7 @@ import Fs from 'node:fs' import Path from 'node:path' -import { HotReloadFileContent } from './types.js' +import { HotReloadFileContent } from './vite-plugin-types.js' export class HotReloadFile { /** diff --git a/packages/vite/src/plugin/types.ts b/packages/vite/src/plugin/vite-plugin-types.ts similarity index 83% rename from packages/vite/src/plugin/types.ts rename to packages/vite/src/plugin/vite-plugin-types.ts index 73ec4350..7d26106e 100644 --- a/packages/vite/src/plugin/types.ts +++ b/packages/vite/src/plugin/vite-plugin-types.ts @@ -8,9 +8,16 @@ export type DevServerUrl = `${'http' | 'https'}://${string}:${number}` export interface PluginConfigContract { /** * The path or paths to the entrypoints to compile with Vite. + * + * @deprecated use the {@link entrypoints} property */ input: string | string[] + /** + * The path or paths to the entrypoints to compile with Vite. + */ + entrypoints: string | string[] + /** * The "public" directory name. * diff --git a/packages/vite/src/plugin/plugin.ts b/packages/vite/src/plugin/vite-plugin.ts similarity index 94% rename from packages/vite/src/plugin/plugin.ts rename to packages/vite/src/plugin/vite-plugin.ts index efaca4dc..42ef322c 100644 --- a/packages/vite/src/plugin/plugin.ts +++ b/packages/vite/src/plugin/vite-plugin.ts @@ -2,8 +2,8 @@ import Path from 'node:path' import { AddressInfo } from 'node:net' import { Str } from '@supercharge/strings' -import { HotReloadFile } from './hotfile.js' -import { DevServerUrl, PluginConfigContract } from './types.js' +import { HotReloadFile } from './vite-hotfile.js' +import { DevServerUrl, PluginConfigContract } from './vite-plugin-types.js' import { ConfigEnv, Plugin, ResolvedConfig, UserConfig, ViteDevServer } from 'vite' /** @@ -20,7 +20,7 @@ export function supercharge (config: string | string[] | PluginConfigContract): */ function resolvePluginConfig (config: string | string[] | PluginConfigContract): Required { if (!config) { - throw new Error('supercharge-vite-plugin: missing inputs or configuration') + throw new Error('supercharge-vite-plugin: missing configuration object') } if (typeof config === 'string') { @@ -28,11 +28,15 @@ function resolvePluginConfig (config: string | string[] | PluginConfigContract): } if (Array.isArray(config)) { - config = { input: config } + config = { entrypoints: config } } - if (!config.input) { - throw new Error('supercharge-vite-plugin: missing "input" configuration') + if (!config.entrypoints && config.input) { + config.entrypoints = config.input + } + + if (!config.entrypoints) { + throw new Error('supercharge-vite-plugin: missing "entrypoints" configuration') } if (typeof config.publicDirectory === 'string') {