bunki 0.1.3 → 0.2.0

package/README.md

@@ -2,7 +2,6 @@
 
 [![GitHub license](https://img.shields.io/github/license/kahwee/bunki)](https://github.com/kahwee/bunki/blob/main/LICENSE)
 [![GitHub issues](https://img.shields.io/github/issues/kahwee/bunki)](https://github.com/kahwee/bunki/issues)
-[![Coverage Status](https://coveralls.io/repos/github/kahwee/bunki/badge.svg?branch=main)](https://coveralls.io/github/kahwee/bunki?branch=main)
 
 Bunki is an opinionated static site generator built with Bun. It's designed for creating blogs and simple websites with sensible defaults and minimal configuration.
 
@@ -17,10 +16,11 @@ Bunki is an opinionated static site generator built with Bun. It's designed for
 - Sitemap generation
 - Local development server
 - Simple CLI interface
+- Cloud image uploading via Cloudflare R2
 
 ## Installation
 
-> **IMPORTANT**: Bunki requires Bun v1.2.11 or later as its runtime. It is not compatible with Node.js and will not work with npm, yarn, or pnpm.
+> **IMPORTANT**: Bunki requires Bun v1.2.12 or later as its runtime. It is not compatible with Node.js and will not work with npm, yarn, or pnpm.
 
 ### Prerequisites
 
@@ -28,11 +28,11 @@ Bunki is an opinionated static site generator built with Bun. It's designed for
 # Install Bun if you don't have it
 curl -fsSL https://bun.sh/install | bash
 
-# Verify Bun version (should be 1.2.11 or later)
+# Verify Bun version (should be 1.2.12 or later)
 bun --version
 ```
 
-### From npm (Coming soon)
+### From bun
 
 ```bash
 # Install globally
@@ -70,7 +70,7 @@ bunki init
 
 This will:
 
-- Create a default configuration file (`bunki.config.json`)
+- Create a default configuration file (`bunki.config.ts`)
 - Set up the required directory structure
 - Create default templates
 - Add a sample blog post
@@ -113,22 +113,115 @@ Then visit http://localhost:3000 in your browser.
 
 ## Configuration
 
-The `bunki.config.json` file contains the configuration for your site:
+The `bunki.config.ts` file contains the configuration for your site:
+
+```typescript
+import { SiteConfig } from "bunki";
+import { config } from "dotenv";
+
+// Load environment variables from .env file
+config();
+
+export default function (): SiteConfig {
+  return {
+    title: "My Blog",
+    description: "A blog built with Bunki",
+    baseUrl: "https://example.com",
+    domain: "blog",
+    // S3 upload configuration
+    s3: {
+      accessKeyId: process.env.S3_ACCESS_KEY_ID || "",
+      secretAccessKey: process.env.S3_SECRET_ACCESS_KEY || "",
+      bucket: process.env.S3_BUCKET || "",
+      endpoint: process.env.S3_ENDPOINT,
+      region: process.env.S3_REGION || "auto",
+    },
+  };
+}
+```
+
+### Image Upload Configuration
+
+Bunki supports uploading images to cloud storage with two implementation options:
+
+1. **AWS SDK-based uploader** (type: `r2`) - Uses the AWS SDK for S3-compatible services
+2. **Bun native S3 uploader** (type: `bun-s3` or `bun-r2`) - Uses Bun's built-in S3 API for better performance
+
+To configure image uploading to Cloudflare R2 or any S3-compatible service, set the following environment variables:
+
+```
+R2_ACCOUNT_ID=your-cloudflare-account-id
+R2_ACCESS_KEY_ID=your-r2-access-key-id
+R2_SECRET_ACCESS_KEY=your-r2-secret-access-key
+R2_PUBLIC_URL=https://your-r2-public-url.com
+```
+
+You can add these to a `.env` file in your project root. The bucket name will be automatically generated from your domain name (e.g., `example.com` becomes `example-com`).
+
+For domain-specific custom domains, you can optionally set:
+
+```
+R2_CUSTOM_DOMAIN_EXAMPLE_COM=cdn.example.com
+```
+
+This will use `https://cdn.example.com/` as the base URL for all uploaded images.
 
-```json
-{
-  "title": "My Blog",
-  "description": "A blog built with Bunki",
-  "baseUrl": "https://example.com",
-  "domain": "blog"
+#### Selecting an Uploader Implementation
+
+When using the CLI, specify the type with the `--type` option:
+
+```bash
+# Use AWS SDK-based uploader (default)
+bunki images:push --type r2
+
+# Use Bun's native S3 API (faster performance)
+bunki images:push --type bun-s3
+# or
+bunki images:push --type bun-r2
+```
+
+The Bun native S3 uploader provides better performance and reduced memory usage, especially for large files.
+
+#### Large File Uploads
+
+For very large files, the Bun native S3 uploader (`bun-s3` or `bun-r2`) supports efficient chunked uploads using streaming. This is particularly useful for video files, high-resolution images, or other large assets.
+
+When using the Bun native implementation programmatically, you can leverage the multipart upload functionality:
+
+```javascript
+import { createUploader } from "bunki";
+
+// Create uploader instance
+const uploader = createUploader("bun-s3", uploaderConfig);
+
+// Option 1: Use the high-level large file upload method
+const fileUrl = await uploader.uploadLargeFile(
+  "/path/to/large-video.mp4",
+  "videos/large-video.mp4",
+);
+
+// Option 2: For more control, use the streaming writer
+const writer = uploader.getWriterForLargeFile(
+  "videos/large-video.mp4",
+  "video/mp4",
+);
+
+// Write data in chunks
+for (let i = 0; i < 100; i++) {
+  writer.write(chunk); // chunk can be Uint8Array, Buffer, string, etc.
 }
+
+// Finalize the upload
+await writer.end();
 ```
 
+The AWS SDK implementation (`r2`) also supports large file uploads through its own multipart upload mechanism, but doesn't provide the streaming writer interface.
+
 ## Directory Structure
 
 ```
 .
-├── bunki.config.json   # Configuration file
+├── bunki.config.ts     # Configuration file
 ├── content/            # Markdown content
 │   ├── post1.md
 │   └── post2.md
@@ -143,6 +236,7 @@ The `bunki.config.json` file contains the configuration for your site:
 │       └── main.css
 ├── public/             # Static files to copy to the site
 │   └── favicon.ico
+├── images/             # Image storage directory
 └── dist/               # Generated site
     ├── index.html
     ├── css/
@@ -170,6 +264,7 @@ Commands:
   new [options] <title> Create a new blog post
   generate [options]    Generate static site from markdown content
   serve [options]       Start a local development server
+  images:push [options] Upload images to remote storage (e.g., Cloudflare R2)
   help [command]        display help for command
 ```
 
@@ -181,7 +276,7 @@ Usage: bunki init [options]
 Initialize a new site with default structure
 
 Options:
-  -c, --config <file>  Path to config file (default: "bunki.config.json")
+  -c, --config <file>  Path to config file (default: "bunki.config.ts")
   -h, --help           display help for command
 ```
 
@@ -208,7 +303,7 @@ Usage: bunki generate [options]
 Generate static site from markdown content
 
 Options:
-  -c, --config <file>    Config file path (default: "bunki.config.json")
+  -c, --config <file>    Config file path (default: "bunki.config.ts")
   -c, --content <dir>    Content directory (default: "content")
   -o, --output <dir>     Output directory (default: "dist")
   -t, --templates <dir>  Templates directory (default: "templates")
@@ -228,16 +323,56 @@ Options:
   -h, --help           display help for command
 ```
 
+### Image Upload Commands
+
+#### Upload Multiple Images
+
+```
+Usage: bunki images:push [options]
+
+Upload images to remote storage (e.g., Cloudflare R2)
+
+Options:
+  -d, --domain <domain>     Domain name (defaults to domain in bunki.config.ts)
+  -i, --images <dir>        Images directory path (default: "images")
+  -t, --type <type>         Upload storage type (r2, bun-s3, bun-r2) (default: "r2")
+  --output-json <file>      Output URL mapping to JSON file
+  -h, --help                display help for command
+```
+
+This command will find and upload all supported image files (JPG, PNG, GIF, WebP, SVG) in the specified directory.
+
+#### Quick Upload Script
+
+Bunki also includes a convenient shell script for quick image uploads:
+
+```bash
+# Upload a single image using the shell script
+./upload-image.sh path/to/your/image.jpg
+
+# Optionally specify the domain
+./upload-image.sh path/to/your/image.jpg example.com
+```
+
+After uploading, the tool will display the public URL of the uploaded image along with the markdown syntax to use it in your content:
+
+```
+Image uploaded successfully!
+Use this URL in your markdown: ![Alt text](https://your-r2-url.com/example-com/image.jpg)
+```
+
 ## Programmatic Usage
 
 You can also use Bunki programmatically in your own Bun scripts:
 
+### Site Generation
+
 ```javascript
 import { SiteGenerator, loadConfig } from "bunki";
 import path from "path";
 
 // Load configuration
-const config = loadConfig("bunki.config.json");
+const config = loadConfig("bunki.config.ts");
 
 // Create a generator
 const generator = new SiteGenerator({
@@ -257,6 +392,47 @@ async function generate() {
 generate().catch(console.error);
 ```
 
+### Image Uploading
+
+```javascript
+import { uploadImages, DEFAULT_IMAGES_DIR, createUploader } from "bunki";
+import path from "path";
+
+// Upload all images in a directory
+async function uploadAllImages() {
+  // Upload all images in a directory
+  const imageUrlMap = await uploadImages({
+    images: DEFAULT_IMAGES_DIR,
+    type: "bun-r2", // Use Bun's native S3 API for better performance
+    outputJson: "image-urls.json",
+  });
+
+  console.log("Image URLs:", imageUrlMap);
+
+  // For large files, you can access the uploader directly
+  // Get configuration from bunki.config.json or bunki.config.ts
+  import { loadConfig } from "bunki";
+  const config = loadConfig();
+
+  // Create uploader instance
+  const uploader = createUploader(config.s3);
+
+  // Upload a large file
+  const largeFileStream = Bun.file(
+    path.join(process.cwd(), "videos/presentation.mp4"),
+  );
+  await uploader.upload(
+    "videos/presentation.mp4",
+    largeFileStream,
+    "video/mp4",
+  );
+
+  console.log("Large file uploaded successfully");
+}
+
+uploadAllImages().catch(console.error);
+```
+
 > **Note**: Bunki's programmatic API is designed specifically for Bun and utilizes Bun's native APIs for optimal performance. It will not work in Node.js environments.
 
 ## Development
@@ -278,9 +454,12 @@ bun test --watch
 
 # Run tests with coverage
 bun test:coverage
+
+# Run TypeScript type checking
+bun run typecheck
 ```
 
-Code coverage reports are automatically generated and displayed on GitHub through a badge at the top of this README. You can also view detailed coverage reports on [Coveralls](https://coveralls.io/github/kahwee/bunki).
+Code coverage reports are automatically generated during testing.
 
 Tests are written using Bun's native test runner and verify all core functionality of Bunki, including: