raml2md - npm Package Compare versions

Comparing version 2.0.1 to 2.1.0

changelog.md

@@ -0,1 +1,4 @@
+2.1.0 - May 22, 2015
+- Split the library from the command line program
+
 2.0.1 - March 20, 2015
@@ -2,0 +5,0 @@ - Fixed help text for the -t option

examples/script.js

@@ -0,1 +1,3 @@
+'use strict';
+
 /*
@@ -5,5 +7,4 @@ Example of using raml2md as a script.
 
-var raml2md = require('../lib/raml2md');
+var raml2md = require('..');
 
-
 // raml2md.render() needs a config object with at least a `template` property (a url to a Nunjucks template).
@@ -13,6 +14,6 @@ // Instead of creating this config object ourselves, we can just ask for raml2md.getDefaultConfig():
 
-raml2md.render(__dirname+'/example.raml', config1).then(function(result) {
-    console.log(result);
+raml2md.render(__dirname + '/example.raml', config).then(function(result) {
+  console.log(result);
 }, function(error) {
-    console.log('error! ', error);
+  console.log('error! ', error);
 });

package.json

 {
   "name": "raml2md",
   "description": "RAML to Markdown documentation generator",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "author": {
@@ -15,5 +15,9 @@ "name": "Kevin Renskers",
     "nunjucks": "1.2.x",
-    "raml2obj": "2.0.x",
+    "raml2obj": "2.1.x",
     "q": "1.2.x"
   },
+  "devDependencies": {
+    "jscs": "1.12.x",
+    "jshint": "2.6.x"
+  },
   "homepage": "https://github.com/kevinrenskers/raml2md",
@@ -24,3 +28,3 @@ "keywords": [
   "license": "MIT",
-  "main": "lib/raml2md.js",
+  "main": "index.js",
   "repository": {
@@ -31,5 +35,8 @@ "type": "git",
   "preferGlobal": "true",
+  "scripts": {
+    "lint": "jscs lib/raml2md.js && jshint lib/raml2md.js"
+  },
   "bin": {
-    "raml2md": "lib/raml2md.js"
+    "raml2md": "./bin/raml2md"
   }
 }

README.md

@@ -18,3 +18,2 @@ # RAML to Markdown
 ### As a command line script
-
 ```
@@ -36,5 +35,5 @@ raml2md example.raml > example.md
 raml2md.render(source, config).then(function(result) {
-    // Save the result to a file or do something else with the result
+  // Save the result to a file or do something else with the result
 }, function(error) {
-    // Output error
+  // Output error
 });
@@ -52,5 +51,5 @@ ```
 raml2md.render(source, config).then(function(result) {
-    // Save the result to a file or do something else with the result
+  // Save the result to a file or do something else with the result
 }, function(error) {
-    // Output error
+  // Output error
 });
@@ -66,4 +65,4 @@ ```
 1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
-2. Fork the repository on Github and make your changes on the develop branch (or branch off of it).
-   Please retain the code style that is used in the project.
+2. Fork the repository on Github and make your changes on the **develop** branch (or branch off of it).  
+   Please retain the [code style](https://github.com/airbnb/javascript) that is used in the project and `npm run lint` before committing.
 3. Add an example of the new feature to example.raml (if applicable)
@@ -70,0 +69,0 @@ 4. Send a pull request (with the develop branch as the target).

Fixed alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

29041

increased by44%

Number of package files

15

increased by36.36%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

2

increased byInfinity%

Lines of code

57

decreased by-35.23%

Number of lines in readme file

78

decreased by-1.27%

Dependency changes

• + Addedraml2obj@2.1.0(transitive)

• - Removedraml2obj@2.0.0(transitive)

• Updatedraml2obj@2.1.x