Added Prettier and ESLint

Author: woodyrew

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.eslintrc

@@ -0,0 +1,26 @@
+root: true
+
+env:
+  node: true
+  es6: true
+
+parserOptions:
+  ecmaVersion: 2018
+  sourceType: module
+  ecmaFeatures:
+    globalReturn: true
+    impliedStrict: true
+
+extends:
+  - "eslint:recommended"
+  - prettier
+
+plugins:
+  - prettier
+
+rules:
+  "prettier/prettier": error
+  camelcase: 0
+  no-console: 1
+  quotes: [2, "single", "avoid-escape"]
+  valid-jsdoc: [1, {requireParamDescription: false, requireReturnDescription: false}]

.prettierignore

@@ -0,0 +1,2 @@
+package-lock.json
+package.json

.prettierrc

@@ -0,0 +1,2 @@
+singleQuote: true
+printWidth: 120

History.md

@@ -1,4 +1,5 @@
-# 1.0.0 / 2018-07-17
+# Latest
+## 1.0.0 / 2018-07-17
 
 * Fixed API
 * Upgraded to Marked 0.4.0 #31
@@ -10,6 +11,8 @@
 * Docs: Usage with highlighting lib #6
 * Updated all packages
 
+# Previous
+
 ## 0.2.2 / 2018-01-09
 
 * update marked dependency to fix security issue

Makefile

@@ -1,23 +1,35 @@
+[![npm version][npm-badge]][npm-url]
+[![code style: prettier][prettier-badge]][prettier-url]
+[![metalsmith: core plugin][metalsmith-badge]][metalsmith-url]
+
+[![Known Vulnerabilities][snyk-badge]][synk-url]
 
 # metalsmith-markdown
 
-  A Metalsmith plugin to convert markdown files.
+A Metalsmith plugin to convert markdown files.
 
 ## Installation
 
-    $ npm install metalsmith-markdown
+```bash
+$ npm install metalsmith-markdown
+```
 
 ## CLI Usage
 
-  Install via npm and then add the `metalsmith-markdown` key to your `metalsmith.json` plugins with any [Marked](https://github.com/chjj/marked) options you want, like so:
+  Install via npm and then add the `metalsmith-markdown` key to your `metalsmith.json` plugins with any [Marked](https://github.com/markedjs/marked) options you want, like so:
 
 ```json
 {
   "plugins": {
     "metalsmith-markdown": {
-      "smartypants": true,
+      "pedantic": false,
       "gfm": true,
-      "tables": true
+      "tables": true,
+      "breaks": false,
+      "sanitize": false,
+      "smartLists": true,
+      "smartypants": false,
+      "xhtml": false
     }
   }
 }
@@ -32,13 +44,34 @@ var markdown = require('metalsmith-markdown');
 var highlighter = require('highlighter');
 
 metalsmith.use(markdown({
-  smartypants: true,
+  renderer: new myMarked.Renderer(),
+  highlight: function(code) {
+    return require('highlight.js').highlightAuto(code).value;
+  },
+  pedantic: false,
   gfm: true,
   tables: true,
-  highlight: highlighter()
+  breaks: false,
+  sanitize: false,
+  smartLists: true,
+  smartypants: false,
+  xhtml: false
 }));
 ```
 
+## History
+
+[History](./History.md#Latest)
+
 ## License
 
-  MIT
+MIT
+
+[npm-badge]: https://img.shields.io/npm/v/metalsmith-markdown.svg
+[npm-url]: https://www.npmjs.com/package/metalsmith-markdown
+[prettier-badge]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?longCache=true
+[prettier-url]: https://github.com/prettier/prettier
+[metalsmith-badge]: https://img.shields.io/badge/metalsmith-core_plugin-green.svg?longCache=true
+[metalsmith-url]: http://metalsmith.io
+[snyk-badge]: https://snyk.io/test/github/metalsmith/metalsmith-markdown/badge.svg
+[synk-url]: https://snyk.io/test/github/metalsmith/metalsmith-markdown

Readme.md

@@ -1,4 +1,3 @@
-
 var basename = require('path').basename;
 var debug = require('debug')('metalsmith-markdown');
 var dirname = require('path').dirname;
@@ -7,10 +6,14 @@ var join = require('path').join;
 var marked = require('marked');
 
 /**
- * Expose `plugin`.
+ * Check if a `file` is markdown.
+ *
+ * @param {String} file
+ * @return {Boolean}
  */
-
-module.exports = plugin;
+var markdown = function(file) {
+  return /\.md$|\.markdown$/.test(extname(file));
+};
 
 /**
  * Metalsmith plugin to convert markdown files.
@@ -19,14 +22,13 @@ module.exports = plugin;
  *   @property {Array} keys
  * @return {Function}
  */
-
-function plugin(options){
+var plugin = function(options) {
   options = options || {};
   var keys = options.keys || [];
 
-  return function(files, metalsmith, done){
+  return function(files, metalsmith, done) {
     setImmediate(done);
-    Object.keys(files).forEach(function(file){
+    Object.keys(files).forEach(function(file) {
       debug('checking file: %s', file);
       if (!markdown(file)) return;
       var data = files[file];
@@ -41,7 +43,7 @@ function plugin(options){
         data.contents = Buffer.from(str);
       } catch (err) {
         // node versions < (5.10 | 6)
-      data.contents = new Buffer(str);
+        data.contents = new Buffer(str);
       }
       keys.forEach(function(key) {
         if (data[key]) {
@@ -53,15 +55,7 @@ function plugin(options){
       files[html] = data;
     });
   };
-}
+};
 
-/**
- * Check if a `file` is markdown.
- *
- * @param {String} file
- * @return {Boolean}
- */
-
-function markdown(file){
-  return /\.md$|\.markdown$/.test(extname(file));
-}
+// Expose Plugin
+module.exports = plugin;

lib/index.js

@@ -6,6 +6,7 @@
   "license": "MIT",
   "main": "lib/index.js",
   "scripts": {
+    "pretest": "eslint --fix .",
     "test": "mocha test"
   },
   "dependencies": {
@@ -14,7 +15,11 @@
   },
   "devDependencies": {
     "assert-dir-equal": "^1.1.0",
+    "eslint": "^5.1.0",
+    "eslint-config-prettier": "^2.9.0",
+    "eslint-plugin-prettier": "^2.6.2",
     "metalsmith": "^2.3.0",
-    "mocha": "^5.2.0"
+    "mocha": "^5.2.0",
+    "prettier": "^1.13.7"
   }
 }

package-lock.json

@@ -1,32 +1,37 @@
+/* eslint-env mocha */
 
 var assert = require('assert');
 var equal = require('assert-dir-equal');
 var Metalsmith = require('metalsmith');
 var markdown = require('..');
 
-describe('metalsmith-markdown', function(){
-  it('should convert markdown files', function(done){
+describe('metalsmith-markdown', function() {
+  it('should convert markdown files', function(done) {
     Metalsmith('test/fixtures/basic')
-      .use(markdown({
-        smartypants: true
-      }))
-      .build(function(err){
+      .use(
+        markdown({
+          smartypants: true
+        })
+      )
+      .build(function(err) {
         if (err) return done(err);
         equal('test/fixtures/basic/expected', 'test/fixtures/basic/build');
         done();
       });
   });
 
-  it('should allow a "keys" option', function(done){
+  it('should allow a "keys" option', function(done) {
     Metalsmith('test/fixtures/keys')
-      .use(markdown({
-        keys: ['custom'],
-        smartypants: true
-      }))
-      .build(function(err, files){
+      .use(
+        markdown({
+          keys: ['custom'],
+          smartypants: true
+        })
+      )
+      .build(function(err, files) {
         if (err) return done(err);
         assert.equal('<p><em>a</em></p>\n', files['index.html'].custom);
         done();
       });
   });
-});
+});