log-queue 0.0.3

package/.github/workflows/actions.yml

@@ -0,0 +1,32 @@
+name: GitHub Actions
+run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
+on: [push]
+jobs:
+  Explore-GitHub-Actions:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
+      - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
+      - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
+      - name: Check out repository code
+        uses: actions/checkout@v3
+      - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
+      - run: echo "🖥️ The workflow is now ready to test your code on the runner."
+      - name: List files in the repository
+        run: |
+          ls ${{ github.workspace }}
+      - run: echo "🍏 This job's status is ${{ job.status }}."
+Footer
+© 2023 GitHub, Inc.
+Footer navigation
+Terms
+Privacy
+Security
+Status
+Docs
+Contact GitHub
+Pricing
+API
+Training
+Blog
+About

package/.github/workflows/node.js.yml

@@ -0,0 +1,81 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+  workflow_dispatch: {}
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+
+    defaults:
+      run:
+        shell: bash
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        node-version: [8.x, 10.x, 12.x, 14.x, 16.x, 18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+        include:
+          - node-version: 8.x
+            npm-i: "eslint@6.x eslint-config-airbnb-base@14.x eslint-config-prettier@6.x eslint-plugin-prettier@3.x fs-extra@8.x nyc@14.x tap@14.x"
+
+          - node-version: 10.x
+            npm-i: "eslint@7.x fs-extra@9.x nyc@14.x tap@14.x"
+
+          - node-version: 12.x
+            npm-i: "nyc@14.x tap@14.x"
+
+          - node-version: 14.x
+            npm-i: "nyc@14.x tap@14.x"
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+
+    - name: Configure npm
+      run: npm config set loglevel error
+
+    - name: Get npm version
+      id: npm-version
+      run: |
+        npm -v
+        npmMajorVer=$(npm -v | cut -d. -f1)
+        echo "major=$npmMajorVer" >> $GITHUB_OUTPUT
+    - name: Disable prettier on older Node.js (8.x, 10.x, 12.x)
+      run: |
+        sed -i '/"prettier": "prettier/d' package.json
+      if: contains(fromJson('["8.x", "10.x", "12.x"]'), matrix.node-version)
+
+    - name: Install downgraded modules ${{ matrix.npm-i }}
+      run: |
+        npm install --save-dev ${{ matrix.npm-i }}
+        if [ ${{ steps.npm-version.outputs.major }} -le 5 ]; then
+          npm install
+        fi
+      if: matrix.npm-i != ''
+
+    - run: npm install
+      if: matrix.npm-i == '' && steps.npm-version.outputs.major <= 5
+
+    - run: npm ci
+      if: matrix.npm-i == '' && steps.npm-version.outputs.major > 5
+
+    - name: List dependencies
+      run: npm ls --depth=0 --dev && npm ls --depth=0 --prod
+
+    - run: npm run build --if-present
+    - run: npm run test_files
+    - run: npm run test_all

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 jman717
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,2 @@
+# log
+Logging mainly to console and log4js-tagline, but can certainly be used for generic logging. 

package/app.js

@@ -0,0 +1,78 @@
+/* @author Jim Manton: jrman@risebroadband.net
+* @since 2023-01-15
+* Main processing app
+*/
+
+let colors = require('colors')
+
+colors.setTheme({
+    silly: 'rainbow',
+    input: 'grey',
+    verbose: 'cyan',
+    prompt: 'grey',
+    info: 'green',
+    data: 'grey',
+    help: 'cyan',
+    warn: 'yellow',
+    debug: 'blue',
+    error: 'red',
+    success: 'green'
+});
+
+exports = module.exports = class LogQueue {
+    constructor(props) {
+        var t = this, fname = `LogQueue.constructor`
+        try {
+
+            t.parent = props.parent
+            t.relative_path = props.relative_path
+            t.exclude_logMsg = props.exclude_logMsg
+            t.resolve = props.resolve
+            t.reject = props.reject
+
+            t.init = t.init.bind(t)
+            t.logMsg = t.logMsg.bind(t)
+            t.logMsg({ msg: `${fname}`.debug, type: 'debug' })
+
+            return t
+        } catch (e) {
+            e.message = `${fname} error: ${e.message}`
+            throw (e)
+        }
+    }
+
+    init(props) {
+        var t = this, fname = `LogQueue.init`
+        try {
+            // t.base_queue = new base_queue({
+            //     parent: t,
+            //     relative_path: t.relative_path,
+            //     logMsg: t.logMsg,
+            //     resolve: t.resolve,
+            //     reject: t.reject
+            // }).load(props).process()
+            return t
+        } catch (e) {
+            e.message = `${fname} error: ${e.message}`
+            throw (e)
+        }
+    }
+
+    logMsg(props = {}) {
+        let t = this, fname = "log_queue.logMsg"
+        try {
+            if (typeof props.msg == "undefined")
+                throw new Error(`no msg property in (${JSON.stringify(props)}) `)
+            if (typeof props.type == "undefined")
+                throw new Error(`no type property in (${JSON.stringify(props)}) `)
+            if (typeof t.exclude_logMsg != "undefined")
+                if (t.exclude_logMsg.indexOf(props.type) > -1)
+                    return
+            console.log(props.msg)
+        } catch (e) {
+            e.message = `${fname} error: ${e.message}`
+            console.log(e.message)
+            throw e
+        }
+    }
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "author": {
+    "name": "Jim Manton"
+  },
+  "version": "0.0.3",
+  "bundleDependencies": [],
+  "dependencies": {
+    "@types/node": "^18.11.19",
+    "chai": "^4.3.7",
+    "colors": "^1.4.0",
+    "diffler": "^2.0.4",
+    "fs": "^0.0.1-security",
+    "mocha": "^10.2.0",
+    "valid-path": "^2.1.0"
+  },
+  "scripts": {
+    "start": "node app.ts",
+    "test": "mocha",
+    "ditched": "ditched -a",
+    "test_logs": "node ./tests/logs"
+  },
+  "keywords": [
+    "log",
+    "console",
+    "appenders",
+    "javascript",
+    "synchronous",
+    "objects",
+    "promises",
+    "mocha"
+  ],
+  "homepage": "https://github.com/jman717/file-obj-queue",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jman717/file-obj-queue.git"
+  },
+  "deprecated": false,
+  "description": "Logging",
+  "email": "jrman@risebroadband.net",
+  "license": "MIT",
+  "main": "app.js",
+  "name": "log-queue",
+  "start": "node app.js"
+}

package/test/app.js

@@ -0,0 +1,37 @@
+var assert = require('assert');
+
+describe('app', function () {
+    let app, application
+
+    it('app.constructor should pass', function () {
+        application = require('../app.js')
+        assert(app = new application())
+    })
+    
+    it('app.logMsg is a function', function () {
+        assert(typeof app.logMsg == 'function')
+    })
+        
+    it('app.getFileObject is a function', function () {
+        assert(typeof app.getFileObject == 'function')
+    })
+})
+
+describe('require', function () {
+
+    it('colors', function () {
+        assert(require('colors'))
+    })
+
+    it('base_queue', function () {
+        assert(require('../base_queue/app'))
+    })
+
+    it('fs', function () {
+        assert(require('fs'))
+    })
+    
+    it('valid-path', function () {
+        assert(require('valid-path'))
+    })
+})

package/test/package.js

@@ -0,0 +1,63 @@
+const assert = require('assert'),
+    jsonHasDifferences = require('diffler'),
+    packagejson = require('../package.json')
+
+const packageMock = {
+  "author": {
+    "name": "Jim Manton"
+  },
+  "version": "2.0.4",
+  "bundleDependencies": [],
+  "dependencies": {
+    "@types/node": "^18.11.19",
+    "chai": "^4.3.7",
+    "colors": "^1.4.0",
+    "diffler": "^2.0.4",
+    "fs": "^0.0.1-security",
+    "mocha": "^10.2.0",
+    "queuejson": "^9.0.11",
+    "typescript": "^4.9.5",
+    "valid-path": "^2.1.0"
+  },
+  "scripts": {
+    "start": "node app.ts",
+    "test": "mocha",
+    "ditched": "ditched -a",
+    "test_files": "node ./tests/files",
+    "test_all": "node ./tests/test_all"
+  },
+  "keywords": [
+    "queue",
+    "processing",
+    "appenders",
+    "javascript",
+    "synchronous",
+    "objects",
+    "promises",
+    "mocha"
+  ],
+  "homepage": "https://github.com/jman717/file-obj-queue",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jman717/file-obj-queue.git"
+  },
+  "deprecated": false,
+  "description": "Queue File Objects",
+  "email": "jrman@risebroadband.net",
+  "license": "MIT",
+  "main": "app.js",
+  "name": "file-obj-queue",
+  "start": "node app.js"
+}
+
+describe('package.json', function () {
+    it('should pass', function () {
+      const difference = jsonHasDifferences(packagejson, packageMock)
+      assert(JSON.stringify(difference) == "{}")
+    })
+
+    it('should fail', function () {
+        packageMock.version = '0'
+        assert(jsonHasDifferences(packagejson, packageMock))
+    })
+})

package/tests/logs.js

@@ -0,0 +1,7 @@
+var llog = require("../app.js"),
+  a = new llog({ parent: null })
+
+a.logMsg({ msg: "hello world".debug, type: "debug" })
+a.logMsg({ msg: "hello world".silly, type: "silly" })
+a.logMsg({ msg: "hello world".error, type: "error" })
+