Skip to content
Snippets Groups Projects
Commit d98ba3aa authored by Sigmund, Dominik's avatar Sigmund, Dominik
Browse files

Update package.json, README.md, .gitignore, .gitlab-ci.yml files

parent 71fab674
Branches
Tags
1 merge request!1Update index.test.js, examples/all-options.js, examples/log-to-file.js,...
node_modules
samples/file.log
coverage/
mochawesome-report/
.nyc_output/
\ No newline at end of file
stryker.log
*.DS_Store
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
# log.js
# log
[![pipeline status](https://it-devops-01.br-edv.brnet.int/general/log/badges/master/pipeline.svg)](https://it-devops-01.br-edv.brnet.int/general/log/commits/master)
[![coverage report](https://it-devops-01.br-edv.brnet.int/general/log/badges/master/coverage.svg)](https://it-devops-01.br-edv.brnet.int/general/log/commits/master)
[![Quality Gate Status](https://it-devops-01.br-edv.brnet.int:8999/api/project_badges/measure?project=argos.log&metric=alert_status)](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,6 +36,15 @@ 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'
}
......
{
"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"
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment