screw-up 0.6.1 → 0.8.1

package/README.md

@@ -48,6 +48,7 @@ To insert banner header each bundled source files (`dist/index.js` and etc.):
 * Flexible output: Specify exactly which keys to include and in what order.
 * Nested object support: Handles nested objects like `author.name`, `repository.url`.
 * Customizable: Choose which metadata fields to include in your banner.
+* TypeScript metadata generation: Automatically generates TypeScript files with metadata constants for use in your source code.
 
 ## Installation
 
@@ -155,6 +156,66 @@ Results in:
  */
 ```
 
+### TypeScript Metadata Generation
+
+The plugin can generate TypeScript files containing metadata constants that you can import and use in your source code:
+
+```typescript
+import { defineConfig } from 'vite';
+import screwUp from 'screw-up';
+
+export default defineConfig({
+  plugins: [
+    screwUp({
+      outputMetadataFile: true, // Enable metadata file generation
+      outputMetadataFilePath: 'src/generated/packageMetadata.ts', // Custom path (optional)
+      outputMetadataKeys: ['name', 'version', 'description', 'author', 'license'] // Keys to include
+    })
+  ],
+  build: {
+    lib: {
+      entry: 'src/index.ts',
+      name: 'MyLibrary',
+      fileName: 'index'
+    }
+  }
+});
+```
+
+This generates `src/generated/packageMetadata.ts` with sanitized TypeScript constants:
+
+```typescript
+// This file is auto-generated by screw-up plugin
+// Do not edit manually
+
+export const name = "my-awesome-library";
+export const version = "2.1.0";
+export const description = "An awesome TypeScript library";
+export const author = "Jane Developer <jane@example.com>";
+export const license = "Apache-2.0";
+```
+
+You can then import and use these constants in your source code:
+
+```typescript
+import { name, version } from './generated/packageMetadata.js';
+
+console.log(`${name} v${version}`);
+// Output: my-awesome-library v2.1.0
+
+export function getLibraryInfo() {
+  return { name, version };
+}
+```
+
+#### Key Sanitization
+
+Keys with special characters are automatically sanitized to valid TypeScript identifiers:
+
+- `repository.url` → `repository_url`
+- `custom-key` → `custom_key`
+- `123invalid` → `_123invalid`
+
 ----
 
 ## Advanced Usage
@@ -236,4 +297,4 @@ The plugin automatically detects and supports:
 
 ## License
 
-Under MIT
+Under MIT

package/dist/index.cjs

@@ -2,7 +2,7 @@
 const promises = require("fs/promises");
 const path = require("path");
 const fs = require("fs");
-const flattenObject = (obj, prefix = "", map) => {
+const flattenObject = (obj, prefix, map) => {
   for (const [key, value] of Object.entries(obj)) {
     if (!value)
       continue;
@@ -47,7 +47,7 @@ const findWorkspaceRoot = async (startPath) => {
     }
     currentPath = path.dirname(currentPath);
   }
-  return null;
+  return void 0;
 };
 const mergePackageMetadata = (parentMetadata, childMetadata) => {
   const merged = {};
@@ -92,28 +92,73 @@ const generateBanner = (metadata, outputKeys) => {
  * ${parts.join("\n * ")}
  */` : "";
 };
+const insertBannerHeader = (content, banner) => {
+  const lines = content.split("\n");
+  if (lines.length > 0 && lines[0].startsWith("#!")) {
+    return lines[0] + "\n" + banner + "\n" + lines.slice(1).join("\n");
+  } else {
+    return banner + "\n" + content;
+  }
+};
+const sanitizeKey = (key) => {
+  return key.replace(/[^a-zA-Z0-9_]/g, "_").replace(/^(\d)/, "_$1");
+};
+const generateMetadataFile = (metadata, outputKeys) => {
+  const lines = [];
+  lines.push("// This file is auto-generated by screw-up plugin");
+  lines.push("// Do not edit manually");
+  lines.push("");
+  for (const key of outputKeys) {
+    const value = metadata[key];
+    if (value) {
+      const sanitizedKey = sanitizeKey(key);
+      const escapedValue = JSON.stringify(value);
+      lines.push(`export const ${sanitizedKey} = ${escapedValue};`);
+    }
+  }
+  lines.push("");
+  return lines.join("\n");
+};
 const screwUp = (options = {}) => {
   const {
     outputKeys = ["name", "version", "description", "author", "license", "repository.url"],
-    assetFilters = ["\\.d\\.ts$"]
+    assetFilters = ["\\.d\\.ts$"],
+    outputMetadataFile = false,
+    outputMetadataFilePath = "src/generated/packageMetadata.ts",
+    outputMetadataKeys = ["name", "version", "description", "author", "license", "repository.url"]
   } = options;
   const assetFiltersRegex = assetFilters.map((filter) => new RegExp(filter));
   let banner;
+  let metadata;
+  let projectRoot;
   return {
     name: "screw-up",
     apply: "build",
     async configResolved(config) {
-      const metadata = await resolvePackageMetadata(config.root);
+      projectRoot = config.root;
+      metadata = await resolvePackageMetadata(config.root);
       banner = generateBanner(metadata, outputKeys);
     },
+    async buildStart() {
+      if (outputMetadataFile) {
+        const metadataContent = generateMetadataFile(metadata, outputMetadataKeys);
+        const metadataPath = path.join(projectRoot, outputMetadataFilePath);
+        try {
+          await promises.mkdir(path.dirname(metadataPath), { recursive: true });
+          await promises.writeFile(metadataPath, metadataContent);
+        } catch (error) {
+          console.warn(`Failed to write metadata file to ${metadataPath}:`, error);
+        }
+      }
+    },
     generateBundle(_options, bundle) {
       for (const fileName in bundle) {
         const chunk = bundle[fileName];
         if (chunk.type === "chunk") {
-          chunk.code = banner + "\n" + chunk.code;
+          chunk.code = insertBannerHeader(chunk.code, banner);
         } else if (chunk.type === "asset" && assetFiltersRegex.some((filter) => filter.test(fileName))) {
           if (typeof chunk.source === "string") {
-            chunk.source = banner + "\n\n" + chunk.source;
+            chunk.source = insertBannerHeader(chunk.source, banner + "\n");
           }
         }
       }
@@ -128,7 +173,7 @@ const screwUp = (options = {}) => {
             try {
               const content = await promises.readFile(filePath, "utf-8");
               if (!content.includes(banner)) {
-                await promises.writeFile(filePath, banner + "\n\n" + content);
+                await promises.writeFile(filePath, insertBannerHeader(content, banner + "\n"));
               }
             } catch (error) {
             }

package/dist/index.d.ts

@@ -14,6 +14,21 @@ export interface ScrewUpOptions {
      * @default ['\.d\.ts$']
      */
     assetFilters?: string[];
+    /**
+     * Enable TypeScript metadata file generation
+     * @default false
+     */
+    outputMetadataFile?: boolean;
+    /**
+     * Output path for TypeScript metadata file
+     * @default 'src/generated/packageMetadata.ts'
+     */
+    outputMetadataFilePath?: string;
+    /**
+     * Array of keys to output in metadata file in the specified order
+     * @default ['name', 'version', 'description', 'author', 'license', 'repository.url']
+     */
+    outputMetadataKeys?: string[];
 }
 /**
  * Vite plugin that adds banner to the bundled code

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;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"}
+{"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;IACxB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED;;;;GAIG;AACH,QAAA,MAAM,OAAO,GAAI,UAAS,cAAmB,KAAG,MAiF/C,CAAC;AAEF,eAAe,OAAO,CAAC"}

package/dist/index.js

@@ -1,7 +1,7 @@
-import { readFile, readdir, writeFile } from "fs/promises";
+import { readFile, readdir, writeFile, mkdir } from "fs/promises";
 import { join, dirname } from "path";
 import { existsSync } from "fs";
-const flattenObject = (obj, prefix = "", map) => {
+const flattenObject = (obj, prefix, map) => {
   for (const [key, value] of Object.entries(obj)) {
     if (!value)
       continue;
@@ -46,7 +46,7 @@ const findWorkspaceRoot = async (startPath) => {
     }
     currentPath = dirname(currentPath);
   }
-  return null;
+  return void 0;
 };
 const mergePackageMetadata = (parentMetadata, childMetadata) => {
   const merged = {};
@@ -91,28 +91,73 @@ const generateBanner = (metadata, outputKeys) => {
  * ${parts.join("\n * ")}
  */` : "";
 };
+const insertBannerHeader = (content, banner) => {
+  const lines = content.split("\n");
+  if (lines.length > 0 && lines[0].startsWith("#!")) {
+    return lines[0] + "\n" + banner + "\n" + lines.slice(1).join("\n");
+  } else {
+    return banner + "\n" + content;
+  }
+};
+const sanitizeKey = (key) => {
+  return key.replace(/[^a-zA-Z0-9_]/g, "_").replace(/^(\d)/, "_$1");
+};
+const generateMetadataFile = (metadata, outputKeys) => {
+  const lines = [];
+  lines.push("// This file is auto-generated by screw-up plugin");
+  lines.push("// Do not edit manually");
+  lines.push("");
+  for (const key of outputKeys) {
+    const value = metadata[key];
+    if (value) {
+      const sanitizedKey = sanitizeKey(key);
+      const escapedValue = JSON.stringify(value);
+      lines.push(`export const ${sanitizedKey} = ${escapedValue};`);
+    }
+  }
+  lines.push("");
+  return lines.join("\n");
+};
 const screwUp = (options = {}) => {
   const {
     outputKeys = ["name", "version", "description", "author", "license", "repository.url"],
-    assetFilters = ["\\.d\\.ts$"]
+    assetFilters = ["\\.d\\.ts$"],
+    outputMetadataFile = false,
+    outputMetadataFilePath = "src/generated/packageMetadata.ts",
+    outputMetadataKeys = ["name", "version", "description", "author", "license", "repository.url"]
   } = options;
   const assetFiltersRegex = assetFilters.map((filter) => new RegExp(filter));
   let banner;
+  let metadata;
+  let projectRoot;
   return {
     name: "screw-up",
     apply: "build",
     async configResolved(config) {
-      const metadata = await resolvePackageMetadata(config.root);
+      projectRoot = config.root;
+      metadata = await resolvePackageMetadata(config.root);
       banner = generateBanner(metadata, outputKeys);
     },
+    async buildStart() {
+      if (outputMetadataFile) {
+        const metadataContent = generateMetadataFile(metadata, outputMetadataKeys);
+        const metadataPath = join(projectRoot, outputMetadataFilePath);
+        try {
+          await mkdir(dirname(metadataPath), { recursive: true });
+          await writeFile(metadataPath, metadataContent);
+        } catch (error) {
+          console.warn(`Failed to write metadata file to ${metadataPath}:`, error);
+        }
+      }
+    },
     generateBundle(_options, bundle) {
       for (const fileName in bundle) {
         const chunk = bundle[fileName];
         if (chunk.type === "chunk") {
-          chunk.code = banner + "\n" + chunk.code;
+          chunk.code = insertBannerHeader(chunk.code, banner);
         } else if (chunk.type === "asset" && assetFiltersRegex.some((filter) => filter.test(fileName))) {
           if (typeof chunk.source === "string") {
-            chunk.source = banner + "\n\n" + chunk.source;
+            chunk.source = insertBannerHeader(chunk.source, banner + "\n");
           }
         }
       }
@@ -127,7 +172,7 @@ const screwUp = (options = {}) => {
             try {
               const content = await readFile(filePath, "utf-8");
               if (!content.includes(banner)) {
-                await writeFile(filePath, banner + "\n\n" + content);
+                await writeFile(filePath, insertBannerHeader(content, banner + "\n"));
               }
             } catch (error) {
             }

package/dist/internal.d.ts

@@ -8,9 +8,9 @@ export declare const readPackageMetadata: (packagePath: string) => Promise<Packa
 /**
  * Find workspace root by looking for workspace configuration files
  * @param startPath - Starting directory path
- * @returns Promise resolving to workspace root path or null if not found
+ * @returns Promise resolving to workspace root path or undefined if not found
  */
-export declare const findWorkspaceRoot: (startPath: string) => Promise<string | null>;
+export declare const findWorkspaceRoot: (startPath: string) => Promise<string | undefined>;
 /**
  * Merge package metadata with inheritance (child overrides parent)
  * @param parentMetadata - Parent package metadata
@@ -31,4 +31,18 @@ export declare const resolvePackageMetadata: (projectRoot: string) => Promise<Pa
  * @returns Banner string
  */
 export declare const generateBanner: (metadata: PackageMetadata, outputKeys: string[]) => string;
+/**
+ * Insert banner header at appropriate position considering shebang
+ * @param content - The content to insert banner into
+ * @param banner - The banner header to insert
+ * @returns Content with banner header inserted
+ */
+export declare const insertBannerHeader: (content: string, banner: string) => string;
+/**
+ * Generate TypeScript metadata file content from package metadata
+ * @param metadata - Package metadata
+ * @param outputKeys - Array of keys to output
+ * @returns TypeScript file content
+ */
+export declare const generateMetadataFile: (metadata: PackageMetadata, outputKeys: string[]) => string;
 //# sourceMappingURL=internal.d.ts.map

package/dist/internal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":"AASA,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AA2BrD;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAU,aAAa,MAAM,KAAG,OAAO,CAAC,eAAe,CAWtF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAU,WAAW,MAAM,KAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CA0BhF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAC/B,gBAAgB,eAAe,EAC/B,eAAe,eAAe,KAC7B,eAoBF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GAAU,aAAa,MAAM,KAAG,OAAO,CAAC,eAAe,CAsBzF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,UAAU,eAAe,EAAE,YAAY,MAAM,EAAE,KAAG,MAWhF,CAAC"}
+{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":"AASA,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AA2BrD;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAU,aAAa,MAAM,KAAG,OAAO,CAAC,eAAe,CAWtF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAU,WAAW,MAAM,KAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CA0BrF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAC/B,gBAAgB,eAAe,EAC/B,eAAe,eAAe,KAC7B,eAoBF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GAAU,aAAa,MAAM,KAAG,OAAO,CAAC,eAAe,CAsBzF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,UAAU,eAAe,EAAE,YAAY,MAAM,EAAE,KAAG,MAWhF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,SAAS,MAAM,EAAE,QAAQ,MAAM,KAAG,MAWpE,CAAC;AAYF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAAI,UAAU,eAAe,EAAE,YAAY,MAAM,EAAE,KAAG,MAmBtF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screw-up",
-  "version": "0.6.1",
+  "version": "0.8.1",
   "description": "Simply package metadata inserter on Vite plugin",
   "keywords": [
     "vite",