ac-custom-error 0.1.0

package/.acsemver

@@ -0,0 +1,9 @@
+module.exports = {
+  repository: {
+    url: 'https://github.com/admiralcloud/ac-custom-error'
+  },
+  changelogFile: __dirname + '/CHANGELOG.md',
+  sections: [
+    { name: 'App' }
+  ],
+}

package/.eslintrc.js

@@ -0,0 +1,28 @@
+const config = {
+  root: true,
+  'env': {
+    'commonjs': true,
+    'es6': true,
+    'node': true
+  },
+  'extends': 'eslint:recommended',
+  "rules": {
+    "space-before-function-paren": 0,
+    "no-extra-semi": 0,
+    "object-curly-spacing": ["error", "always"],
+    "brace-style": ["error", "stroustrup", { "allowSingleLine": true }],
+    "no-useless-escape": 0,
+    "standard/no-callback-literal": 0,
+    "new-cap": 0,
+    "no-console": ["error", { allow: ["error"] }]
+  },
+  'parserOptions': {
+    'ecmaVersion': 2022
+  },
+  globals: {
+    describe: true,
+    it: true
+  }
+}
+
+module.exports = config

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

@@ -0,0 +1,29 @@
+# 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, develop ]
+  pull_request:
+    branches: [ master, develop ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+    
+    - run: yarn install
+    - run: yarn run test

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+<a name="0.1.0"></a>
+ 
+# [0.1.0](https://github.com/admiralcloud/ac-custom-error/compare/..v0.1.0) (2023-03-10 13:45:10)
+
+
+### Feature
+
+* **App:** Initial version | MP | [3cc542e6e22fbda35f964e557fbadaaf622e24e1](https://github.com/admiralcloud/ac-custom-error/commit/3cc542e6e22fbda35f964e557fbadaaf622e24e1)    
+Initial version

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 AdmiralCloud
+
+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,17 @@
+MOCHA_OPTS= --slow 0 -A
+REPORTER = spec
+
+lint-fix:
+	./node_modules/.bin/eslint --fix index.js test.js
+
+lint-check:
+	./node_modules/.bin/eslint index.js test.js
+
+commit:
+	@node ./node_modules/ac-semantic-release/lib/commit.js
+
+release:
+	@node ./node_modules/ac-semantic-release/lib/release.js
+
+
+.PHONY: check

package/README.md

@@ -0,0 +1,27 @@
+# AC-Custom-Error
+Extend the NodeJS error with an error code and additional information.
+
+[![Node.js CI](https://github.com/AdmiralCloud/ac-custom-error/actions/workflows/node.js.yml/badge.svg)](https://github.com/AdmiralCloud/ac-custom-error/actions/workflows/node.js.yml)
+
+# Usage
+```
+const ACError = require('ac-custom-error')
+
+throw new ACError('myError', 123, { id: 333 })
+
+// OUTPUT 
+ACError: myError
+    at STACK
+  code: 123,
+  errorMessage: 'myError',
+  additionalInfo: { id: 333 }
+}
+
+```
+
+
+# Links
+- [Website](https://www.admiralcloud.com/)
+
+# License
+[MIT License](https://opensource.org/licenses/MIT) Copyright © 2009-present, AdmiralCloud AG, Mark Poepping

package/index.js

@@ -0,0 +1,19 @@
+class ACError extends Error {
+  constructor(message, code, additionalInfo = {}) {
+    super(message)
+    
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, ACError)
+    }
+    // info
+    this.code = code || -1
+    this.errorMessage = message
+    // show other properties of options object
+    if (Object.keys(additionalInfo).length) {
+      this.additionalInfo = additionalInfo
+    }
+  }
+}
+
+
+module.exports = ACError

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "ac-custom-error",
+  "version": "0.1.0",
+  "description": "Custom NodeJS error with error code and additional info",
+  "main": "index.js",
+  "repository": "https://github.com/AdmiralCloud/ac-custom-error",
+  "author": "Mark Poepping (www.admiralcloud.com)",
+  "license": "MIT",
+  "devDependencies": {
+    "ac-semantic-release": "^0.3.4",
+    "chai": "^4.3.7",
+    "eslint": "^8.32.0",
+    "mocha": "^10.2.0",
+    "nyc": "^15.1.0"
+  },
+  "scripts": {
+    "test": "mocha --reporter spec",
+    "coverage": "nyc yarn run test"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}

package/test.js

@@ -0,0 +1,42 @@
+const { expect } = require('chai')
+
+const ACError = require('./index')
+
+const errorFunction = ({ message, code, additionalInfo }) => {
+  throw new ACError(message, code, additionalInfo)
+}
+
+
+describe('Run tests', () => {
+
+  it('Check error code', () => {
+    let errorParams = { message: 'myError', code: 123 }
+    let error
+    try {
+      errorFunction(errorParams)
+    }
+    catch (err) {
+      error = err
+    }
+    expect(error).to.be.an('Error')
+    expect(error.message).to.equal(errorParams.message)
+    expect(error.code).to.equal(errorParams.code)
+  })
+
+  it('Check error code and additionalInfo', () => {
+    let errorParams = { message: 'myError', code: 123, additionalInfo: { id: 333 } }
+    let error
+    try {
+      errorFunction(errorParams)
+    }
+    catch (err) {
+      error = err
+    }
+    expect(error).to.be.an('Error')
+    expect(error.message).to.equal(errorParams.message)
+    expect(error.code).to.equal(errorParams.code)
+    expect(error.additionalInfo.id).to.equal(errorParams.additionalInfo.id)
+  })
+
+})
+