Merge pull request #17 from zeke/cleanup

Cleanup

Author: zeke

.travis.yml

@@ -1 +1,5 @@
 language: node_js
+node_js:
+  - "4"
+  - "6"
+  - "7"

README.md

@@ -17,8 +17,6 @@ With npm modules, most of that info can be gleaned from properties in the `packa
 
 ## Installation
 
-Download node at [nodejs.org](http://nodejs.org) and install it, if you haven't already.
-
 ```sh
 npm i -g package-json-to-readme
 ```
@@ -72,13 +70,6 @@ npm test
 
 MIT
 
-## Colophon
-
-- Homepage: https://github.com/zeke/package-json-to-readme
-- Author: Zeke Sikelianos <zeke@sikelianos.com> (http://zeke.sikelianos.com/)
-- README generated by
-[package-json-to-readme](https://github.com/zeke/package-json-to-readme)
-
 ## See Also
 
 - [mos](https://github.com/zkochan/mos), a pluggable module that injects content into your markdown files via hidden JavaScript snippets.

index.js

@@ -1,15 +1,15 @@
 #!/usr/bin/env node
-'use strict';
+'use strict'
 
-var hogan = require("hogan.js")
-var fs = require("fs")
-var path = require("path")
-var util = require("util")
+var hogan = require('hogan.js')
+var fs = require('fs')
+var path = require('path')
+var util = require('util')
 var argv = require('yargs')
   .usage('Usage: readme path/to/package.json')
-  .check(function(argv) {
-    if (!argv._.length) throw 'A path to a valid package.json is required';
-    return true;
+  .check(function (argv) {
+    if (!argv._.length) throw new Error('A path to a valid package.json is required')
+    return true
   })
   .option('r', {
     alias: 'travis',
@@ -19,80 +19,75 @@ var argv = require('yargs')
     alias: 'test',
     description: 'include test output in readme'
   })
-  .option('n', {
-    alias: 'no-footer',
-    description: 'disable the promotional footer message'
-  })
   .alias('t', 'tests')
   .help('help')
   .alias('h', 'help')
-  .argv;
-var gh = require("github-url-to-object")
-var execSync = require('sync-exec');
-var stripAnsi = require('strip-ansi');
+  .argv
+var gh = require('github-url-to-object')
+var execSync = require('sync-exec')
+var stripAnsi = require('strip-ansi')
 
 var pkgPath = path.resolve(process.cwd(), argv._[0])
 
 try {
   var pkg = require(pkgPath)
-} catch(e) {
-  return console.error("Invalid JSON file: %s", pkgPath)
+} catch (e) {
+  console.error('Invalid JSON file: %s', pkgPath)
+  process.exit()
 }
 
-pkg.private = pkg.private || pkg.license === "private" || false;
+pkg.private = pkg.private || pkg.license === 'private' || false
 
 if (argv.travis) {
   if (pkg.repository && pkg.repository.url && gh(pkg.repository.url)) {
     pkg.travis_url = gh(pkg.repository.url).travis_url
   } else {
-    return console.error("`repository.url` must be a GitHub repository URL for Travis to work")
+    console.error('`repository.url` must be a GitHub repository URL for Travis to work')
+    process.exit()
   }
 }
 
 // Run tests and fetch output
 if (argv.tests || argv.test) {
   pkg.testOutput = stripAnsi(execSync('npm test').stdout)
-    .replace(/\r/g, "")     // remove weird newlines
-    .replace(/\n+/g, "\n"); // remove excess newlines
+    .replace(/\r/g, '') // remove weird newlines
+    .replace(/\n+/g, '\n') // remove excess newlines
 }
 
 // Look for example.js or example.sh in package.json directory
-["js", "sh"].forEach(function(language){
-
-  var exampleFile = path.resolve(path.dirname(argv._[0])) + "/example." + language;
+var extensions = ['js', 'sh']
+extensions.forEach(function (language) {
+  var exampleFile = path.resolve(path.dirname(argv._[0])) + '/example.' + language
   if (fs.existsSync(exampleFile)) {
     pkg.usage = {
       language: language,
       content: fs.readFileSync(exampleFile).toString()
     }
 
     // replace require('./') statement with the package name
-    if (language === "js") {
+    if (language === 'js') {
       pkg.usage.content = pkg.usage.content.replace(
         /require\(['"]?\.\/['"]?\)/,
-        util.format("require(\"%s\")", pkg.name)
+        util.format('require("%s")', pkg.name)
       )
     }
-
   }
 })
 
-// Disable generated-by footer with --no-footer
-pkg.footer = argv['footer'] !== false
-
-var getDeps = function(deps) {
-  return Object.keys(deps).map(function(depname){
-    var dep = require(path.resolve(path.dirname(argv._[0])) + "/node_modules/" + depname + "/package.json")
+var getDeps = function (deps) {
+  return Object.keys(deps).map(function (depname) {
+    var dep = require(path.resolve(path.dirname(argv._[0])) + '/node_modules/' + depname + '/package.json')
     if (dep.repository && dep.repository.url && gh(dep.repository.url)) {
       dep.repository.url = gh(dep.repository.url).https_url
     }
     return dep
   })
 }
 
-if (pkg.dependencies) pkg.depDetails = getDeps(pkg.dependencies);
-if (pkg.devDependencies) pkg.devDepDetails = getDeps(pkg.devDependencies);
+if (pkg.dependencies) pkg.depDetails = getDeps(pkg.dependencies)
+if (pkg.devDependencies) pkg.devDepDetails = getDeps(pkg.devDependencies)
 
-var template = hogan.compile(fs.readFileSync(__dirname + "/template.md").toString())
+var templatePath = path.join(__dirname, 'template.md')
+var template = hogan.compile(fs.readFileSync(templatePath).toString())
 
 process.stdout.write(template.render(pkg))

package.json

@@ -4,12 +4,9 @@
   "description": "Generate a README.md from package.json contents",
   "main": "index.js",
   "scripts": {
-    "test": "mocha"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/zeke/package-json-to-readme"
+    "test": "mocha && standard"
   },
+  "repository": "https://github.com/zeke/package-json-to-readme",
   "keywords": [
     "package.json",
     "readme",
@@ -19,10 +16,6 @@
   ],
   "author": "Zeke Sikelianos <zeke@sikelianos.com> (http://zeke.sikelianos.com/)",
   "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/zeke/package-json-to-readme/issues"
-  },
-  "homepage": "https://github.com/zeke/package-json-to-readme",
   "dependencies": {
     "github-url-to-object": "^1.6.0",
     "hogan.js": "^2.0.0",
@@ -37,6 +30,15 @@
   "preferGlobal": true,
   "devDependencies": {
     "mocha": "^2.1.0",
-    "nixt": "^0.3.0"
+    "nixt": "^0.3.0",
+    "standard": "^8.6.0"
+  },
+  "standard": {
+    "env": {
+      "mocha": true
+    },
+    "ignore": [
+      "test/fixtures"
+    ]
   }
 }

template.md

@@ -5,8 +5,6 @@
 {{^private}}
 ## Installation
 
-Download node at [nodejs.org](http://nodejs.org) and install it, if you haven't already.
-
 ```sh
 {{#preferGlobal}}
 npm install {{name}} --global
@@ -63,7 +61,3 @@ None
 
 {{license}}
 {{/license}}
-
-{{#footer}}
-_Generated by [package-json-to-readme](https://github.com/zeke/package-json-to-readme)_
-{{/footer}}