@beauraines/node-helpers 2.0.1 → 2.1.0

package/.github/workflows/publish.yaml

@@ -0,0 +1,54 @@
+name: 'Publish to NPM'
+
+on:
+  workflow_run:
+    workflows: ['Node.js CI']
+    types: [completed]
+    branches: [master,main]
+
+jobs:
+  publish-new-version:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: '0'
+      - name: git setup
+        run: |
+          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+      - name: setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          registry-url: 'https://registry.npmjs.org'
+      - name: npm install
+        run: npm ci
+
+      - name: Should release
+        id: should_release
+        continue-on-error: true
+        run: npm run should-release -- -v
+
+      - name: No release
+        if: steps.should_release.outcome != 'success'
+        run: echo "No release required. Skipping publishing."
+
+      - name: Version bump
+        if: steps.should_release.outcome == 'success'
+        run: npm run release
+
+      - name: Publish to NPM
+        if: steps.should_release.outcome == 'success'
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Push commits to GitHub
+        if: steps.should_release.outcome == 'success'
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.ref }}
+          tags: true

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## [2.1.0](https://github.com/beauraines/node-helpers/compare/v1.1.0...v2.1.0) (2023-03-01)
+
+
+### Features
+
+* Adds sparkline helper ([#6](https://github.com/beauraines/node-helpers/issues/6)) ([74accc3](https://github.com/beauraines/node-helpers/commit/74accc3ef2731809987210f39e45d1fd1c71e6ba))

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@beauraines/node-helpers",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Collection of node helpers",
   "main": "index.js",
   "scripts": {
-    "test": "jest"
+    "test": "jest",
+    "release": "standard-version",
+    "should-release": "should-release"
   },
   "author": "beau.raines@gmail.com",
   "license": "ISC",
@@ -12,12 +14,15 @@
     "@azure/storage-queue": "^12.11.0",
     "azure-storage": "^2.10.7",
     "node-fetch": "^2.6.7",
+    "sparkly": "^5.0.0",
     "sqlite": "^4.1.2",
     "sqlite3": "^5.1.2"
   },
   "devDependencies": {
     "eslint": "^8.27.0",
     "eslint-plugin-jest": "^27.2.1",
-    "jest": "^29.3.1"
+    "jest": "^29.3.1",
+    "should-release": "^1.2.0",
+    "standard-version": "^9.5.0"
   }
 }

package/src/helpers.js

@@ -1,4 +1,5 @@
 const fs = require('fs');
+const sparkly = require('sparkly')
 
 /**
  * Converts a string to Title Case, using whitespace as the delimiter
@@ -95,12 +96,38 @@ function getEpochMillis() {
   return Date.now()
 }
 
+// TODO Add unit test
+// Expected output last 30 days [1,5] ▁▂▄▆█ 5 from [1,2,3,4,5]
+/**
+ * Generates a sparkline with labels
+ * 
+ * @param {array} data Array of values to plot in the sparkline
+ * @param {string} label Text to display before sparkline
+ * @param {object} options Optional options for display, e.g display min,max,last, range coercion
+ * @returns 
+ */
+function sparkline(data,label,options) {
+  // TODO add handling if data is object
+  // let open = last30days.map( x=> x.open_count)
+
+  // Assuming data is array
+  const minValue = Math.min(...data)
+  const maxValue = Math.max(...data)
+  const lastValue = data.slice(-1)[0]
+
+  // coerces the minimum value to zero because the mimimum option is only used for range validation, 
+  // not display https://github.com/sindresorhus/sparkly/blob/9e33eaff891c41e8fb8c8883f62e9821729a9882/index.js#L15
+  // sparkly(open,{minimum:27,maximum:50})
+  return `${label} [${minValue},${maxValue}] ${sparkly(data.map( x=> x- minValue))} ${lastValue}`
+}
+
 module.exports = {
     getEpochMillis,
     fileExists,
     groupAndSum,
     readFile,
     listFiles,
+    sparkline,
     stripNewLines,
     toTitleCase,
     unixTimestamp

package/src/helpers.test.js

@@ -1,9 +1,21 @@
 const helper = require('./helpers');
 
-it('should return a title case string',() => {
-    const lowerString = 'a quick brown fox';
-    const titleString = 'A Quick Brown Fox';
+describe('helpers',()=> {
+    it('should return a title case string',() => {
+        const lowerString = 'a quick brown fox';
+        const titleString = 'A Quick Brown Fox';
+    
+        expect(helper.toTitleCase(lowerString)).toBe(titleString);
+    })
+
+    it('should return the correctly sparkline',()=>{
+        const expectedOutput = 'last 30 days [1,5] ▁▂▄▆█ 5'
+        const input = [1,2,3,4,5]
+        const label = 'last 30 days'
+        expect(helper.sparkline(input,label)).toBe(expectedOutput)
+
+    })
+
 
-    expect(helper.toTitleCase(lowerString)).toBe(titleString);
 })