housekeeping

.github/dependabot.yml

@@ -1,11 +1,9 @@
-# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
 version: 2
 updates:
   - package-ecosystem: "npm"
     directory: "/"
     schedule:
-      interval: "daily"
+      interval: "weekly"
     assignees:
       - "octocat"
     commit-message:
@@ -14,7 +12,7 @@ updates:
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "daily"
+      interval: "weekly"
     assignees:
       - "octocat"
     commit-message:

README.md

@@ -1,6 +1,6 @@
 # mcp300X
 
-Implemntation of the mcp3004/mcp3008 ADC chip.
+Implementation of the mcp3004/mcp3008 ADC chip.
 
 [![npm Version](https://img.shields.io/npm/v/@johntalton/mcp300x.svg)](https://www.npmjs.com/package/@johntalton/mcp300x)
 ![GitHub package.json version](https://img.shields.io/github/package-json/v/johntalton/mcp300x)
@@ -11,25 +11,25 @@ Implemntation of the mcp3004/mcp3008 ADC chip.
 [![Package Quality](https://npm.packagequality.com/shield/%40johntalton%2Fmcp300x.svg)](https://packagequality.com/#?package=@johntalton/mcp300x)
 
 Features:
-- Provides access to pseudo differential mode 
+- Provides access to pseudo differential mode
 - Does not assume Vref and Vin are the same
 
 And while this implementation is more verbose, it does so in order to aid in clarity of understanding and for learning.
 
 ## Sample Usage
 
 ```javascript
-const cp300X = require('@johntalton/mcp300X');
+import { mcp300x } = from '@johntalton/mcp300X'
 const spi = ...
+const adc = mcp300X.from({ bus: spi, Vref: 5, channels: 8 })
 
-const adc = await mcp300X.adc({ bus: spi, Vref: 5, channels: 8 })
 const result = await dev.readADC(channel)
 
 console.log('normalized value', result.normal)
 console.log('voltage', result.V)
 ```
 
-In the usage above our Analog circitry is running at 5V, while the chip is running at 3.3V configuration.  
+In the usage above our Analog circuitry is running at 5V, while the chip is running at 3.3V configuration.
 
 The returned ```result``` object holds the ```normal```-ized value, as well as the ```raw``` ADC value and the ```V``oltage as calculated.
 
@@ -53,6 +53,6 @@ From the spec:
 
 ```
   ...
-  dev.readADCDiff(6).then(result => { ... }) // index-channel 6 or +Ch5 / -Ch4 
+  dev.readADCDiff(6).then(result => { ... }) // index-channel 6 or +Ch5 / -Ch4
 ```
 

package.json

@@ -1,10 +1,11 @@
 {
   "name": "@johntalton/mcp300X",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "",
+  "type": "module",
   "main": "src/mcp300X.js",
   "scripts": {
-    "lint": "./node_modules/.bin/eslint ."
+    "lint": "eslint ."
   },
   "repository": {
     "type": "git",
@@ -15,7 +16,35 @@
   "dependencies": {
   },
   "devDependencies": {
-    "eslint": "^7.3.1",
-    "mqtt": "^4.1.0"
+    "eslint": "^8.0.0",
+    "mqtt": "^5.5.0",
+    "@johntalton/eslint-config": "github:johntalton/eslint-config"
+  },
+  "eslintConfig": {
+    "extends": [
+      "eslint:recommended",
+      "@johntalton/eslint-config/es"
+    ],
+    "parserOptions": {
+      "ecmaVersion": "latest",
+      "sourceType": "module"
+    },
+    "env": {
+      "es6": true
+    },
+    "ignorePatterns": [
+      "test/**",
+      "examples/**/*"
+    ],
+    "rules": {
+      "no-magic-numbers": "off",
+      "semi": "warn",
+      "max-len": [
+        "error",
+        {
+          "code": 120
+        }
+      ]
+    }
   }
 }