@artemsemkin/vite-plugin-wp-headers 1.0.0 → 2.0.0

package/README.md

@@ -1,6 +1,6 @@
 # @artemsemkin/vite-plugin-wp-headers
 
-Vite plugin that generates WordPress file headers from `package.json` data. Wraps [`@artemsemkin/wp-headers`](https://github.com/artkrsk/wp-headers).
+Vite plugin that calls a `generate` function on build start and watches specified files for changes during dev. Designed for WordPress header generation but works with any file-generation workflow.
 
 ## Install
 
@@ -8,24 +8,69 @@ Vite plugin that generates WordPress file headers from `package.json` data. Wrap
 npm install @artemsemkin/vite-plugin-wp-headers -D
 ```
 
+## Why
+
+WordPress themes and plugins need generated header comments in `style.css` and PHP files. These headers should regenerate on every build start and whenever source data (like `package.json`) changes during development. This plugin handles the Vite lifecycle timing — you provide the generation logic.
+
+## API
+
+```ts
+wpHeaders({
+  generate(): void    // called on build start + file changes during dev
+  watch?: string[]    // absolute paths to watch during dev server
+}): Plugin
+```
+
 ## Usage
 
+### With `@artemsemkin/wp-headers`
+
+```ts
+import { resolve } from 'node:path'
+import { processMapping } from '@artemsemkin/wp-headers'
+import { wpHeaders } from '@artemsemkin/vite-plugin-wp-headers'
+
+const mappings = [
+  {
+    type: 'theme',
+    slug: 'my-theme',
+    entityDir: resolve(__dirname, 'themes/my-theme'),
+  },
+]
+
+export default {
+  plugins: [
+    wpHeaders({
+      generate() {
+        for (const m of mappings) {
+          processMapping(m)
+        }
+      },
+      watch: mappings.map((m) => resolve(m.entityDir, 'package.json')),
+    }),
+  ],
+}
+```
+
+### Standalone
+
 ```ts
-// vite.config.ts
 import { wpHeaders } from '@artemsemkin/vite-plugin-wp-headers'
 
 export default {
   plugins: [
-    wpHeaders([
-      {
-        type: 'theme',
-        slug: 'my-theme',
-        entityDir: 'themes/my-theme',
-        tgmBasePath: 'themes/my-theme/src/php',
+    wpHeaders({
+      generate() {
+        // any file-generation logic
       },
-    ]),
+      watch: ['/absolute/path/to/source.json'],
+    }),
   ],
 }
 ```
 
-Runs on `configResolved` (build + dev) and watches `package.json` changes during dev.
+## Behavior
+
+- **Build**: `generate()` runs once during `configResolved`
+- **Dev server**: `generate()` runs on startup, then again whenever a watched file changes
+- Errors during dev are logged via Vite's logger (won't crash the server)

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import type { Plugin } from 'vite';
-import type { HeaderMapping } from '@artemsemkin/wp-headers';
-export type { HeaderMapping };
-/**
- * Vite plugin that generates WordPress file headers (style.css, plugin PHP)
- * and patches TGM version entries on build and during dev server.
- */
-export declare function wpHeaders(mappings: HeaderMapping[]): Plugin;
+export interface WpHeadersOptions {
+    /** Called on build start and when watched files change */
+    generate(): void;
+    /** Absolute paths to watch during dev */
+    watch?: string[];
+}
+export declare function wpHeaders(options: WpHeadersOptions): Plugin;

package/dist/index.js

@@ -1,33 +1,27 @@
-import { resolve } from 'node:path';
-import { processMapping } from '@artemsemkin/wp-headers';
-/**
- * Vite plugin that generates WordPress file headers (style.css, plugin PHP)
- * and patches TGM version entries on build and during dev server.
- */
-export function wpHeaders(mappings) {
+export function wpHeaders(options) {
     return {
         name: 'vite-plugin-wp-headers',
         configResolved() {
-            for (const mapping of mappings) {
-                processMapping(mapping);
-            }
+            options.generate();
         },
         configureServer(server) {
-            for (const mapping of mappings) {
-                const pkgPath = resolve(mapping.entityDir, 'package.json');
-                server.watcher.add(pkgPath);
-                server.watcher.on('change', (filePath) => {
-                    if (filePath !== pkgPath) {
-                        return;
-                    }
-                    try {
-                        processMapping(mapping);
-                    }
-                    catch (err) {
-                        server.config.logger.error(String(err));
-                    }
-                });
+            if (!options.watch?.length) {
+                return;
+            }
+            for (const filePath of options.watch) {
+                server.watcher.add(filePath);
             }
+            server.watcher.on('change', (changedPath) => {
+                if (!options.watch.includes(changedPath)) {
+                    return;
+                }
+                try {
+                    options.generate();
+                }
+                catch (err) {
+                    server.config.logger.error(String(err));
+                }
+            });
         },
     };
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@artemsemkin/vite-plugin-wp-headers",
-  "version": "1.0.0",
-  "description": "Vite plugin for WordPress file header generation",
+  "version": "2.0.0",
+  "description": "Vite plugin that calls a generate function on build start and watches files during dev",
   "license": "MIT",
   "author": "Artem Semkin",
   "repository": {
@@ -35,9 +35,6 @@
     "build": "tsc -p tsconfig.build.json",
     "prepublishOnly": "pnpm build"
   },
-  "dependencies": {
-    "@artemsemkin/wp-headers": "^1.1.0"
-  },
   "peerDependencies": {
     "vite": ">=5"
   },