screw-up 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Kouji Matsui (@kekyo@mi.kekyo.net)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,174 @@
+# Screw-UP
+
+Simply package metadata inserter for Vite plugins.
+
+[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![npm version](https://img.shields.io/npm/v/screw-up.svg)](https://www.npmjs.com/package/screw-up)
+
+----
+
+## What is this?
+
+This is a Vite plugin that automatically inserts banner comments containing package metadata (name, version, description, author, license) into your bundled JavaScript/CSS files.
+
+This will automatically read metadata from your `package.json`:
+
+```json
+{
+  "name": "my-awesome-library",
+  "version": "2.1.0",
+  "description": "An awesome TypeScript library",
+  "author": "Jane Developer <jane@example.com>",
+  "license": "Apache-2.0"
+}
+```
+
+To insert banner header each bundled source files (`dist/index.js` and etc.):
+
+```javascript
+/*!
+ * my-awesome-library 2.1.0
+ * An awesome TypeScript library
+ * Author: Jane Developer <jane@example.com>
+ * License: "Apache-2.0
+ */
+// Your bundled code here...
+```
+
+* Reads metadata from `package.json`.
+* Supports both ESM and CommonJS outputs.
+* Customizable banner templates.
+
+## Installation
+
+```bash
+npm install --save-dev screw-up
+```
+
+----
+
+## Usage
+
+### Basic Usage
+
+Add the plugin to your `vite.config.ts`:
+
+```typescript
+import { defineConfig } from 'vite';
+import { screwUp } from 'screw-up';   // Need to this
+
+export default defineConfig({
+  plugins: [
+    screwUp()   // Need to this
+  ],
+  build: {
+    lib: {
+      entry: 'src/index.ts',
+      name: 'MyLibrary',
+      fileName: 'index'
+    }
+  }
+});
+```
+
+### Custom Banner Template
+
+You can provide a custom banner template:
+
+```typescript
+import { defineConfig } from 'vite';
+import { screwUp } from 'screw-up';
+
+export default defineConfig({
+  plugins: [
+    screwUp({
+      bannerTemplate: '/* My Custom Header - Built with ❤️ */'
+    })
+  ],
+  build: {
+    lib: {
+      entry: 'src/index.ts',
+      name: 'MyLibrary',
+      fileName: 'index'
+    }
+  }
+});
+```
+
+### Custom Package Path
+
+Specify a different path to your package.json:
+
+```typescript
+import { defineConfig } from 'vite';
+import { screwUp } from 'screw-up';
+
+export default defineConfig({
+  plugins: [
+    screwUp({
+      packagePath: './packages/core/package.json'
+    })
+  ]
+});
+```
+
+## Advanced Usage
+
+### Working with Monorepos
+
+In monorepo setups, you might want to reference a specific package's metadata:
+
+```typescript
+import { defineConfig } from 'vite';
+import { screwUp } from 'screw-up';
+
+export default defineConfig({
+  plugins: [
+    screwUp({
+      packagePath: '../../packages/ui/package.json'
+    })
+  ],
+  build: {
+    lib: {
+      entry: 'src/index.ts',
+      name: 'UILibrary',
+      fileName: 'ui'
+    }
+  }
+});
+```
+
+### Programmatic Banner Generation
+
+You can also use the utility functions directly:
+
+```typescript
+import { generateBanner, readPackageMetadata } from 'screw-up';
+
+// Read package metadata
+const metadata = readPackageMetadata('./package.json');
+
+// Generate banner
+const banner = generateBanner({
+  name: 'my-package',
+  version: '1.0.0',
+  description: 'A great package',
+  author: 'Developer Name',
+  license: 'MIT'
+});
+
+console.log(banner);
+// /*!
+//  * my-package v1.0.0
+//  * A great package
+//  * Author: Developer Name
+//  * License: MIT
+//  */
+```
+
+----
+
+## License
+
+Under MIT

package/dist/index.cjs

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const fs = require("fs");
+const path = require("path");
+const generateBanner = (metadata) => {
+  const name = metadata.name || "Unknown Package";
+  const version = metadata.version || "0.0.0";
+  const description = metadata.description || "";
+  let author = "";
+  if (metadata.author) {
+    if (typeof metadata.author === "string") {
+      author = metadata.author;
+    } else {
+      author = metadata.author.email ? `${metadata.author.name} <${metadata.author.email}>` : metadata.author.name;
+    }
+  }
+  const license = metadata.license || "";
+  const parts = [
+    `${name} ${version}`,
+    description && `${description}`,
+    author && `Author: ${author}`,
+    license && `License: ${license}`
+  ].filter(Boolean);
+  return `/*!
+ * ${parts.join("\n * ")}
+ */`;
+};
+const readPackageMetadata = (packagePath) => {
+  try {
+    const content = fs.readFileSync(packagePath, "utf-8");
+    return JSON.parse(content);
+  } catch (error) {
+    console.warn(`Failed to read package.json from ${packagePath}:`, error);
+    return {};
+  }
+};
+const screwUp = (options = {}) => {
+  const { packagePath = "./package.json", bannerTemplate } = options;
+  let banner;
+  return {
+    name: "screw-up",
+    apply: "build",
+    configResolved(config) {
+      const resolvedPackagePath = path.resolve(config.root, packagePath);
+      const metadata = readPackageMetadata(resolvedPackagePath);
+      banner = bannerTemplate || generateBanner(metadata);
+    },
+    generateBundle(_options, bundle) {
+      for (const fileName in bundle) {
+        const chunk = bundle[fileName];
+        if (chunk.type === "chunk") {
+          chunk.code = banner + "\n" + chunk.code;
+        }
+      }
+    }
+  };
+};
+exports.generateBanner = generateBanner;
+exports.readPackageMetadata = readPackageMetadata;
+exports.screwUp = screwUp;

package/dist/index.d.ts

@@ -0,0 +1,44 @@
+import { Plugin } from 'vite';
+
+interface PackageMetadata {
+    name?: string;
+    version?: string;
+    description?: string;
+    author?: string | {
+        name: string;
+        email?: string;
+    };
+    license?: string;
+}
+/**
+ * Generate banner string from package.json metadata
+ * @param metadata - Package metadata
+ * @returns Banner string
+ */
+export declare const generateBanner: (metadata: PackageMetadata) => string;
+/**
+ * Read and parse package.json file
+ * @param packagePath - Path to package.json
+ * @returns Package metadata
+ */
+export declare const readPackageMetadata: (packagePath: string) => PackageMetadata;
+export interface ScrewUpOptions {
+    /**
+     * Path to package.json file
+     * @default "./package.json"
+     */
+    packagePath?: string;
+    /**
+     * Custom banner template
+     * @default undefined (uses built-in template)
+     */
+    bannerTemplate?: string;
+}
+/**
+ * Vite plugin that adds banner to the bundled code
+ * @param options - Plugin options
+ * @returns Vite plugin
+ */
+export declare const screwUp: (options?: ScrewUpOptions) => Plugin;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAInC,UAAU,eAAe;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,UAAU,eAAe,KAAG,MA0B1D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,aAAa,MAAM,KAAG,eAQzD,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,eAAO,MAAM,OAAO,GAAI,UAAS,cAAmB,KAAG,MAsBtD,CAAC"}

package/dist/index.js

@@ -0,0 +1,60 @@
+import { readFileSync } from "fs";
+import { resolve } from "path";
+const generateBanner = (metadata) => {
+  const name = metadata.name || "Unknown Package";
+  const version = metadata.version || "0.0.0";
+  const description = metadata.description || "";
+  let author = "";
+  if (metadata.author) {
+    if (typeof metadata.author === "string") {
+      author = metadata.author;
+    } else {
+      author = metadata.author.email ? `${metadata.author.name} <${metadata.author.email}>` : metadata.author.name;
+    }
+  }
+  const license = metadata.license || "";
+  const parts = [
+    `${name} ${version}`,
+    description && `${description}`,
+    author && `Author: ${author}`,
+    license && `License: ${license}`
+  ].filter(Boolean);
+  return `/*!
+ * ${parts.join("\n * ")}
+ */`;
+};
+const readPackageMetadata = (packagePath) => {
+  try {
+    const content = readFileSync(packagePath, "utf-8");
+    return JSON.parse(content);
+  } catch (error) {
+    console.warn(`Failed to read package.json from ${packagePath}:`, error);
+    return {};
+  }
+};
+const screwUp = (options = {}) => {
+  const { packagePath = "./package.json", bannerTemplate } = options;
+  let banner;
+  return {
+    name: "screw-up",
+    apply: "build",
+    configResolved(config) {
+      const resolvedPackagePath = resolve(config.root, packagePath);
+      const metadata = readPackageMetadata(resolvedPackagePath);
+      banner = bannerTemplate || generateBanner(metadata);
+    },
+    generateBundle(_options, bundle) {
+      for (const fileName in bundle) {
+        const chunk = bundle[fileName];
+        if (chunk.type === "chunk") {
+          chunk.code = banner + "\n" + chunk.code;
+        }
+      }
+    }
+  };
+};
+export {
+  generateBanner,
+  readPackageMetadata,
+  screwUp
+};

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "screw-up",
+  "version": "0.1.0",
+  "description": "Simply package metadata inserter on Vite plugin",
+  "keywords": [
+    "vite",
+    "plugin",
+    "package",
+    "metadata",
+    "inserter"
+  ],
+  "author": "Kouji Matsui (@kekyo@mi.kekyo.net)",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kekyo/screw-up.git"
+  },
+  "homepage": "https://github.com/kekyo/screw-up#readme",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rv --npm . && tsc --noEmit && vite build && tsc --emitDeclarationOnly --outDir dist",
+    "test": "rv --npm . && tsc --noEmit && vitest run"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0",
+    "vite": "^5.0.0",
+    "vite-plugin-dts": "^3.0.0",
+    "vitest": "^1.0.0"
+  }
+}