@knowark/loggarkjs 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Knowark
+
+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/Makefile

@@ -0,0 +1,20 @@
+help:
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | \
+	awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+install: ## Install the project's dependencies
+	npm install
+
+test: ## Run the project's tests
+	npm run test
+
+standard: ## Format the project's source code with StandardJS
+	npx standard --fix
+
+push: ## Push git repository with its tags
+	git push && git push --tags
+
+gitmessage: ## Add .gitmessage file as git commit template
+	touch .gitmessage
+	echo "\n# commit message\n.gitmessage" >> .gitignore
+	git config commit.template .gitmessage

package/README.md

@@ -0,0 +1,2 @@
+# loggark
+Utilitarian Logging Library

package/lib/index.js

@@ -0,0 +1 @@
+export { Logger } from './logger.js'

package/lib/logger.js

@@ -0,0 +1,26 @@
+export class Logger {
+  constructor ({ namespace = '', global = globalThis } = {}) {
+    const levels = ['error', 'warn', 'info', 'debug']
+    const logvar = [namespace, 'LOGLEVEL'].filter(
+      Boolean).join('_').toUpperCase().replaceAll(' ', '_')
+    const loglevel = String(global[logvar]).toLowerCase()
+    this.global = global
+    this.logindex = levels.indexOf(loglevel)
+  }
+
+  error (...args) {
+    if (this.logindex >= 0) this.global.console.error('[ERROR]', ...args)
+  }
+
+  warn (...args) {
+    if (this.logindex >= 1) this.global.console.warn('[WARN]', ...args)
+  }
+
+  info (...args) {
+    if (this.logindex >= 2) this.global.console.info('[INFO]', ...args)
+  }
+
+  debug (...args) {
+    if (this.logindex >= 3) this.global.console.debug('[DEBUG]', ...args)
+  }
+}

package/lib/logger.test.js

@@ -0,0 +1,69 @@
+import { describe, expect, it, beforeEach } from '@jest/globals'
+import { Logger } from './logger.js'
+
+const mockGlobal = {
+  console: {
+    error (...args) { mockGlobal.erroArgs = args },
+    warn (...args) { mockGlobal.warnArgs = args },
+    info (...args) { mockGlobal.infoArgs = args },
+    debug (...args) { mockGlobal.debugArgs = args }
+  }
+}
+
+describe('Logger', () => {
+  let mockGlobal = null
+
+  beforeEach(() => {
+    mockGlobal = {
+      console: {
+        error (...args) { mockGlobal.errorArgs = args },
+        warn (...args) { mockGlobal.warnArgs = args },
+        info (...args) { mockGlobal.infoArgs = args },
+        debug (...args) { mockGlobal.debugArgs = args }
+      }
+    }
+  })
+
+  it('can be instantiated', () => {
+    const logger = new Logger()
+    expect(logger).toBeTruthy()
+  })
+
+  it('can be instantiated', () => {
+    const logger = new Logger()
+    expect(logger).toBeTruthy()
+  })
+
+  it('is disabled by default', () => {
+    const logger = new Logger({ global: mockGlobal })
+
+    logger.error('Logging something...')
+    expect(mockGlobal.errorArgs).toBeFalsy()
+
+    logger.warn('Logging something...')
+    expect(mockGlobal.warnArgs).toBeFalsy()
+
+    logger.info('Logging something...')
+    expect(mockGlobal.infoArgs).toBeFalsy()
+
+    logger.debug('Logging something...')
+    expect(mockGlobal.debugArgs).toBeFalsy()
+  })
+
+  it('adds a prefix to the logging methods according to loglevel', () => {
+    mockGlobal.LOGLEVEL = 'debug'
+    const logger = new Logger({ global: mockGlobal })
+
+    logger.error('Logging something...')
+    expect(mockGlobal.errorArgs).toEqual(['[ERROR]', 'Logging something...'])
+
+    logger.warn('Logging something...')
+    expect(mockGlobal.warnArgs).toEqual(['[WARN]', 'Logging something...'])
+
+    logger.info('Logging something...')
+    expect(mockGlobal.infoArgs).toEqual(['[INFO]', 'Logging something...'])
+
+    logger.debug('Logging something...')
+    expect(mockGlobal.debugArgs).toEqual(['[DEBUG]', 'Logging something...'])
+  })
+})

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@knowark/loggarkjs",
+  "version": "0.1.0",
+  "description": "Utilitarian Logging Library",
+  "main": "./lib/index.js",
+  "type": "module",
+  "scripts": {
+    "options": "NODE_OPTIONS='--experimental-vm-modules --no-warnings'",
+    "test": "npm run options -- npx jest --coverage"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/knowark/loggarkjs.git"
+  },
+  "keywords": [
+    "logging",
+    "console"
+  ],
+  "author": "Knowark",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/knowark/loggarkjs/issues"
+  },
+  "homepage": "https://github.com/knowark/loggarkjs#readme",
+  "devDependencies": {
+    "jest": "^29.1.1"
+  }
+}