fix: formatting, documentation, add ci, tests (#6)

* Replace eslintrc with xo

* Apply xo formatting


Apply markdown formatting guidelines

* Add configurations

semantic-release config
circleci config
codecov.yml config
mocha debug configurations for vscode

* Add initial code coverage

* Add circleci build badge to readme

Author: erodewald

.circleci/config.yml

@@ -0,0 +1,62 @@
+version: 2.1
+
+orbs:
+  codecov: codecov/[email protected]
+
+references:
+  attach_workspace: &attach_workspace
+    attach_workspace:
+      at: ~/repo
+  persist_to_workspace: &persist_to_workspace
+    persist_to_workspace:
+      root: ~/repo
+      paths: .
+
+executors:
+  arwen:
+    docker:
+      - image: circleci/node:10.15.1
+    working_directory: ~/repo
+
+jobs:
+  build:
+    executor: arwen
+    steps:
+      - *attach_workspace
+      - checkout
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "package.json" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+      - run: npm install
+      - save_cache:
+          paths:
+            - node_modules
+          key: v1-dependencies-{{ checksum "package.json" }}
+      - run: npm test
+      - codecov/upload:
+          file: .nyc_output/*.json
+      - *persist_to_workspace
+  publish:
+    executor: arwen
+    steps:
+      - *attach_workspace
+      - checkout
+      - run: npm run semantic-release
+
+workflows:
+  build:
+    jobs:
+      - build:
+          filters:
+            branches:
+              only: /.*/
+      - publish:
+          context: pi
+          requires:
+            - build
+          filters:
+            branches:
+              only: master

.eslintrc.js

@@ -0,0 +1,33 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+      {
+          "type": "node",
+          "request": "launch",
+          "name": "Mocha All",
+          "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+          "args": [
+              "--timeout",
+              "999999",
+              "--colors",
+              "${workspaceFolder}/test"
+          ],
+          "console": "integratedTerminal",
+          "internalConsoleOptions": "neverOpen"
+      },
+      {
+          "type": "node",
+          "request": "launch",
+          "name": "Mocha Current File",
+          "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+          "args": [
+              "--timeout",
+              "999999",
+              "--colors",
+              "${file}"
+          ],
+          "console": "integratedTerminal",
+          "internalConsoleOptions": "neverOpen"
+      }
+    ]
+  }

.vscode/launch.json

@@ -1,10 +1,8 @@
-# Javascript DynamoDB Context Store 
+# Javascript DynamoDB Context Store
 
-Used by the [SmartApp SDK](https://github.com/SmartThingsCommunity/smartapp-sdk-nodejs) to store IDs and access tokens for an installed instance of a SmartApp
-and retrieves that information for use in asynchronous API calls. The use of a context store
-is only needed when SmartApps have to call the SmartThings API in response to external
-events. SmartApps that only response to lifecycle events from the SmartThings platform
-will automatically have the proper context without the app having to store it. 
+[![CircleCI](https://circleci.com/gh/SmartThingsCommunity/dynamodb-context-store-nodejs/tree/master.svg?style=svg)](https://circleci.com/gh/SmartThingsCommunity/dynamodb-context-store-nodejs/tree/master)
+
+Used by the [SmartApp SDK](https://github.com/SmartThingsCommunity/smartapp-sdk-nodejs) to store IDs and access tokens for an installed instance of a SmartApp and retrieves that information for use in asynchronous API calls. The use of a context store is only needed when SmartApps have to call the SmartThings API in response to external events. SmartApps that only response to lifecycle events from the SmartThings platform will automatically have the proper context without the app having to store it.
 
 The context stored by this module consists of the following data elements:
 
@@ -17,20 +15,23 @@ The context stored by this module consists of the following data elements:
 _Note: Version 2.X.X is a breaking change to version 1.X.X as far as configuring the context store is
 concerned, but either one can be used with any version of the SmartThings SDK._
 
-## Installation:
-```
+## Installation
+
+```bash
 npm install @smartthings/dynamodb-context-store
 ```
 
 ## Usage
 
 Create a `DynamoDBContextStore` object and pass it to the SmartApp connector to store the context in a table 
 named `"smartapp"` in the `us-east-1` AWS region. If the table does not exist it will be created.
+
 ```javascript
 smartapp.contextStore(new DynamoDBContextStore())
 ```
 
 The more extensive set of options are shown in this example:
+
 ```javascript
 smartapp.contextStore(new DynamoDBContextStore(
     {
@@ -48,6 +49,7 @@ smartapp.contextStore(new DynamoDBContextStore(
 ```
 
 The **table** configuration options are:
+
 * **name** -- The name of the DynamoDB table storing the context
 * **hashKey** -- The name of the partition key of the table
 * **prefix** -- A string pre-pended to the installed app ID and used as the partition key for the entry
@@ -56,6 +58,7 @@ The **table** configuration options are:
 * **sortKey** -- Optional sort key definition (see below for more details)
 
 Other configuration options are:
+
 * **AWSRegion** -- The AWS region containing the table
 * **AWSConfigPath** -- The location of the AWS configuration JSON file
 * **AWSConfigJSON** -- The AWS credentials and region
@@ -67,6 +70,7 @@ Note that only one of the AWS options should be specified or behavior will be in
 
 By default, the AWS credentials are picked up from the environment. If you prefer you can read the credentials
 from a file with this configuration:
+
 ```javascript
 smartapp.contextStore(new DynamoDBContextStore(
     {
@@ -75,8 +79,8 @@ smartapp.contextStore(new DynamoDBContextStore(
 ))
 ```
 
-
 You can also explicitly set the credentials in this way:
+
 ```javascript
 smartapp.contextStore(new DynamoDBContextStore(
     {
@@ -87,11 +91,13 @@ smartapp.contextStore(new DynamoDBContextStore(
         }
     }
 ))
-````
+```
 
 ### Sort Key Configuration
+
 In order to support single table schemas, the context store can be configured to use a table with a sort key.
 The simplest way to do that is by specifying the sort key name:
+
 ```javascript
 smartapp.contextStore(new DynamoDBContextStore(
     {
@@ -102,10 +108,11 @@ smartapp.contextStore(new DynamoDBContextStore(
         }
     }
 ))
-
 ```
+
 More control over the sort key can be exercised using this form, which is configured with the default values
 used when just the sort key name is specified:
+
 ```javascript
 smartapp.contextStore(new DynamoDBContextStore(
     {
@@ -121,5 +128,4 @@ smartapp.contextStore(new DynamoDBContextStore(
         }
     }
 ))
-
 ```

README.md

@@ -0,0 +1,8 @@
+ignore:
+  - "[docs|doc]/**/*"  # ignore docs
+  - "[config|]/**/*" # ignore configs
+  - "*.md" # ignore markdown
+
+parsers:
+  javascript:
+    enable_partials: yes

config/codecov.yml

@@ -0,0 +1,14 @@
+module.exports = {
+	plugins: [
+		'@semantic-release/commit-analyzer',
+		'@semantic-release/release-notes-generator',
+		['@semantic-release/changelog', {
+			changelogFile: 'docs/CHANGELOG.md'
+		}],
+		'@semantic-release/npm',
+		['@semantic-release/git', {
+			assets: ['docs', 'package.json'],
+			message: 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}'
+		}]
+	]
+}

config/release.config.js

@@ -1,3 +1,3 @@
-'use strict';
+'use strict'
 
-module.exports = require('./lib/DynamoDBContextStore')
+module.exports = require('./lib/dynamodb-context-store')