milkee 2.4.0-dev.1 → 2.4.0

package/README.md

@@ -144,3 +144,10 @@ milkee
 # or local
 npx milkee
 ```
+
+## Creating a Plugin
+
+Want to create your own Milkee plugin? Check out the plugin documentation:  
+
+- [English](./docs/PLUGIN.md)
+- [日本語](./docs/PLUGIN-ja.md)

package/dist/commands/plugin.js

@@ -1,5 +1,5 @@
 // Generated by CoffeeScript 2.7.0
-var CONFIG_FILE, CWD, PLUGIN_KEYWORDS, TEMPLATES, TEMPLATE_DIR, confirmContinue, consola, copyTemplate, ensureDir, execSync, fs, initPackageJson, path, plugin, updatePackageJson,
+var CONFIG_FILE, CWD, PLUGIN_KEYWORDS, TEMPLATES, TEMPLATE_DIR, confirmContinue, consola, copyTemplate, ensureDir, execSync, fs, generateReadme, initPackageJson, path, plugin, updatePackageJson,
   indexOf = [].indexOf;
 
 fs = require('fs');
@@ -115,7 +115,7 @@ initPackageJson = function() {
   if (!fs.existsSync(pkgPath)) {
     consola.start("Initializing package.json...");
     try {
-      execSync('npm init -y', {
+      execSync('npm init', {
         cwd: CWD,
         stdio: 'inherit'
       });
@@ -129,16 +129,43 @@ initPackageJson = function() {
   return true;
 };
 
+// Generate README.md
+generateReadme = function() {
+  var description, error, name, pkg, pkgPath, readme, readmePath, templatePath;
+  pkgPath = path.join(CWD, 'package.json');
+  readmePath = path.join(CWD, 'README.md');
+  templatePath = path.join(TEMPLATE_DIR, 'README.md');
+  try {
+    if (!fs.existsSync(templatePath)) {
+      consola.error(`Template file not found: ${templatePath}`);
+      return false;
+    }
+    pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
+    name = pkg.name || 'your-plugin-name';
+    description = pkg.description || 'A Milkee plugin.';
+    readme = fs.readFileSync(templatePath, 'utf-8');
+    readme = readme.replace(/\{\{name\}\}/g, name);
+    readme = readme.replace(/\{\{description\}\}/g, description);
+    fs.writeFileSync(readmePath, readme);
+    consola.success("Created `README.md`");
+    return true;
+  } catch (error1) {
+    error = error1;
+    consola.error("Failed to create README.md:", error);
+    return false;
+  }
+};
+
 // Main plugin setup function
 plugin = async function() {
-  var confirmed, destPath, error, i, j, len, len1, overwrite, pkgPath, template;
+  var confirmed, destPath, error, i, j, len, len1, overwrite, pkgPath, readmePath, template;
   consola.box("Milkee Plugin Setup");
   consola.info("This will set up your project as a Milkee plugin.");
   consola.info("");
   consola.info("The following actions will be performed:");
   pkgPath = path.join(CWD, 'package.json');
   if (!fs.existsSync(pkgPath)) {
-    consola.info("  0. Initialize package.json (npm init -y)");
+    consola.info("  0. Initialize package.json (npm init)");
   }
   consola.info("  1. Install dependencies (consola, coffeescript, milkee)");
   consola.info("  2. Create template files:");
@@ -147,6 +174,7 @@ plugin = async function() {
     consola.info(`     - ${template.dest}`);
   }
   consola.info("  3. Update package.json (main, scripts, keywords)");
+  consola.info("  4. Generate README.md");
   consola.info("");
   // Confirm before proceeding
   confirmed = (await confirmContinue());
@@ -197,6 +225,21 @@ plugin = async function() {
   consola.start("Updating package.json...");
   updatePackageJson();
   consola.info("");
+  // Generate README.md
+  readmePath = path.join(CWD, 'README.md');
+  if (fs.existsSync(readmePath)) {
+    overwrite = (await consola.prompt("README.md already exists. Overwrite?", {
+      type: "confirm"
+    }));
+    if (overwrite) {
+      generateReadme();
+    } else {
+      consola.info("Skipped `README.md`");
+    }
+  } else {
+    generateReadme();
+  }
+  consola.info("");
   consola.success("Milkee plugin setup complete!");
   consola.info("");
   consola.info("Next steps:");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "milkee",
-  "version": "2.4.0-dev.1",
+  "version": "2.4.0",
   "description": "A simple CoffeeScript build tool with coffee.config.cjs",
   "main": "dist/main.js",
   "bin": {

package/temp/plugin/README.md

@@ -0,0 +1,33 @@
+# {{name}}
+
+This is a plugin for [milkee](https://www.npmjs.com/package/milkee) .
+
+{{description}}
+
+## Usage
+
+### setup
+
+#### coffee.config.cjs
+
+```js
+const plugin = require('{{name}}');
+
+module.exports = {
+  // ...
+  milkee: {
+    plugins: [
+      plugin(),
+      // ...
+    ]
+  }
+}
+```
+
+### Run
+
+```sh
+milkee
+# or
+npx milkee
+```

package/temp/plugin/main.coffee

@@ -17,7 +17,7 @@ for method in ['log', 'info', 'success', 'warn', 'error', 'debug', 'start', 'box
 # Main plugin function
 main = (compilationResult) ->
   { config, compiledFiles, stdout, stderr } = compilationResult
-  
+
   c.info "Compiled #{compiledFiles.length} file(s)"
   for file in compiledFiles
     c.log "  - #{file}"