@studiocms/devapps

v0.1.0-beta.31 GitHub npm Registro de cambios

Introducción

Una colección de herramientas útiles disponibles durante el modo de desarrollo en Astro.

Instalación

Método Astro
Método Manual

Instala el paquete y añádelo a tu configuración de astro usando el siguiente comando:
- npm
- pnpm
- yarn
Ventana de terminal
npx astro add @studiocms/devapps
Ventana de terminal
pnpm astro add @studiocms/devapps
Ventana de terminal
yarn astro add @studiocms/devapps
Actualiza tu archivo de configuración como se muestra en Configuración de Ejemplo a continuación.

Instala el paquete usando el siguiente comando:
- npm
- pnpm
- yarn
Ventana de terminal
npm i @studiocms/devapps
Ventana de terminal
pnpm add @studiocms/devapps
Ventana de terminal
yarn add @studiocms/devapps

Añade @studiocms/devapps a tu archivo de configuración de astro:

import { 
function defineConfig<const TLocales extends Locales = never, const TDriver extends SessionDriverName = never, const TFontFamilies extends FontFamily[] = never>(config: AstroUserConfig<TLocales, TDriver, TFontFamilies>): AstroUserConfig<TLocales, TDriver, TFontFamilies>
See the full Astro Configuration API Documentation
https://astro.build/config
defineConfig } from 'astro/config';
import 
function db(options?: AstroDBConfig): AstroIntegration[]
db from '@astrojs/db';
import 
function devApps(opts?: StudioCMSDevAppsOptions): AstroIntegration
Integrates StudioCMS development applications with Astro.
@param ― opts - Optional configuration options for StudioCMS DevApps.
@returns ― The Astro integration object for StudioCMS DevApps.
@example 
import { studioCMSDevApps } from '@studiocms/devapps';

export default {
  integrations: [
    studioCMSDevApps({
      endpoint: '/api',
      appsConfig: {
        wpImporter: {
          enabled: true,
          endpoint: '/wp-import',
        },
      },
      verbose: true,
    }),
  ],
};
devApps from '@studiocms/devapps';

export default 
defineConfig<never, never, never>(config: AstroUserConfig<never, never, never>): AstroUserConfig<never, never, never>
See the full Astro Configuration API Documentation
https://astro.build/config
defineConfig({
   
AstroUserConfig<TLocales extends Locales = never, TSession extends SessionDriverName = never, TFontFamilies extends FontFamily[] = never>.site?: string@name ― site
@type ― {string}
@description 
Your final, deployed URL. Astro uses this full URL to generate your sitemap and canonical URLs in your final build. It is strongly recommended that you set this configuration to get the most out of Astro.
{
  site: 'https://www.my-site.dev'
}
site: "https://example.com",
   
AstroUserConfig<TLocales extends Locales = never, TSession extends SessionDriverName = never, TFontFamilies extends FontFamily[] = never>.integrations?: (false | AstroIntegration | (false | AstroIntegration | null | undefined)[] | null | undefined)[]@name ― integrations
@description 
Extend Astro with custom integrations. Integrations are your one-stop-shop for adding framework support (like Solid.js), new features (like sitemaps), and new libraries (like Partytown).
Read our Integrations Guide for help getting started with Astro Integrations.
import react from '@astrojs/react';
import mdx from '@astrojs/mdx';
{
  // Example: Add React + MDX support to Astro
  integrations: [react(), mdx()]
}
integrations: [
       
function db(options?: AstroDBConfig): AstroIntegration[]
db(),
       
function devApps(opts?: StudioCMSDevAppsOptions): AstroIntegration
Integrates StudioCMS development applications with Astro.
@param ― opts - Optional configuration options for StudioCMS DevApps.
@returns ― The Astro integration object for StudioCMS DevApps.
@example 
import { studioCMSDevApps } from '@studiocms/devapps';

export default {
  integrations: [
    studioCMSDevApps({
      endpoint: '/api',
      appsConfig: {
        wpImporter: {
          enabled: true,
          endpoint: '/wp-import',
        },
      },
      verbose: true,
    }),
  ],
};
devApps(),
   ],
});

Uso

¡Todas las herramientas solo estarán disponibles durante astro dev y no estarán disponibles durante los despliegues de producción!

Configuración de ejemplo

import { 
function defineConfig<const TLocales extends Locales = never, const TDriver extends SessionDriverName = never, const TFontFamilies extends FontFamily[] = never>(config: AstroUserConfig<TLocales, TDriver, TFontFamilies>): AstroUserConfig<TLocales, TDriver, TFontFamilies>
See the full Astro Configuration API Documentation
https://astro.build/config
defineConfig } from 'astro/config';
import 
function db(options?: AstroDBConfig): AstroIntegration[]
db from '@astrojs/db';
import 
function devApps(opts?: StudioCMSDevAppsOptions): AstroIntegration
Integrates StudioCMS development applications with Astro.
@param ― opts - Optional configuration options for StudioCMS DevApps.
@returns ― The Astro integration object for StudioCMS DevApps.
@example 
import { studioCMSDevApps } from '@studiocms/devapps';

export default {
  integrations: [
    studioCMSDevApps({
      endpoint: '/api',
      appsConfig: {
        wpImporter: {
          enabled: true,
          endpoint: '/wp-import',
        },
      },
      verbose: true,
    }),
  ],
};
devApps from '@studiocms/devapps';

export default 
defineConfig<never, never, never>(config: AstroUserConfig<never, never, never>): AstroUserConfig<never, never, never>
See the full Astro Configuration API Documentation
https://astro.build/config
defineConfig({
  
AstroUserConfig<TLocales extends Locales = never, TSession extends SessionDriverName = never, TFontFamilies extends FontFamily[] = never>.site?: string@name ― site
@type ― {string}
@description 
Your final, deployed URL. Astro uses this full URL to generate your sitemap and canonical URLs in your final build. It is strongly recommended that you set this configuration to get the most out of Astro.
{
  site: 'https://www.my-site.dev'
}
site: "https://example.com",
  
AstroUserConfig<TLocales extends Locales = never, TSession extends SessionDriverName = never, TFontFamilies extends FontFamily[] = never>.integrations?: (false | AstroIntegration | (false | AstroIntegration | null | undefined)[] | null | undefined)[]@name ― integrations
@description 
Extend Astro with custom integrations. Integrations are your one-stop-shop for adding framework support (like Solid.js), new features (like sitemaps), and new libraries (like Partytown).
Read our Integrations Guide for help getting started with Astro Integrations.
import react from '@astrojs/react';
import mdx from '@astrojs/mdx';
{
  // Example: Add React + MDX support to Astro
  integrations: [react(), mdx()]
}
integrations: [
    
function db(options?: AstroDBConfig): AstroIntegration[]
db(), // REQUERIDO
    
function devApps(opts?: StudioCMSDevAppsOptions): AstroIntegration
Integrates StudioCMS development applications with Astro.
@param ― opts - Optional configuration options for StudioCMS DevApps.
@returns ― The Astro integration object for StudioCMS DevApps.
@example 
import { studioCMSDevApps } from '@studiocms/devapps';

export default {
  integrations: [
    studioCMSDevApps({
      endpoint: '/api',
      appsConfig: {
        wpImporter: {
          enabled: true,
          endpoint: '/wp-import',
        },
      },
      verbose: true,
    }),
  ],
};
devApps(/* Ver Opciones de Configuración Abajo */),
  ],
});

Opciones de Configuración

Lista completa de opciones disponibles para la integración devApps, con valores predeterminados mostrados. Todas las opciones son opcionales.


endpoint?: string | undefined
endpoint: '_studiocms-devapps',
verbose?: boolean | undefined
verbose: false,
appsConfig?: {
    wpImporter: boolean | {
        endpoint?: string | undefined;
    };
} | undefined
appsConfig: {
  libSQLViewer: true,Error ts(2353)  ― Object literal may only specify known properties, and 'libSQLViewer' does not exist in type '{ wpImporter: boolean | { endpoint?: string | undefined; }; }'.
  
wpImporter: boolean | {
    endpoint?: string | undefined;
}
wpImporter: true,
},

Herramientas

Visor de libSQL

Herramienta de desarrollo para ver las tablas SQL en la base de datos libSQL en el navegador. La herramienta depende de las credenciales de conexión de la base de datos remota libSQL de @astrojs/db.

Requisitos

Las siguientes variables de entorno configuradas (También usadas para @astrojs/db):

ASTRO_DB_REMOTE_URL
ASTRO_DB_APP_TOKEN

Vista previa de uso

Aplicación de barra de herramientas (Cerrada)

Aplicación de barra de herramientas de Astro

Aplicación de barra de herramientas (Expandida)

Aplicación de barra de herramientas de Astro (Expandida)

Importador de WordPress

Herramienta de desarrollo para importar publicaciones y páginas de WordPress a la base de datos de StudioCMS.

Requisitos

Integración StudioCMS
Instalación de WordPress
@studiocms/blog (Opcional: para importar Publicaciones bajo un blog)

Vista previa de uso

Aplicación de barra de herramientas

Aplicación de barra de herramientas de Astro