milkee 3.0.0 → 3.0.1-dev.0

package/README-ja.md

@@ -0,0 +1,155 @@
+[English](./README.md) | **日本語**
+
+# Milkee
+
+![Milkee logo](./img/Milkee-logo.png)  
+
+`coffee.config.cjs` を使ったシンプルな CoffeeScript ビルドツール
+
+## はじめに
+
+### インストール
+
+Milkee をインストールします:  
+
+```bash
+# グローバルインストール
+npm i -g milkee
+
+# ローカルインストール
+npm i -D milkee
+```
+
+CoffeeScript と `@babel/core` が必要です。  
+
+> [!TIP]
+> `options.transpile` が `true` の場合は `@babel/core` が必要です。
+
+```bash
+# グローバルインストール
+npm i -g coffeescript @babel/core
+
+# ローカルインストール
+npm i -D coffeescript @babel/core
+```
+
+### セットアップ
+
+`-s` (`--setup`) コマンドを実行すると、`coffee.config.cjs` が生成されます！  
+
+```bash
+# グローバル
+milkee -s
+
+# ローカル
+npx milkee -s
+```
+
+#### `coffee.config.cjs`
+
+```js
+/** @type {import('@milkee/d').Config} */
+
+module.exports = {
+  // コンパイルのエントリーポイント。
+  // 単一ファイルまたはディレクトリ（例: 'src/' や 'src/app.coffee'）を指定できます。
+  entry: 'src',
+  // コンパイルされた JavaScript ファイルの出力先。
+  // `options.join` が true の場合は単一ファイルパス（例: 'dist/app.js'）
+  // `options.join` が false の場合はディレクトリ（例: 'dist'）を指定します。
+  output: 'dist',
+  // (任意) CoffeeScript コンパイラの追加オプション。
+  // 利用可能な全オプションは `coffee --help` を参照してください。
+  // Web: https://coffeescript.org/annotated-source/command.html
+  options: {
+    // 以下のオプションがサポートされています:
+    // bare: false,
+    // join: false,
+    // map: false,
+    // inlineMap: false,
+    // noHeader: false,
+    // transpile: false,
+    // literate: false,
+    // watch: false,
+  },
+  // (任意) Milkee ビルダーの追加オプション / プラグイン。
+  milkee: {
+    options: {
+      // コンパイル前に出力ディレクトリをリセットします。
+      // refresh: false,
+      // コンパイル前に「実行しますか？」と確認します。
+      // confirm: false,
+      // コンパイル後に entry から output へ非 CoffeeScript ファイルをコピーします。（`options.join` が false の場合のみ有効）
+      // copy: false,
+    },
+    plugins: []
+  },
+};
+```
+
+##### `options` (CoffeeScript コンパイラオプション)
+
+これらのオプションは `coffee` コンパイラに直接渡されます。  
+
+| オプション | 型 | デフォルト | 説明 |
+| :--- | :--- | :--- | :--- |
+| `bare` | `boolean` | `false` | トップレベルの関数ラッパーなしでコンパイルする |
+| `join` | `boolean` | `false` | コンパイル前にソースを連結する |
+| `map` | `boolean` | `false` | ソースマップを生成して `.js.map` として保存する |
+| `inlineMap` | `boolean` | `false` | ソースマップを生成して出力内に直接含める |
+| `noHeader` | `boolean` | `false` | "Generated by" ヘッダを抑制する |
+| `transpile` | `boolean` | `false` | 生成された JavaScript を Babel に通す |
+| `literate` | `boolean` | `false` | 標準入力をリテラート形式の CoffeeScript として扱う |
+| `watch` | `boolean` | `false` | ファイル変更を監視してコマンドを再実行する |
+
+[CoffeeScript - command.coffee](https://coffeescript.org/annotated-source/command.html)  
+
+##### `milkee.options` (Milkee 固有オプション)
+
+これらのオプションは Milkee の動作を制御します。  
+
+| オプション | 型 | デフォルト | 説明 |
+| :--- | :--- | :--- | :--- |
+| `refresh` | `boolean` | `false` | コンパイル前に出力ディレクトリをリセットする |
+| `confirm` | `boolean` | `false` | コンパイル前に「実行しますか？」と確認する |
+| `copy` | `boolean` | `false` | コンパイル後に entry から output へ非 CoffeeScript ファイルをコピーする（`options.join` が false の場合のみ） |
+
+##### `milkee.plugins` (Milkee 固有プラグイン)
+
+Milkee の機能はプラグインで拡張できます。プラグインは、各コンパイル成功後に実行され、コンパイル済みファイルと設定にアクセスできる単純な関数です。
+
+例:
+
+```js
+const myPlugin = require('./plugins/my-plugin.js');
+
+module.exports = {
+  // ...
+  milkee: {
+    plugins: [
+      // この呼び出しは PluginExecutor を返します
+      myPlugin({ option: 'value' }),
+      // ...
+    ]
+  }
+}
+```
+
+### コンパイル
+
+Milkee は自動で `coffee.config.cjs` を読み、`options` からコマンドを組み立ててコンパイルを開始します！  
+
+```bash
+# グローバル
+milkee
+
+# ローカル
+npx milkee
+```
+
+## プラグインの作成
+
+独自の Milkee プラグインを作成したいですか？プラグインのドキュメントを確認してください:  
+
+- [English](./docs/PLUGIN.md)
+- [日本語](./docs/PLUGIN-ja.md)

package/README.md

@@ -1,3 +1,5 @@
+**English** | [日本語](./README-ja.md)
+
 # Milkee
 
 ![Milkee logo](./img/Milkee-logo.png)  
@@ -89,16 +91,16 @@ module.exports = {
 
 These options are passed directly to the `coffee` compiler.  
 
-| Option      | Type      | Default | Description                                             |
-| :---------- | :-------- | :------ | :------------------------------------------------------ |
-| `bare`      | `boolean` | `false`   | compile without a top-level function wrapper            |
-| `join`      | `boolean` | `false`   | concatenate the source CoffeeScript before compiling    |
-| `map`       | `boolean` | `false`   | generate source map and save as `.js.map` files         |
-| `inlineMap` | `boolean` | `false`   | generate source map and include it directly in output   |
-| `noHeader`  | `boolean` | `false`   | suppress the "Generated by" header                      |
-| `transpile` | `boolean` | `false`   | pipe generated JavaScript through Babel                 |
-| `literate`  | `boolean` | `false`   | treat stdio as literate style coffeescript              |
-| `watch`     | `boolean` | `false`   | watch scripts for changes and rerun commands            |
+| Option | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `bare` | `boolean` | `false` | compile without a top-level function wrapper |
+| `join` | `boolean` | `false` | concatenate the source CoffeeScript before compiling |
+| `map` | `boolean` | `false` | generate source map and save as `.js.map` files |
+| `inlineMap` | `boolean` | `false` | generate source map and include it directly in output |
+| `noHeader` | `boolean` | `false` | suppress the "Generated by" header |
+| `transpile` | `boolean` | `false` | pipe generated JavaScript through Babel |
+| `literate` | `boolean` | `false` | treat stdio as literate style coffeescript |
+| `watch` | `boolean` | `false` | watch scripts for changes and rerun commands |
 
 [CoffeeScript - command.coffee](https://coffeescript.org/annotated-source/command.html)  
 
@@ -106,11 +108,11 @@ These options are passed directly to the `coffee` compiler.
 
 These options control Milkee's behavior.  
 
-| Option    | Type      | Default | Description                                            |
-| :-------- | :-------- | :------ | :----------------------------------------------------- |
-| `refresh` | `boolean` | `false`   | Before compiling, reset the output directory.          |
-| `confirm` | `boolean` | `false`   | Before compiling, prompt "Do you want to Continue?". |
-| `copy`    | `boolean` | `false`   | After compiling, copy non-coffee files from entry to output directory. (Only works when `options.join` is `false`) |
+| Option | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `refresh` | `boolean` | `false` | Before compiling, reset the output directory. |
+| `confirm` | `boolean` | `false` | Before compiling, prompt "Do you want to Continue?". |
+| `copy` | `boolean` | `false` | After compiling, copy non-coffee files from entry to output directory. (Only works when `options.join` is `false`) |
 
 ##### `milkee.plugins` (Milkee Specific Plugins)
 

package/dist/commands/compile.js

@@ -11,11 +11,11 @@ crypto = require('crypto');
 
 consola = require('consola');
 
-({CWD, CONFIG_PATH, CONFIG_FILE} = require('../constants'));
+({CWD, CONFIG_PATH, CONFIG_FILE} = require('../lib/constants'));
 
-({checkLatest, checkCoffee} = require('../checks'));
+({checkLatest, checkCoffee} = require('../lib/checks'));
 
-({runPlugins} = require('../plugins'));
+({runPlugins} = require('../lib/plugins'));
 
 confirmContinue = require('../options/confirm');
 

package/dist/commands/plugin.js

@@ -10,7 +10,7 @@ path = require('path');
 
 consola = require('consola');
 
-({CWD, CONFIG_FILE} = require('../constants'));
+({CWD, CONFIG_FILE} = require('../lib/constants'));
 
 confirmContinue = require('../options/confirm');
 

package/dist/commands/setup.js

@@ -7,9 +7,9 @@ path = require('path');
 
 consola = require('consola');
 
-({CONFIG_FILE, CONFIG_PATH} = require('../constants'));
+({CONFIG_FILE, CONFIG_PATH} = require('../lib/constants'));
 
-({checkCoffee} = require('../checks'));
+({checkCoffee} = require('../lib/checks'));
 
 // async
 setup = async function() {

package/dist/lib/checks.js

@@ -0,0 +1,58 @@
+// Generated by CoffeeScript 2.7.0
+var CWD, checkCoffee, checkLatest, consola, exec, fs, isPackageLatest, path, pkg;
+
+fs = require('fs');
+
+path = require('path');
+
+({exec} = require('child_process'));
+
+consola = require('consola');
+
+({isPackageLatest} = require('is-package-latest'));
+
+({pkg, CWD} = require('./constants'));
+
+// async
+checkLatest = async function() {
+  var res;
+  try {
+    res = (await isPackageLatest(pkg));
+    if (res.success && !res.isLatest) {
+      consola.box({
+        title: "A new version is now available!",
+        message: `${res.currentVersion} --> \`${res.latestVersion}\`\n\n# global installation\n\`npm i -g milkee@latest\`\n# or local installation\n\`npm i -D milkee@latest\``
+      });
+      return true;
+    } else {
+      return false;
+    }
+  } catch (error1) {
+    return false;
+  }
+};
+
+checkCoffee = function() {
+  var PKG_PATH, error, pkgData, pkgFile, ref, ref1;
+  PKG_PATH = path.join(CWD, 'package.json');
+  if (fs.existsSync(PKG_PATH)) {
+    try {
+      pkgFile = fs.readFileSync(PKG_PATH, 'utf-8');
+      pkgData = JSON.parse(pkgFile);
+      if (((ref = pkgData.dependencies) != null ? ref.coffeescript : void 0) || ((ref1 = pkgData.devDependencies) != null ? ref1.coffeescript : void 0)) {
+        return;
+      }
+    } catch (error1) {
+      error = error1;
+      consola.warn(`Could not parse \`package.json\`: ${error.message}`);
+    }
+  }
+  return exec('coffee --version', function(error) {
+    if (error) {
+      consola.warn('CoffeeScript is not found in local dependencies (`dependencies`, `devDependencies`) or globally.');
+      return consola.info('Please install it via `npm install --save-dev coffeescript` to continue.');
+    }
+  });
+};
+
+module.exports = {checkLatest, checkCoffee};

package/dist/lib/constants.js

@@ -0,0 +1,14 @@
+// Generated by CoffeeScript 2.7.0
+var CONFIG_FILE, CONFIG_PATH, CWD, path, pkg;
+
+path = require('path');
+
+pkg = require('../../package.json');
+
+CWD = process.cwd();
+
+CONFIG_FILE = 'coffee.config.cjs';
+
+CONFIG_PATH = path.join(CWD, CONFIG_FILE);
+
+module.exports = {pkg, CWD, CONFIG_FILE, CONFIG_PATH};

package/dist/lib/plugins.js

@@ -0,0 +1,59 @@
+// Generated by CoffeeScript 2.7.0
+var CWD, consola, executePlugins, fs, getCompiledFiles, path, runPlugins;
+
+path = require('path');
+
+fs = require('fs');
+
+consola = require('consola');
+
+({CWD} = require('./constants'));
+
+({getCompiledFiles} = require('./utils'));
+
+executePlugins = function(config, compilationResult) {
+  var plugins, ref;
+  plugins = ((ref = config.milkee) != null ? ref.plugins : void 0) || [];
+  if (!(plugins.length > 0)) {
+    return;
+  }
+  consola.start(`Running ${plugins.length} plugin(s)...`);
+  return (async function() {    // async
+    var error, i, len, pluginFn;
+    try {
+      for (i = 0, len = plugins.length; i < len; i++) {
+        pluginFn = plugins[i];
+        if (typeof pluginFn === 'function') {
+          await Promise.resolve(pluginFn(compilationResult));
+        } else {
+          consola.warn(`Invalid plugin definition skipped (expected a function, got ${typeof pluginFn}).`);
+        }
+      }
+      return consola.success("Plugins executed successfully.");
+    } catch (error1) {
+      error = error1;
+      return consola.error("An error occurred during plugin execution:", error);
+    }
+  })();
+};
+
+runPlugins = function(config, options, stdout = '', stderr = '') {
+  var compilationResult, compiledFiles, mapPath, outputPath;
+  outputPath = path.join(CWD, config.output);
+  compiledFiles = getCompiledFiles(outputPath);
+  if (options.join && options.map && !options.inlineMap) {
+    mapPath = `${outputPath}.map`;
+    if (fs.existsSync(mapPath && !compiledFiles.includes(mapPath))) {
+      compiledFiles = compiledFiles.concat(getCompiledFiles(mapPath));
+    }
+  }
+  compilationResult = {
+    config: config,
+    compiledFiles: compiledFiles,
+    stdout: stdout,
+    stderr: stderr
+  };
+  return executePlugins(config, compilationResult);
+};
+
+module.exports = {runPlugins};

package/dist/lib/utils.js

@@ -0,0 +1,48 @@
+// Generated by CoffeeScript 2.7.0
+var consola, fs, getCompiledFiles, path, sleep;
+
+fs = require('fs');
+
+path = require('path');
+
+consola = require('consola');
+
+sleep = function(time) {
+  return new Promise(function(resolve) {
+    return setTimeout(resolve, time);
+  });
+};
+
+getCompiledFiles = function(targetPath) {
+  var error, filesList, i, item, itemPath, items, len, stat;
+  filesList = [];
+  if (!fs.existsSync(targetPath)) {
+    consola.warn(`Path does not exist, skipping scan ${targetPath}`);
+    return [];
+  }
+  try {
+    stat = fs.statSync(targetPath);
+    if (stat.isDirectory()) {
+      consola.start(`Scanning directory: ${targetPath}`);
+      items = fs.readdirSync(targetPath);
+      for (i = 0, len = items.length; i < len; i++) {
+        item = items[i];
+        itemPath = path.join(targetPath, item);
+        filesList = filesList.concat(getCompiledFiles(itemPath));
+      }
+    } else if (stat.isFile()) {
+      if (targetPath.endsWith('.js' || targetPath.endsWith('.js.map'))) {
+        if (fs.existsSync(targetPath)) {
+          consola.info(`Found file: \`${targetPath}\``);
+        }
+        filesList.push(targetPath);
+      }
+    }
+  } catch (error1) {
+    error = error1;
+    consola.warn(`Could not scan output path ${targetPath}: ${error.message}`);
+  }
+  return filesList;
+};
+
+module.exports = {sleep, getCompiledFiles};

package/dist/main.js

@@ -5,7 +5,7 @@ yargs = require('yargs');
 
 ({hideBin} = require('yargs/helpers'));
 
-({pkg} = require('./constants'));
+({pkg} = require('./lib/constants'));
 
 setup = require('./commands/setup');
 

package/dist/options/copy.js

@@ -7,7 +7,7 @@ path = require('path');
 
 consola = require('consola');
 
-({CWD} = require('../constants'));
+({CWD} = require('../lib/constants'));
 
 executeCopy = function(config) {
   var copyNonCoffeeFiles, entryPath, error, outputPath, ref, stat;

package/dist/options/refresh.js

@@ -9,7 +9,7 @@ crypto = require('crypto');
 
 consola = require('consola');
 
-({CWD} = require('../constants'));
+({CWD} = require('../lib/constants'));
 
 // Execute refresh processing
 executeRefresh = function(config, backupFiles) {

package/docs/PLUGIN-ja.md

@@ -71,12 +71,12 @@ module.exports = main
 
 Milkee はコンパイル後にこのオブジェクトをプラグインに渡します：  
 
-| プロパティ      | 型         | 説明                                           |
-| :-------------- | :--------- | :--------------------------------------------- |
-| `config`        | `object`   | `coffee.config.cjs` の設定オブジェクト         |
-| `compiledFiles` | `string[]` | コンパイルされた `.js` と `.js.map` のパス     |
-| `stdout`        | `string`   | コンパイラの標準出力                           |
-| `stderr`        | `string`   | コンパイラの標準エラー                         |
+| プロパティ | 型 | 説明 |
+| :--- | :--- | :--- |
+| `config` | `object` | `coffee.config.cjs` の設定オブジェクト |
+| `compiledFiles` | `string[]` | コンパイルされた `.js` と `.js.map` のパス |
+| `stdout` | `string` | コンパイラの標準出力 |
+| `stderr` | `string` | コンパイラの標準エラー |
 
 ### coffee.config.cjs での使用
 

package/docs/PLUGIN.md

@@ -71,12 +71,12 @@ module.exports = main
 
 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                        |
+| 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
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "milkee",
-  "version": "3.0.0",
+  "version": "3.0.1-dev.0",
   "description": "A simple CoffeeScript build tool with coffee.config.cjs",
   "main": "dist/main.js",
   "bin": {
@@ -8,7 +8,8 @@
   },
   "scripts": {
     "test": "echo \"No test specified\" && exit 0",
-    "build": "coffee --output dist/ --compile --bare src/"
+    "build": "coffee --output dist/ --compile --bare src/",
+    "deprecate:dev": "node ./scripts/deprecate-dev-versions.js"
   },
   "repository": {
     "type": "git",
@@ -40,6 +41,7 @@
   "devDependencies": {
     "@babel/core": "^7.28.5",
     "@types/coffeescript": "^2.5.7",
-    "coffeescript": "^2.7.0"
+    "coffeescript": "^2.7.0",
+    "dotenv": "^17.2.3"
   }
 }