Skip to content

Pengembangan Plugin ​

Plugin mineproj memperluas pipeline build dengan hooks dan komponen.

Kontrak Plugin ​

Plugin adalah objek dengan:

PropertiTipeWajibDeskripsi
namestring✅Nama plugin unik
hooksRecord<string, Function>OpsionalHandler hook siklus hidup
viteVitePlugin[]OpsionalPlugin Vite untuk disuntikkan
componentsRecord<string, Component>OpsionalKomponen untuk didaftarkan
optionsSchemaZodSchemaOpsionalSkema untuk opsi plugin
setupFunctionOpsionalHook waktu instalasi

Contoh ​

ts
import { definePlugin } from '@mineproj/core';

export default definePlugin({
  name: 'mineproj-plugin-hello',
  hooks: {
    'build:done': () => {
      console.log('Build selesai!');
    },
  },
});

Hook Siklus Hidup ​

HookTipeSignatureDipanggil Ketika
config:resolvedwaterfall(config, ctx) => configSetelah konfigurasi dimuat
data:loadedseq(_, ctx) => voidSetelah dataset dimuat
data:validatedseq(_, ctx) => voidSetelah validasi data
routes:collectwaterfall(routes, ctx) => routesSetelah rute dikumpulkan
api:endpointswaterfall(endpoints, ctx) => endpointsSebelum emisi API
render:beforewaterfall(html, ctx) => htmlSebelum setiap render halaman
emitseq(_, ctx) => voidSetelah semua file ditulis
build:doneseq(_, ctx) => voidSetelah build selesai

Plugin dengan Opsi ​

ts
import { z } from 'zod';
import { definePlugin } from '@mineproj/core';

export default definePlugin({
  name: '@mineproj/plugin-analytics',
  optionsSchema: z.object({
    provider: z.enum(['umami', 'plausible', 'ga']),
    id: z.string(),
  }),
  hooks: {
    'render:before': (html, ctx) => {
      // Menyuntikkan cuplikan analytics sebelum </head>
      return html.replace('</head>', `${snippet}\n</head>`);
    },
  },
});

Menggunakan Plugin ​

ts
// mineproj.config.ts
import { defineSeoPlugin } from '@mineproj/plugin-seo';

export default defineConfig({
  plugins: [
    defineSeoPlugin({ siteUrl: 'https://example.com', siteTitle: 'My Site' }),
  ],
});

Pengujian Kontrak ​

ts
import { runPluginContract } from '@mineproj/test-utils';
const result = runPluginContract(myPlugin);
console.log(result.errors); // [] jika valid

Publikasi ​

  1. Beri nama paket Anda mineproj-plugin-* atau @mineproj/plugin-*
  2. Tambahkan "keywords": ["mineproj-plugin"] ke package.json
  3. Jalankan runPluginContract untuk memvalidasi
  4. Publikasikan ke npm

Released under the Apache-2.0 License.