milkee 2.3.1 → 2.4.0-dev.0

package/dist/commands/plugin.js

@@ -0,0 +1,208 @@
+// 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,
+  indexOf = [].indexOf;
+
+fs = require('fs');
+
+path = require('path');
+
+({execSync} = require('child_process'));
+
+consola = require('consola');
+
+({CWD, CONFIG_FILE} = require('../constants'));
+
+confirmContinue = require('../options/confirm');
+
+TEMPLATE_DIR = path.join(__dirname, '..', '..', 'temp', 'plugin');
+
+TEMPLATES = [
+  {
+    src: 'main.coffee',
+    dest: 'src/main.coffee'
+  },
+  {
+    src: 'coffee.config.cjs',
+    dest: CONFIG_FILE
+  },
+  {
+    src: 'publish.yml',
+    dest: '.github/workflows/publish.yml'
+  },
+  {
+    src: '.gitignore',
+    dest: '.gitignore'
+  },
+  {
+    src: '.gitattributes',
+    dest: '.gitattributes'
+  },
+  {
+    src: '.npmignore',
+    dest: '.npmignore'
+  }
+];
+
+// Create directory if not exists
+ensureDir = function(filePath) {
+  var dir;
+  dir = path.dirname(filePath);
+  if (!fs.existsSync(dir)) {
+    return fs.mkdirSync(dir, {
+      recursive: true
+    });
+  }
+};
+
+// Copy template file
+copyTemplate = function(src, dest) {
+  var content, destPath, srcPath;
+  srcPath = path.join(TEMPLATE_DIR, src);
+  destPath = path.join(CWD, dest);
+  if (!fs.existsSync(srcPath)) {
+    consola.error(`Template file not found: ${srcPath}`);
+    return false;
+  }
+  ensureDir(destPath);
+  content = fs.readFileSync(srcPath, 'utf-8');
+  fs.writeFileSync(destPath, content);
+  consola.success(`Created \`${dest}\``);
+  return true;
+};
+
+PLUGIN_KEYWORDS = ['milkee', 'coffeescript', 'coffee', 'ext', 'plugin', 'milkee-plugin'];
+
+// Update package.json
+updatePackageJson = function() {
+  var base, error, i, keyword, len, pkg, pkgPath;
+  pkgPath = path.join(CWD, 'package.json');
+  try {
+    pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
+    // Update main
+    pkg.main = 'dist/main.js';
+    // Update scripts
+    if (pkg.scripts == null) {
+      pkg.scripts = {};
+    }
+    if ((base = pkg.scripts).test == null) {
+      base.test = 'echo "Error: no test specified" && exit 0';
+    }
+    pkg.scripts.build = 'milkee';
+    // Update keywords
+    if (pkg.keywords == null) {
+      pkg.keywords = [];
+    }
+    for (i = 0, len = PLUGIN_KEYWORDS.length; i < len; i++) {
+      keyword = PLUGIN_KEYWORDS[i];
+      if (indexOf.call(pkg.keywords, keyword) < 0) {
+        pkg.keywords.push(keyword);
+      }
+    }
+    fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n');
+    consola.success("Updated `package.json`");
+    return true;
+  } catch (error1) {
+    error = error1;
+    consola.error("Failed to update package.json:", error);
+    return false;
+  }
+};
+
+// Initialize package.json if not exists
+initPackageJson = function() {
+  var error, pkgPath;
+  pkgPath = path.join(CWD, 'package.json');
+  if (!fs.existsSync(pkgPath)) {
+    consola.start("Initializing package.json...");
+    try {
+      execSync('npm init -y', {
+        cwd: CWD,
+        stdio: 'inherit'
+      });
+      consola.success("Created `package.json`");
+    } catch (error1) {
+      error = error1;
+      consola.error("Failed to create package.json:", error);
+      return false;
+    }
+  }
+  return true;
+};
+
+// Main plugin setup function
+plugin = async function() {
+  var confirmed, destPath, error, i, j, len, len1, overwrite, pkgPath, 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("  1. Install dependencies (consola, coffeescript, milkee)");
+  consola.info("  2. Create template files:");
+  for (i = 0, len = TEMPLATES.length; i < len; i++) {
+    template = TEMPLATES[i];
+    consola.info(`     - ${template.dest}`);
+  }
+  consola.info("  3. Update package.json (main, scripts, keywords)");
+  consola.info("");
+  // Confirm before proceeding
+  confirmed = (await confirmContinue());
+  if (!confirmed) {
+    return;
+  }
+  consola.info("");
+  // Initialize package.json if not exists
+  if (!initPackageJson()) {
+    return;
+  }
+  try {
+    // Install dependencies
+    consola.start("Installing dependencies...");
+    execSync('npm install consola', {
+      cwd: CWD,
+      stdio: 'inherit'
+    });
+    execSync('npm install -D coffeescript milkee', {
+      cwd: CWD,
+      stdio: 'inherit'
+    });
+    consola.success("Dependencies installed!");
+  } catch (error1) {
+    error = error1;
+    consola.error("Failed to install dependencies:", error);
+    return;
+  }
+  consola.info("");
+  // Create template files
+  consola.start("Creating template files...");
+  for (j = 0, len1 = TEMPLATES.length; j < len1; j++) {
+    template = TEMPLATES[j];
+    destPath = path.join(CWD, template.dest);
+    if (fs.existsSync(destPath)) {
+      overwrite = (await consola.prompt(`${template.dest} already exists. Overwrite?`, {
+        type: "confirm"
+      }));
+      if (!overwrite) {
+        consola.info(`Skipped \`${template.dest}\``);
+        continue;
+      }
+    }
+    copyTemplate(template.src, template.dest);
+  }
+  consola.info("");
+  // Update package.json
+  consola.start("Updating package.json...");
+  updatePackageJson();
+  consola.info("");
+  consola.success("Milkee plugin setup complete!");
+  consola.info("");
+  consola.info("Next steps:");
+  consola.info("  1. Edit `src/main.coffee` to implement your plugin");
+  consola.info("  2. Run `npm run build` to compile");
+  return consola.info("  3. Test your plugin locally");
+};
+
+module.exports = plugin;

package/dist/main.js

@@ -1,5 +1,5 @@
 // Generated by CoffeeScript 2.7.0
-var argv, compile, hideBin, pkg, setup, yargs;
+var argv, compile, hideBin, pkg, plugin, setup, yargs;
 
 yargs = require('yargs');
 
@@ -11,6 +11,8 @@ setup = require('./commands/setup');
 
 compile = require('./commands/compile');
 
+plugin = require('./commands/plugin');
+
 argv = yargs(hideBin(process.argv)).scriptName('milkee').usage('$0 [command]').option('setup', {
   alias: 's',
   describe: "Generate a default config file",
@@ -19,10 +21,16 @@ argv = yargs(hideBin(process.argv)).scriptName('milkee').usage('$0 [command]').o
   alias: 'c',
   describe: "Compile CoffeeScript (default)",
   type: 'boolean'
+}).option('plugin', {
+  alias: 'p',
+  describe: "Set up a new Milkee plugin project",
+  type: 'boolean'
 }).version('version', pkg.version).alias('v', 'version').help('help').alias('h', 'help').argv;
 
 if (argv.setup) {
   setup();
+} else if (argv.plugin) {
+  plugin();
 } else {
   compile();
 }

package/docs/PLUGIN-ja.md

@@ -0,0 +1,143 @@
+# 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

@@ -0,0 +1,143 @@
+# 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
+```

package/package.json

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

package/temp/plugin/main.coffee

@@ -0,0 +1,25 @@
+fs = require 'fs'
+path = require 'path'
+consola = require 'consola'
+
+pkg = require '../package.json'
+PREFIX = "[#{pkg.name}]"
+
+# Create a 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

package/temp/plugin/publish.yml

@@ -0,0 +1,47 @@
+name: Manual Publish to npm
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.x"
+          registry-url: "https://registry.npmjs.org"
+
+      - name: Install, Build, and Test
+        run: |
+          npm ci
+          npm run build
+          npm test
+
+      - name: Commit dist directory (if changed)
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git add dist
+          # The following command creates a commit ONLY if there are staged changes.
+          git diff --staged --quiet || git commit -m "chore: update build artifacts"
+          git push
+
+      - name: Publish to npm
+        run: npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Create and Push Git Tag
+        run: |
+          # This step now runs after the dist commit, ensuring the tag points to the correct commit.
+          VERSION=$(node -p "require('./package.json').version")
+          git tag "v$VERSION"
+          git push origin "v$VERSION"