Browse Source

Improve readme, generator

Yaroslav Kasperovich 5 years ago
parent
commit
8c4ae44238
4 changed files with 28 additions and 9 deletions
  1. 21 1
      README.md
  2. 4 5
      generator.js
  3. 2 2
      index.js
  4. 1 1
      package.json

+ 21 - 1
README.md

@@ -6,7 +6,6 @@ With built-in:
 * `cache-loader`
 * `thread-loader`
 * `babel-loader`
-* `src/main.coffee` support if you're not using `config.pages`
 
 ## Installation
 
@@ -16,6 +15,27 @@ According to [this](https://cli.vuejs.org/guide/plugins-and-presets.html#install
 vue add coffee
 ```
 
+## Common usage
+
+Usually you write SFC like this
+
+```vue
+<template>
+  <button @click="onclick">
+    <slot></slot>
+  </button>
+</template>
+
+<script lang="coffee">
+  export default
+    name: "Button"
+    props:
+      onclick:
+        type: Function
+        required: false
+</script>
+```
+
 ## Entries
 
 According to [this](https://cli.vuejs.org/config/#configurewebpack) you can add entries using your `vue.config.js` like so:

+ 4 - 5
generator.js

@@ -1,8 +1,7 @@
-module.exports = function(API) {
+module.exports = (API) => {
   return API.extendPackage({
     devDependencies: {
-      "coffee-loader": "^0.9.0",
-      "coffeescript": "^2.3.2",
-    }
+      coffeescript: require("./package.json").peerDependencies.coffeescript,
+    },
   });
-}
+};

+ 2 - 2
index.js

@@ -8,8 +8,6 @@ module.exports = (API, projectOptions) => {
 
     const coffeeRule = config.module.rule("coffee").test(/\.coffee$/);
 
-    coffeeRule.exclude.add(() => ["node_modules", "bower_components"]).end();
-
     coffeeRule.use("cache-loader").loader(require.resolve("cache-loader"));
 
     if (process.env.NODE_ENV === "production" && !!projectOptions.parallel) {
@@ -31,5 +29,7 @@ module.exports = (API, projectOptions) => {
     }
 
     coffeeRule.use("coffee-loader").loader(require.resolve("coffee-loader"));
+
+    coffeeRule.exclude.add(() => ["node_modules", "bower_components"]).end();
   });
 };

+ 1 - 1
package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-cli-plugin-coffee",
-  "version": "0.5.6",
+  "version": "0.5.7",
   "description": "CoffeeScript2 support for your @vue/cli project",
   "main": "index.js",
   "repository": {