milkee 2.0.0-dev.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +22 -1
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -98,6 +98,8 @@ These options are passed directly to the `coffee` compiler.
98
98
  | `literate` | `boolean` | `false` | treat stdio as literate style coffeescript |
99
99
  | `watch` | `boolean` | `false` | watch scripts for changes and rerun commands |
100
100
 
101
+ [CoffeeScript - command.coffee](https://coffeescript.org/annotated-source/command.html)
102
+
101
103
  ##### `milkee.options` (Milkee Specific Options)
102
104
 
103
105
  These options control Milkee's behavior.
@@ -107,7 +109,26 @@ These options control Milkee's behavior.
107
109
  | `refresh` | `boolean` | `false` | Before compiling, reset the output directory. |
108
110
  | `confirm` | `boolean` | `false` | Before compiling, prompt "Do you want to Continue?". |
109
111
 
110
- [CoffeeScript - command.coffee](https://coffeescript.org/annotated-source/command.html)
112
+ ##### `milkee.plugins` (Milkee Specific Plugins)
113
+
114
+ You can extend Milkee's functionality by using plugins. Plugins are simple functions that run after each successful compilation, giving you access to the compiled files and configuration.
115
+
116
+ Example:
117
+
118
+ ```js
119
+ const myPlugin = require('./plugins/my-plugin.js');
120
+
121
+ module.exports = {
122
+ // ...
123
+ milkee: {
124
+ plugins: [
125
+ // This call returns the PluginExecutor
126
+ myPlugin({ option: 'value' }),
127
+ // ...
128
+ ]
129
+ }
130
+ }
131
+ ```
111
132
 
112
133
  ### Compile
113
134
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "milkee",
3
- "version": "2.0.0-dev.1",
3
+ "version": "2.0.0",
4
4
  "description": "A simple CoffeeScript build tool with coffee.config.cjs",
5
5
  "main": "dist/main.js",
6
6
  "bin": {
@@ -32,7 +32,7 @@
32
32
  },
33
33
  "homepage": "https://github.com/otoneko1102/coffeescript-milkee#readme",
34
34
  "dependencies": {
35
- "@milkee/d": "^0.1.0",
35
+ "@milkee/d": "^0.2.0",
36
36
  "consola": "^3.4.2",
37
37
  "yargs": "^18.0.0"
38
38
  },