screw-up 0.2.0 → 0.4.1

package/README.md

@@ -10,7 +10,7 @@ Simply package metadata inserter for Vite plugins.
 
 ## What is this?
 
-This is a Vite plugin that automatically inserts banner comments containing package metadata (name, version, description, author, license, etc.) into your bundled JavaScript/CSS files.
+This is a Vite plugin that automatically inserts banner comments containing package metadata (name, version, description, author, license, etc.) into your bundled files.
 
 This will automatically read metadata from your `package.json`:
 
@@ -65,7 +65,7 @@ Add the plugin to your `vite.config.ts`:
 
 ```typescript
 import { defineConfig } from 'vite';
-import { screwUp } from 'screw-up';
+import screwUp from 'screw-up';
 
 export default defineConfig({
   plugins: [
@@ -81,13 +81,16 @@ export default defineConfig({
 });
 ```
 
+When no `outputKeys` are specified, the plugin uses these default keys with exact sequence:
+`name`, `version`, `description`, `author`, `license` and `repository.url`.
+
 ### Custom Output Keys
 
 You can specify which metadata fields to include and in what order:
 
 ```typescript
 import { defineConfig } from 'vite';
-import { screwUp } from 'screw-up';
+import screwUp from 'screw-up';
 
 export default defineConfig({
   plugins: [
@@ -115,14 +118,6 @@ This will generate a banner with only the specified fields:
  */
 ```
 
-#### Default Output Keys
-
-When no `outputKeys` are specified, the plugin uses these default keys:
-
-```typescript
-['name', 'version', 'description', 'author', 'license', 'repository.url']
-```
-
 ### Working with Nested Objects
 
 The plugin automatically flattens nested objects using dot notation:

package/dist/index.cjs

@@ -1,8 +1,7 @@
 "use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const fs = require("fs");
 const promises = require("fs/promises");
 const path = require("path");
+const fs = require("fs");
 const flattenObject = (obj, prefix = "", map) => {
   for (const [key, value] of Object.entries(obj)) {
     if (!value)
@@ -94,7 +93,11 @@ const generateBanner = (metadata, outputKeys) => {
  */` : "";
 };
 const screwUp = (options = {}) => {
-  const { outputKeys = ["name", "version", "description", "author", "license", "repository.url"] } = options;
+  const {
+    outputKeys = ["name", "version", "description", "author", "license", "repository.url"],
+    assetFilters = ["\\.d\\.ts$"]
+  } = options;
+  const assetFiltersRegex = assetFilters.map((filter) => new RegExp(filter));
   let banner;
   return {
     name: "screw-up",
@@ -108,9 +111,32 @@ const screwUp = (options = {}) => {
         const chunk = bundle[fileName];
         if (chunk.type === "chunk") {
           chunk.code = banner + "\n" + chunk.code;
+        } else if (chunk.type === "asset" && assetFiltersRegex.some((filter) => filter.test(fileName))) {
+          if (typeof chunk.source === "string") {
+            chunk.source = banner + "\n\n" + chunk.source;
+          }
         }
       }
+    },
+    async writeBundle(options2) {
+      if (!options2.dir) return;
+      try {
+        const files = await promises.readdir(options2.dir, { recursive: true });
+        for (const file of files) {
+          const filePath = path.join(options2.dir, file);
+          if (assetFiltersRegex.some((filter) => filter.test(file))) {
+            try {
+              const content = await promises.readFile(filePath, "utf-8");
+              if (!content.includes(banner)) {
+                await promises.writeFile(filePath, banner + "\n\n" + content);
+              }
+            } catch (error) {
+            }
+          }
+        }
+      } catch (error) {
+      }
     }
   };
 };
-exports.screwUp = screwUp;
+module.exports = screwUp;

package/dist/index.d.ts

@@ -1,16 +1,25 @@
 import { Plugin } from 'vite';
 
+/**
+ * screw-up options
+ */
 export interface ScrewUpOptions {
     /**
      * Array of keys to output in banner in the specified order
      * @default ['name', 'version', 'description', 'author', 'license', 'repository.url']
      */
     outputKeys?: string[];
+    /**
+     * Array of asset file regex to add banner to
+     * @default ['\.d\.ts$']
+     */
+    assetFilters?: string[];
 }
 /**
  * Vite plugin that adds banner to the bundled code
  * @param options - Plugin options
  * @returns Vite plugin
  */
-export declare const screwUp: (options?: ScrewUpOptions) => Plugin;
+declare const screwUp: (options?: ScrewUpOptions) => Plugin;
+export default screwUp;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAGnC,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAED;;;;GAIG;AACH,eAAO,MAAM,OAAO,GAAI,UAAS,cAAmB,KAAG,MAqBtD,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAKnC;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;;;GAIG;AACH,QAAA,MAAM,OAAO,GAAI,UAAS,cAAmB,KAAG,MA2D/C,CAAC;AAEF,eAAe,OAAO,CAAC"}

package/dist/index.js

@@ -1,6 +1,6 @@
-import { existsSync } from "fs";
-import { readFile } from "fs/promises";
+import { readFile, readdir, writeFile } from "fs/promises";
 import { join, dirname } from "path";
+import { existsSync } from "fs";
 const flattenObject = (obj, prefix = "", map) => {
   for (const [key, value] of Object.entries(obj)) {
     if (!value)
@@ -92,7 +92,11 @@ const generateBanner = (metadata, outputKeys) => {
  */` : "";
 };
 const screwUp = (options = {}) => {
-  const { outputKeys = ["name", "version", "description", "author", "license", "repository.url"] } = options;
+  const {
+    outputKeys = ["name", "version", "description", "author", "license", "repository.url"],
+    assetFilters = ["\\.d\\.ts$"]
+  } = options;
+  const assetFiltersRegex = assetFilters.map((filter) => new RegExp(filter));
   let banner;
   return {
     name: "screw-up",
@@ -106,11 +110,34 @@ const screwUp = (options = {}) => {
         const chunk = bundle[fileName];
         if (chunk.type === "chunk") {
           chunk.code = banner + "\n" + chunk.code;
+        } else if (chunk.type === "asset" && assetFiltersRegex.some((filter) => filter.test(fileName))) {
+          if (typeof chunk.source === "string") {
+            chunk.source = banner + "\n\n" + chunk.source;
+          }
         }
       }
+    },
+    async writeBundle(options2) {
+      if (!options2.dir) return;
+      try {
+        const files = await readdir(options2.dir, { recursive: true });
+        for (const file of files) {
+          const filePath = join(options2.dir, file);
+          if (assetFiltersRegex.some((filter) => filter.test(file))) {
+            try {
+              const content = await readFile(filePath, "utf-8");
+              if (!content.includes(banner)) {
+                await writeFile(filePath, banner + "\n\n" + content);
+              }
+            } catch (error) {
+            }
+          }
+        }
+      } catch (error) {
+      }
     }
   };
 };
 export {
-  screwUp
+  screwUp as default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screw-up",
-  "version": "0.2.0",
+  "version": "0.4.1",
   "description": "Simply package metadata inserter on Vite plugin",
   "keywords": [
     "vite",
@@ -35,12 +35,11 @@
     "test": "rv --npm . && tsc --noEmit && vitest run"
   },
   "dependencies": {
-    "glob": "^11.0.3"
+    "vite": "^5.0.0"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",
     "typescript": "^5.0.0",
-    "vite": "^5.0.0",
     "vite-plugin-dts": "^3.0.0",
     "vitest": "^1.0.0"
   }