screw-up 0.3.0 → 0.5.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.d.ts

@@ -1,5 +1,8 @@
 import { Plugin } from 'vite';
 
+/**
+ * screw-up options
+ */
 export interface ScrewUpOptions {
     /**
      * Array of keys to output in banner in the specified order

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,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;CACzB;AAED;;;;GAIG;AACH,QAAA,MAAM,OAAO,GAAI,UAAS,cAAmB,KAAG,MA2D/C,CAAC;AAEF,eAAe,OAAO,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screw-up",
-  "version": "0.3.0",
+  "version": "0.5.1",
   "description": "Simply package metadata inserter on Vite plugin",
   "keywords": [
     "vite",
@@ -34,10 +34,12 @@
     "build": "rv --npm . && tsc --noEmit && vite build && tsc --emitDeclarationOnly --outDir dist",
     "test": "rv --npm . && tsc --noEmit && vitest run"
   },
+  "peerDependencies": {
+    "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"
   }