chore: adding prettier and improving tooling

Author: JGAntunes

.eslintignore

@@ -0,0 +1 @@
+coverage

.eslintrc

@@ -0,0 +1,14 @@
+
+{
+  "env": {
+    "node": true,
+    "es6": true
+  },
+  "plugins": [
+    "prettier"
+  ],
+  "extends": [
+    "standard",
+    "plugin:prettier/recommended"
+  ]
+}

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "semi": false,
+  "singleQuote": true
+}

package-lock.json

@@ -4,9 +4,37 @@
   "description": "A libp2p compatible pubsub module of the pulsarcast system",
   "main": "src/index.js",
   "scripts": {
+    "fmt": "prettier --write '{,!(coverage)/**/}*.js' && eslint --fix .",
+    "fmt:ci": "prettier -l '{,!(coverage)/**/}*.js'",
+    "lint": "eslint .",
     "test": "nyc --reporter=html --reporter=text mocha --recursive --exit",
-    "test:ci": "npm run lint && npm test",
-    "lint": "standard .  | snazzy"
+    "test:ci": "npm run lint && npm run fmt:ci && npm test"
+  },
+  "nyc": {
+    "exclude": [
+      "test/**",
+      "coverage/*",
+      "npm-debug.log",
+      ".nyc_output"
+    ],
+    "report-dir": "./coverage",
+    "cache": true,
+    "all": true,
+    "extension": [
+      ".js"
+    ]
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged && npm run test"
+    }
+  },
+  "lint-staged": {
+    "*.js": [
+      "eslint --fix",
+      "prettier --write",
+      "git add"
+    ]
   },
   "pre-commit": [
     "lint",
@@ -49,9 +77,17 @@
     "libp2p-spdy": "^0.13.1",
     "libp2p-tcp": "jgantunes/js-libp2p-tcp",
     "mocha": "^5.2.0",
-    "nyc": "^13.3.0",
-    "pre-commit": "^1.2.2",
-    "snazzy": "^7.1.1",
-    "standard": "^11.0.1"
+    "nyc": "^14.0.0",
+    "eslint": "^5.11.1",
+    "eslint-config-prettier": "^3.3.0",
+    "eslint-config-standard": "^12.0.0",
+    "eslint-plugin-import": "^2.14.0",
+    "eslint-plugin-node": "^8.0.0",
+    "eslint-plugin-prettier": "^3.0.1",
+    "eslint-plugin-promise": "^4.0.1",
+    "eslint-plugin-standard": "^4.0.0",
+    "husky": "^1.3.0",
+    "lint-staged": "^8.1.0",
+    "prettier": "^1.15.3"
   }
 }

package.json

@@ -6,13 +6,10 @@ const dagCBOR = require('ipld-dag-cbor')
 const CID = require('cids')
 
 const config = require('../config')
-const {
-  linkUnmarshalling,
-  linkMarshalling
-} = require('./utils')
+const { linkUnmarshalling, linkMarshalling } = require('./utils')
 
 class EventNode {
-  constructor (topicCID, author, payload, options = {}) {
+  constructor(topicCID, author, payload, options = {}) {
     // TODO check it is a CID maybe?
     assert(topicCID, 'Need a topicCID object to create an event node')
     assert(author, 'Need an author to create an event node')
@@ -27,9 +24,11 @@ class EventNode {
     this.metadata = createMetadata(options.metadata)
   }
 
-  static deserialize (event) {
+  static deserialize(event) {
     const topicCID = linkUnmarshalling(event.topic)
-    const publisher = event.publisher ? PeerId.createFromBytes(event.publisher) : null
+    const publisher = event.publisher
+      ? PeerId.createFromBytes(event.publisher)
+      : null
     const author = PeerId.createFromBytes(event.author)
     const payload = event.payload
     const parent = linkUnmarshalling(event.parent)
@@ -41,18 +40,18 @@ class EventNode {
     })
   }
 
-  static deserializeCBOR (event, cb) {
+  static deserializeCBOR(event, cb) {
     dagCBOR.util.deserialize(event, (err, result) => {
       if (err) return cb(err)
       cb(null, EventNode.deserialize(result))
     })
   }
 
-  get isPublished () {
+  get isPublished() {
     return Boolean(this.publisher)
   }
 
-  getReadableFormat () {
+  getReadableFormat() {
     return {
       topicCID: this.topicCID.toBaseEncodedString(),
       author: this.author.toB58String(),
@@ -64,11 +63,11 @@ class EventNode {
     }
   }
 
-  getCID (cb) {
+  getCID(cb) {
     dagCBOR.util.cid(this.serialize(), cb)
   }
 
-  serialize () {
+  serialize() {
     return {
       topic: linkMarshalling(this.topicCID),
       publisher: this.isPublished ? this.publisher.toBytes() : null,
@@ -82,13 +81,13 @@ class EventNode {
     }
   }
 
-  serializeCBOR (cb) {
+  serializeCBOR(cb) {
     const serialized = this.serialize()
     dagCBOR.util.serialize(serialized, cb)
   }
 }
 
-function createMetadata ({
+function createMetadata({
   created = new Date(),
   protocolVersion = config.protocol
 } = {}) {

src/dag/event-node.js

@@ -7,7 +7,7 @@ const log = require('../utils/logger')
 // TODO right now memory usage grows indefinitely
 class EventTree {
   // TODO probably need access to the DHT?
-  constructor (topicNode) {
+  constructor(topicNode) {
     // TODO check it is a CID maybe?
     assert(topicNode, 'Need a topicNode object to create an event tree')
     log.trace(`New event tree for topic ${topicNode.name}`)
@@ -21,24 +21,22 @@ class EventTree {
     })
   }
 
-  addNew (eventNode, options, cb) {
+  addNew(eventNode, options, cb) {
     const done = cb || options
-    const {parent} = options
+    const { parent } = options
     const eventLinking = this.topicNode.metadata.eventLinking
 
     if (eventLinking === 'custom' && !parent) {
       return done(new Error('Event requires custom parent to be provided'))
     }
 
     // Set the parent link
-    eventNode.parent = eventLinking === 'custom'
-      ? parent
-      : this.mostRecent
+    eventNode.parent = eventLinking === 'custom' ? parent : this.mostRecent
 
     this.add(eventNode, done)
   }
 
-  add (eventNode, cb) {
+  add(eventNode, cb) {
     eventNode.getCID((err, eventCID) => {
       if (err) return cb(err)
 
@@ -59,14 +57,13 @@ class EventTree {
     })
   }
 
-  get (eventCID) {
+  get(eventCID) {
     return this.eventTree.get(eventCID.toBaseEncodedString())
   }
 
   // TODO to should be optional and could be a CID or a number
   // defaults to 1 level of resolution
-  resolve (fromCID, to) {
-  }
+  resolve(fromCID, to) {}
 }
 
 module.exports = EventTree

src/dag/event-tree.js

@@ -6,14 +6,12 @@ const dagCBOR = require('ipld-dag-cbor')
 const CID = require('cids')
 
 const config = require('../config')
-const eventLinkTypes = require('../messages/protobuffers').TopicDescriptor.MetaData.EventLinking
-const {
-  linkUnmarshalling,
-  linkMarshalling
-} = require('./utils')
+const eventLinkTypes = require('../messages/protobuffers').TopicDescriptor
+  .MetaData.EventLinking
+const { linkUnmarshalling, linkMarshalling } = require('./utils')
 
 class TopicNode {
-  constructor (name, author, options = {}) {
+  constructor(name, author, options = {}) {
     assert(author, 'Need an author to create a topic node')
 
     this.name = name
@@ -23,19 +21,21 @@ class TopicNode {
     this.parent = options.parent ? new CID(options.parent) : null
     if (options.subTopics) {
       this.subTopics = Object.entries(options.subTopics)
-        .map(([name, topicB58Str]) => ({[name]: new CID(topicB58Str)}))
-        .reduce((topics, topic) => ({...topic, ...topics}), {})
+        .map(([name, topicB58Str]) => ({ [name]: new CID(topicB58Str) }))
+        .reduce((topics, topic) => ({ ...topic, ...topics }), {})
     }
 
     this.metadata = createMetadata(options.metadata)
   }
 
-  static deserialize (topic) {
+  static deserialize(topic) {
     const author = PeerId.createFromBytes(topic.author)
     const parent = linkUnmarshalling(topic.parent)
-    const subTopics = Object.entries(topic['#']).map(([name, dagLink]) => {
-      return {[name]: linkUnmarshalling(dagLink)}
-    }).reduce((topics, topic) => ({...topic, ...topics}), {})
+    const subTopics = Object.entries(topic['#'])
+      .map(([name, dagLink]) => {
+        return { [name]: linkUnmarshalling(dagLink) }
+      })
+      .reduce((topics, topic) => ({ ...topic, ...topics }), {})
 
     return new TopicNode(topic.name, author, {
       subTopics,
@@ -44,14 +44,14 @@ class TopicNode {
     })
   }
 
-  static deserializeCBOR (topic, cb) {
+  static deserializeCBOR(topic, cb) {
     dagCBOR.util.deserialize(topic, (err, result) => {
       if (err) return cb(err)
       cb(null, TopicNode.deserialize(result))
     })
   }
 
-  getReadableFormat () {
+  getReadableFormat() {
     const allowedPublishers = Array.isArray(this.metadata.allowedPublishers)
       ? this.metadata.allowedPublishers.map(p => p.toB58String())
       : this.metadata.allowedPublishers
@@ -70,40 +70,44 @@ class TopicNode {
     }
   }
 
-  getCID (cb) {
+  getCID(cb) {
     dagCBOR.util.cid(this.serialize(), cb)
   }
 
-  serialize () {
+  serialize() {
     return {
       name: this.name,
       author: this.author.toBytes(),
       parent: linkMarshalling(this.parent),
-      '#': Object.entries(this.subTopics).map(([name, cid]) => {
-        return {[name]: linkMarshalling(cid)}
-      }).reduce((topics, topic) => ({...topic, ...topics}), {}),
+      '#': Object.entries(this.subTopics)
+        .map(([name, cid]) => {
+          return { [name]: linkMarshalling(cid) }
+        })
+        .reduce((topics, topic) => ({ ...topic, ...topics }), {}),
       metadata: serializeMetadata(this.metadata)
     }
   }
 
-  serializeCBOR (cb) {
+  serializeCBOR(cb) {
     const serialized = this.serialize()
     dagCBOR.util.serialize(serialized, cb)
   }
 }
 
-function serializeMetadata (metadata) {
-  const allowedPublishers = {enabled: false, peers: []}
+function serializeMetadata(metadata) {
+  const allowedPublishers = { enabled: false, peers: [] }
   if (metadata.allowedPublishers) {
     allowedPublishers.enabled = true
-    allowedPublishers.peers = metadata.allowedPublishers.map((peer) => peer.toBytes())
+    allowedPublishers.peers = metadata.allowedPublishers.map(peer =>
+      peer.toBytes()
+    )
   }
 
-  const requestToPublish = {enabled: false, peers: []}
+  const requestToPublish = { enabled: false, peers: [] }
   if (metadata.requestToPublish) {
     requestToPublish.enabled = true
     requestToPublish.peers = Array.isArray(metadata.requestToPublish)
-      ? metadata.requestToPublish.map((peer) => peer.toBytes())
+      ? metadata.requestToPublish.map(peer => peer.toBytes())
       : []
   }
 
@@ -116,15 +120,22 @@ function serializeMetadata (metadata) {
   }
 }
 
-function deserializeMetadata (metadata) {
+function deserializeMetadata(metadata) {
   const allowedPublishers = metadata.allowedPublishers.enabled
-    ? metadata.allowedPublishers.peers.map((peer) => PeerId.createFromBytes(peer))
+    ? metadata.allowedPublishers.peers.map(peer => PeerId.createFromBytes(peer))
     : false
 
   let requestToPublish
   if (!metadata.requestToPublish.enabled) requestToPublish = false
-  if (metadata.requestToPublish.enabled && !metadata.requestToPublish.peers.length) requestToPublish = true
-  else requestToPublish = metadata.requestToPublish.peers.map((peer) => PeerId.createFromBytes(peer))
+  if (
+    metadata.requestToPublish.enabled &&
+    !metadata.requestToPublish.peers.length
+  )
+    requestToPublish = true
+  else
+    requestToPublish = metadata.requestToPublish.peers.map(peer =>
+      PeerId.createFromBytes(peer)
+    )
 
   return {
     ...metadata,
@@ -136,7 +147,7 @@ function deserializeMetadata (metadata) {
   }
 }
 
-function createMetadata ({
+function createMetadata({
   allowedPublishers = false,
   requestToPublish = true,
   eventLinking = 'LAST_SEEN',