milkee 2.4.0-dev.0 → 2.4.0-dev.2

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');
@@ -30,15 +30,15 @@ TEMPLATES = [
     dest: '.github/workflows/publish.yml'
   },
   {
-    src: '.gitignore',
+    src: '_gitignore',
     dest: '.gitignore'
   },
   {
-    src: '.gitattributes',
+    src: '_gitattributes',
     dest: '.gitattributes'
   },
   {
-    src: '.npmignore',
+    src: '_npmignore',
     dest: '.npmignore'
   }
 ];
@@ -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.0",
+  "version": "2.4.0-dev.2",
   "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/_gitattributes

@@ -0,0 +1,2 @@
+*.coffee linguist-language=CoffeeScript
+dist/* linguist-generated

package/temp/plugin/_gitignore

@@ -0,0 +1,2 @@
+node_modules/
+.env

package/temp/plugin/_npmignore

@@ -0,0 +1,4 @@
+.github/
+src/
+.gitattributes
+coffee.config.cjs

package/temp/plugin/coffee.config.cjs

@@ -0,0 +1,35 @@
+/** @type {import('@milkee/d').Config} */
+
+module.exports = {
+  // The entry point for compilation.
+  // This can be a single file or a directory (e.g., 'src/' or 'src/app.coffee').
+  entry: 'src',
+  // The output for the compiled JavaScript files.
+  // If 'options.join' is true, this should be a single file path (e.g., 'dist/app.js').
+  // If 'options.join' is false, this should be a directory (e.g., 'dist').
+  output: 'dist',
+  // (Optional) Additional options for the CoffeeScript compiler.
+  // See `coffee --help` for all available options.
+  // Web: https://coffeescript.org/annotated-source/command.html
+  options: {
+    // The following options are supported:
+    bare: true,
+    // join: false,
+    // map: false,
+    // inlineMap: false,
+    // noHeader: false,
+    // transpile: false,
+    // literate: false,
+    // watch: false,
+  },
+  // (Optional) Additional options/plugins for the Milkee builder.
+  milkee: {
+    options: {
+      // Before compiling, reset the directory.
+      // refresh: false,
+      // Before compiling, confirm "Do you want to Continue?"
+      // confirm: false,
+    },
+    plugins: []
+  },
+};

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}"

package/docs/PLUGIN-ja.md

@@ -1,143 +0,0 @@
-# Milkee プラグインの作成
-
-カスタムプラグインで Milkee の機能を拡張できます。  
-
-## クイックスタート
-
-`-p` (`--plugin`) コマンドでプラグインプロジェクトをセットアップ：  
-
-```bash
-# グローバル
-milkee -p
-
-# ローカル
-npx milkee -p
-```
-
-以下が実行されます：
-1. `package.json` の初期化（必要な場合）
-2. 依存関係のインストール (`consola`, `coffeescript`, `milkee`)
-3. テンプレートファイルの作成
-4. `package.json` の更新 (`main`, `scripts`, `keywords`)
-
-## プロジェクト構造
-
-```
-your-plugin/
-  src/
-    main.coffee    # プラグインのソース
-  dist/
-    main.js        # コンパイル後の出力
-  .github/
-    workflows/
-      publish.yml  # npm公開ワークフロー
-  coffee.config.cjs
-  package.json
-```
-
-## プラグインの書き方
-
-### 基本テンプレート
-
-```coffee
-fs = require 'fs'
-path = require 'path'
-consola = require 'consola'
-
-pkg = require '../package.json'
-PREFIX = "[#{pkg.name}]"
-
-# プレフィックス付きカスタムロガー
-c = {}
-for method in ['log', 'info', 'success', 'warn', 'error', 'debug', 'start', 'box']
-  do (method) ->
-    c[method] = (args...) ->
-      if typeof args[0] is 'string'
-        args[0] = "#{PREFIX} #{args[0]}"
-      consola[method] args...
-
-# メインプラグイン関数
-main = (compilationResult) ->
-  { config, compiledFiles, stdout, stderr } = compilationResult
-  
-  c.info "#{compiledFiles.length} ファイルをコンパイルしました"
-  for file in compiledFiles
-    c.log "  - #{file}"
-
-module.exports = main
-```
-
-### コンパイル結果
-
-Milkee はコンパイル後にこのオブジェクトをプラグインに渡します：  
-
-| プロパティ      | 型         | 説明                                           |
-| :-------------- | :--------- | :--------------------------------------------- |
-| `config`        | `object`   | `coffee.config.cjs` の設定オブジェクト         |
-| `compiledFiles` | `string[]` | コンパイルされた `.js` と `.js.map` のパス     |
-| `stdout`        | `string`   | コンパイラの標準出力                           |
-| `stderr`        | `string`   | コンパイラの標準エラー                         |
-
-### coffee.config.cjs での使用
-
-```js
-const myPlugin = require('your-plugin-name');
-
-module.exports = {
-  entry: 'src',
-  output: 'dist',
-  milkee: {
-    plugins: [
-      myPlugin({ customOption: 'value' }),
-    ]
-  }
-};
-```
-
-## ビルド & テスト
-
-```bash
-# プラグインをビルド
-npm run build
-
-# ローカルテスト用にリンク
-npm link
-
-# 別のプロジェクトで
-npm link your-plugin-name
-```
-
-## 公開
-
-### GitHub Actions を使用
-
-同梱のワークフローで npm に手動公開：  
-
-1. リポジトリに `NPM_TOKEN` シークレットを追加
-2. **Actions** → **Manual Publish to npm** に移動
-3. **Run workflow** をクリック
-
-### 手動
-
-```bash
-npm run build
-npm publish --access public
-```
-
-## ベストプラクティス
-
-### 命名規則 & キーワード
-
-- 名前: `milkee-plugin-xxx` または `@yourname/milkee-plugin-xxx`
-- キーワード（自動追加）: `milkee`, `coffeescript`, `coffee`, `ext`, `plugin`, `milkee-plugin`
-
-### エラーハンドリング
-
-```coffee
-main = (compilationResult) ->
-  try
-    # ロジック
-  catch error
-    c.error "失敗:", error.message
-    throw error
-```

package/docs/PLUGIN.md

@@ -1,143 +0,0 @@
-# Creating a Milkee Plugin
-
-Extend Milkee's functionality with custom plugins.  
-
-## Quick Start
-
-Run `-p` (`--plugin`) command to set up your plugin project:  
-
-```bash
-# global
-milkee -p
-
-# or local
-npx milkee -p
-```
-
-This will:
-1. Initialize `package.json` (if needed)
-2. Install dependencies (`consola`, `coffeescript`, `milkee`)
-3. Create template files
-4. Update `package.json` (`main`, `scripts`, `keywords`)
-
-## Project Structure
-
-```
-your-plugin/
-  src/
-    main.coffee    # Your plugin source
-  dist/
-    main.js        # Compiled output
-  .github/
-    workflows/
-      publish.yml  # npm publish workflow
-  coffee.config.cjs
-  package.json
-```
-
-## Writing Your Plugin
-
-### Basic Template
-
-```coffee
-fs = require 'fs'
-path = require 'path'
-consola = require 'consola'
-
-pkg = require '../package.json'
-PREFIX = "[#{pkg.name}]"
-
-# Custom logger with prefix
-c = {}
-for method in ['log', 'info', 'success', 'warn', 'error', 'debug', 'start', 'box']
-  do (method) ->
-    c[method] = (args...) ->
-      if typeof args[0] is 'string'
-        args[0] = "#{PREFIX} #{args[0]}"
-      consola[method] args...
-
-# Main plugin function
-main = (compilationResult) ->
-  { config, compiledFiles, stdout, stderr } = compilationResult
-  
-  c.info "Compiled #{compiledFiles.length} file(s)"
-  for file in compiledFiles
-    c.log "  - #{file}"
-
-module.exports = main
-```
-
-### Compilation Result
-
-Milkee passes this object to your plugin after compilation:  
-
-| Property        | Type       | Description                                    |
-| :-------------- | :--------- | :--------------------------------------------- |
-| `config`        | `object`   | Full config from `coffee.config.cjs`           |
-| `compiledFiles` | `string[]` | Paths to compiled `.js` and `.js.map` files    |
-| `stdout`        | `string`   | Compiler standard output                       |
-| `stderr`        | `string`   | Compiler standard error                        |
-
-### Using in coffee.config.cjs
-
-```js
-const myPlugin = require('your-plugin-name');
-
-module.exports = {
-  entry: 'src',
-  output: 'dist',
-  milkee: {
-    plugins: [
-      myPlugin({ customOption: 'value' }),
-    ]
-  }
-};
-```
-
-## Build & Test
-
-```bash
-# Build your plugin
-npm run build
-
-# Link for local testing
-npm link
-
-# In another project
-npm link your-plugin-name
-```
-
-## Publishing
-
-### Using GitHub Actions
-
-The included workflow publishes to npm manually:  
-
-1. Add `NPM_TOKEN` secret to your repository
-2. Go to **Actions** → **Manual Publish to npm**
-3. Click **Run workflow**
-
-### Manual
-
-```bash
-npm run build
-npm publish --access public
-```
-
-## Best Practices
-
-### Naming & Keywords
-
-- Name: `milkee-plugin-xxx` or `@yourname/milkee-plugin-xxx`
-- Keywords (auto-added): `milkee`, `coffeescript`, `coffee`, `ext`, `plugin`, `milkee-plugin`
-
-### Error Handling
-
-```coffee
-main = (compilationResult) ->
-  try
-    # Your logic
-  catch error
-    c.error "Failed:", error.message
-    throw error
-```