unplugin svelte components

Componentes de Unplugin-Silte

Componentes sob demanda Importação automática para esbelto.

Demo Sveltekit Demo Sove Vite Demo

Características

• ⚡️ Suporta Vite, Webpack, Rollup, Esbuild e muito mais, alimentado por Unplugin.
• ? Shakable, apenas registra os componentes que você usa.
• ? Nomes de pastas como namespaces.
• ? Suporte completo de texto datilografado.
• ? Funciona perfeitamente com Unplugin-Auto-Import.

Instalação

pnpm add -D unplugin-svelte-components

Vite

 // vite.config.ts
import Components from 'unplugin-svelte-components/vite'

export default defineConfig ( {
  plugins : [
    Components ( { /* options */ } ) ,
  ] ,
} )

Rollup

 // rollup.config.js
import Components from 'unplugin-svelte-components/rollup'

export default {
  plugins : [
    Components ( { /* options */ } ) ,
  ] ,
}

Webpack

 // webpack.config.js
module . exports = {
  /* ... */
  plugins : [
    require ( 'unplugin-svelte-components/webpack' ) ( { /* options */ } ) ,
  ] ,
}

Esbuild

 // esbuild.config.js
import { build } from 'esbuild'

build ( {
  /* ... */
  plugins : [
    require ( 'unplugin-svelte-components/esbuild' ) ( {
      /* options */
    } ) ,
  ] ,
} )

Sveltekit

 // vite.config.ts
import Components from 'unplugin-svelte-components/vite'

export default defineConfig ( {
  plugins : [
    Components ( { /* options */ } ) , // before sveltekit plugin
    sveltekit ( ) ,
  ] ,
} ) 

Uso

Use componentes como você normalmente faria, ele importará componentes sob demanda e não há mais import necessária!

Ele vai girar automaticamente isso

 < HelloWorld msg =" Hello Svelte " />

nisso

 < HelloWorld msg =" Hello Svelte " />

< script >
import HelloWorld from './src/components/HelloWorld.svelte'
</ script > 

TypeScript

Para obter o suporte ao TypeScript para componentes autônomos, você pode alterar a configuração conforme seguinte para obter o suporte.

 Components ( {
  dts : true , // enabled by default if `typescript` is installed
} )

Depois que a configuração for concluída, um components.d.ts será gerado e atualiza automaticamente com as definições de tipo. Sinta -se à vontade para comprometê -lo no git ou não como você deseja.

Certifique -se de adicionar também components.d.ts ao seu tsconfig.json includes .

Componentes de terceiros registrados

É legal ter seus próprios componentes, mas às vezes você deseja importar componentes de terceiros.

Assim, unplugin-svelte-components forneceram uma maneira de importar esses componentes.

 Components ( {
  dts : true ,
  external : [
    {
      from : "agnostic-svelte" , // import from third party
      names : [ // import these components
        "Alert" ,
        "Button as AButton" , // import as `AButton`
      ] ,
      defaultImport : false , // telling `unplugin-svelte-components` to import any component as non-default export
    } ,
  ] ,
} )

Portanto, o Alert e AButton estarão disponíveis para uso.

Desativar

Em alguns casos, você pode desativar o Importação automático em sua página, unplugin-svelte-components fornece uma maneira de fazer isso apenas adicionando <!-- unplugin-svelte-components disabled --> em seu arquivo .svelte

 <!-- unplugin-svelte-components disabled -->
< HelloWorld msg =" Hello Svelte " /> 

Configuração

Os seguintes mostram os valores padrão da configuração

 Components ( {
  // relative paths to the directory to search for components.
  dirs : [ 'src/components' ] ,

  // valid file extensions for components.
  extensions : [ 'svelte' ] ,

// search for subdirectories
  deep : true ,

  // generate `components.d.ts` global declarations,
  // also accepts a path for custom filename
  // default: `true` if package typescript is installed
  dts : false ,

  // Allow subdirectories as namespace prefix for components.
  directoryAsNamespace : false ,
  // Subdirectory paths for ignoring namespace prefixes
  // works when `directoryAsNamespace: true`
  globalNamespaces : [ ] ,

  // Transform path before resolving
  importPathTransform : v => v ,

  // Allow for components to override other components with the same name
  allowOverrides : false ,

  // Accept a svelte pre-processor (e.g. svelte-preprocess)
  preprocess :  null ,

  // filters for transforming targets
  include : [ / .svelte$ / , / .svelte?svelte / ] ,
  exclude : [ / [\/]node_modules[\/] / , / [\/].git[\/] / , / [\/].svelte-kit[\/] / , ] ,

  // Generate corresponding .eslintrc-components.json file.
  // eslint globals Docs - https://eslint.org/docs/user-guide/configuring/language-options#specifying-globals
  eslintrc : {
    enabled : true , // Default `true`
    filepath : './.eslintrc-components.json' , // Default `./.eslintrc-components.json`
    globalsPropValue : true , // Default `true`, (true | false | 'readonly' | 'readable' | 'writable' | 'writeable')
  }

} ) 

Obrigado

Graças a Anthony Fu, este projeto é fortemente inspirado por componentes unplugin-vue.

Licença

MIT Licença © 2022-presente Mohamed Nesredin