diff --git a/.gitignore b/.gitignore index 1823973c12a7643dccd73111974696c0572706cc..2771490a5027cf8dc13e4960802f749751bda663 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,5 @@ -node_modules -samples/file.log -coverage/ -mochawesome-report/ -.nyc_output/ \ No newline at end of file +node_modules +samples/file.log +coverage/ +stryker.log +*.DS_Store diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 6588ee3ed6da17cb354eaef713a9d10e07afa567..ce58add837852dfaff30cba60291f8543c59092a 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,11 +1,17 @@ image: node:latest include: + - project: 'general/templates' + file: '/cicd/SAST-nodejs.gitlab-ci.yml' - project: 'general/templates' file: '/cicd/npm-audit.gitlab-ci.yml' - project: 'general/templates' file: '/cicd/sonarqube.gitlab-ci.yml' +variables: + SONAR_PROJECT_KEY: argos-log + SONAR_TOKEN: 11922a8e774494f51e1d2f0e695949e4073e7df8 + cache: paths: @@ -14,6 +20,7 @@ cache: stages: - build - test + - quality build: stage: build @@ -29,6 +36,4 @@ test: artifacts: paths: - docs/test-report.html - - docs/junit.xml - reports: - junit: docs/junit.xml + - docs/coverage/lcov.info diff --git a/README.md b/README.md index d8f2983ef981bdf0a088e92a742294d6a3a81604..6a92f9159e5464e33a63675211636375575a0b8a 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,21 @@ -# log.js +# log + + +[](https://it-devops-01.br-edv.brnet.int/general/log/commits/master) +[](https://it-devops-01.br-edv.brnet.int/general/log/commits/master) +[](https://it-devops-01.br-edv.brnet.int:8999/dashboard?id=argos-log) A real simple logger application. -May Optional Log to A File. +May Optional Log to A File and a graylog-server. ## Installation -`npm install --save git+https://gitclone:B7S-aYmLSxsHxkBe2rsV@it-devops-01.br-edv.brnet.int/argos/log.git` + +- `npm config set @br:registry https://it-devops-01:4873` +- `npm install --save @br/config` ## Usage -`const Log = require('log')` +`const Log = require('@br/log')` `let log = new Log(options)` Note: The options Part may be omitted, as all parts are optional, but using the name is recommended, as without it, the package-name will be used @@ -29,7 +36,16 @@ Note: The options Part may be omitted, as all parts are optional, but using the name: 'Name of App. Default: Name of BaseFolder', hostname: 'Server Hostname, Default: os.hostname()', file: 'File to Append Log to', + graylog: { + active: 'true or false', + servers: [ + { + server: 'graylog-server', + port: 'graylog-port' + } + ] + }, path: 'Path Logfile located', loglevel: 'Minimal LogLevel. Default: WARN' } -``` \ No newline at end of file +``` diff --git a/package.json b/package.json index 019a3948bab1550f8a2b13a1b51f93573adea623..26885e79db0286a52a37c4583dcd1ba0120c7c5e 100644 --- a/package.json +++ b/package.json @@ -1,21 +1,30 @@ { - "name": "lib-log", + "name": "@br/log", "version": "2.0.0", "description": "A simple Logger with Options!", "main": "index.js", "scripts": { "test": "jest tests/index.test.js", - "test-coverage": "nyc --reporter=html --reporter=text mocha -- tests/test.js && rsync --remove-source-files -av --progress ./coverage ./docs/ && rm -Rf ./coverage", - "test-graphics": "nyc --reporter=html --reporter=text mocha -R mochawesome -- tests/test.js && rsync --remove-source-files -av --progress ./coverage ./docs/ && rm -Rf ./coverage && rsync --remove-source-files -av --progress ./mochawesome-report ./docs/ && rm -Rf ./mochawesome-report" + "sonarqube": "sonar-scanner -Dsonar.projectKey=argos-log -Dsonar.sources=. -Dsonar.host.url=https://it-devops-01.br-edv.brnet.int:8999 -Dsonar.login=gitlab" }, "author": "Dominik Sigmund <sigmund.dominik@googlemail.com> (https://webdad.eu)", "license": "ISC", "repository": { "type": "git", - "url": "https://it-devops-01.br-edv.brnet.int/argos/log" + "url": "https://it-devops-01.br-edv.brnet.int/general/log" }, "dependencies": {}, "devDependencies": { "jest": "^24.9.0" - } + }, + "jest": { + "collectCoverage": true, + "coverageReporters": [ + "json", + "lcov", + "text", + "clover", + "html" + ], + "coverageDirectory": "docs/coverage" }