grunt-template-coffee - npm Package Compare versions

Comparing version 0.3.0 to 0.4.0

package.json

 {
   "name": "grunt-template-coffee",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Grunt-init scaffolding template for CoffeeScript applications",
@@ -36,3 +36,3 @@ "license": "BSD-3-Clause",
     "load-grunt-tasks": "~0.3.0",
-    "grunt-contrib-coffee": "~0.9.0",
+    "grunt-contrib-coffee": "~0.10.0",
     "grunt-contrib-clean": "~0.5.0",
@@ -39,0 +39,0 @@ "grunt-contrib-copy": "~0.5.0"

README.md

@@ -39,3 +39,3 @@ Grunt-Template-Coffee
 grunt-init node-coffee
-# ... answering questions, Grunt doing its magic...
+# ... You answering questions, Grunt doing its magic...
 npm install # Install development dependencies
@@ -75,3 +75,2 @@ ```
 ├── test/             --> Your test cases
-├── lib/              --> The application's staging ground for publishing
 │
@@ -97,18 +96,21 @@ ├── gruntfile.coffee  --> Grunt tasks configuration
 
-#### The *lib* folder:
-This is the application's staging area - once you run `grunt build`, it will:
+#### The build process:
+Build your application with the `grunt build` command - it will:
 
-1. Compile CoffeeScript in *src/* to JavaScript and place the compiled files to *lib/src/* folder
-1. Compile your *index.coffee* to JavaScript and place it to *lib/* folder
-1. Copy the *res/* folder to *lib/*, doing nothing with its contents
-1. Copy all files from your root folder to *lib/*, except of *gruntfile.coffee*, *index.coffee* and *coffeelint.json*
-1. Uglify and mangle all JavaScript files within the *lib/* directory
+1. Compile CoffeeScript in *src/* to JavaScript and place the compiled files next to your source code
+1. Compile your *index.coffee* to JavaScript
+1. Do nothing with files inside the *res/* folder
+1. Uglify and mangle all compiled JavaScript files
 
-When finished, you will have a fully working, deployment-ready application in your *lib/* folder, ready for publishing to **NPM**. Just give it a try - create a test project, install dependencies and run `grunt build`, then take a look inside the *lib/* folder to see what happened.
+When finished, you will have an optimised version of your project, ready for publishing to **NPM**. Just give it a try - create a test project, install dependencies and run `grunt build`, then take a look around to see what happened.
 
 #### Publishing to **NPM Registry**:
-Once you have everything sorted out and your application built successfully, go to your *lib/* folder and publish your application to **NPM** via: `npm publish`. And, you are done!
+Once you have everything sorted out and your application built successfully, simply publish your application to **NPM** via `npm publish`. And, you are done!
 
 The template also installs some sample content to show you how to write and organise the code so you get better understanding about your possibilities.
 
+### Creating additional directories
+
+If you would like to give your code more structure via folder hierarchy, always remember to create a *.gitignore* file in all new folders that excludes all `*.js` files ( to prevent accidentally commiting compiled JavaScript code into your repository ) and also update the *.npmignore* file in the root directory to exclude all *YOUR_FOLDER/\*.coffee* files to prevent publishing your source CoffeeScript files with your optimised content.
+
 ## Planned features
@@ -115,0 +117,0 @@

rename.json

 {
   "gitignore": ".gitignore",
+  "src/gitignore": "src/.gitignore",
+  "npmignore": ".npmignore",
   "travis.yml": ".travis.yml"
 }

template.js

@@ -40,4 +40,3 @@
         "grunt-contrib-clean": "~0.5.0",
-        "grunt-contrib-coffee": "~0.9.0",
-        "grunt-contrib-copy": "~0.5.0",
+        "grunt-contrib-coffee": "~0.10.0",
         "grunt-contrib-uglify": "~0.3.1",
@@ -44,0 +43,0 @@ "grunt-contrib-watch": "~0.5.3",

No alert changes

Improved metrics

Number of package files

18

increased by12.5%

Lines of code

93

increased by1.09%

Number of lines in readme file

122

increased by1.67%

Worsened metrics

Total package byte prevSize

28330

decreased by-1.47%

No dependency changes