Skip to content

Commit 36c86fa

Browse files
committed
add readme.md
1 parent 7232774 commit 36c86fa

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# vue-cli-plugin-coffee
2+
3+
CoffeeScript2 support for the projects created with [@vue/cli](https://github.com/vuejs/vue-cli).
4+
5+
## Installation
6+
7+
According to [this](https://cli.vuejs.org/guide/plugins-and-presets.html#installing-plugins-in-an-existing-project) you are able to install community plugins as follows:
8+
9+
```shell
10+
vue add coffee
11+
```
12+
13+
## Entries
14+
15+
According to [this](https://cli.vuejs.org/config/#configurewebpack) you can add entries using your `vue.config.js` like so:
16+
17+
```javascript
18+
// vue.config.js
19+
module.exports = {
20+
configureWebpack: {
21+
entry: {
22+
'new-entry': 'path/to/new/entry.coffee'
23+
}
24+
}
25+
}
26+
27+
```
28+
29+
## -coffeescript
30+
31+
I found [this](https://github.com/thisredone/vue-cli-plugin-coffeescript) package but apparently it does some `main.coffee` searching and replacement. While it is not bad by any means, it seems to me like a custom behavior. Want to keep things as clean as possible :sparkles:
32+
33+
## Troubleshooting
34+
35+
You should turn off ESLint or any non-coffee lint you have, of course :wink:

0 commit comments

Comments
 (0)