@aicore/libcache - npm Package Compare versions

Comparing version 1.0.12 to 1.0.13

package.json

		{
		"name": "@aicore/libcache",
		"version": "1.0.12",
		"version": "1.0.13",
		"description": "Cache library for core.ai services",
		@@ -43,3 +43,3 @@ "main": "index.js",
		},
		"author": "Arun, core.ai",
		"author": "Charly, core.ai",
		"license": "AGPL-3.0-or-later",
		@@ -46,0 +46,0 @@ "bugs": {

README.md

		@@ -1,41 +0,38 @@
		# template-nodejs
		# libcache

		A template project for nodejs. Has integrated linting, testing,
		coverage, reporting, GitHub actions for publishing to npm repository, dependency updates and other goodies.
		This library will be used for caching data in our internal services.
		## How to use Library
		We pass all configurations using environment variables. Following are environment variables available.

		Easily use this template to quick start a production ready nodejs project template.
		Please set following environment variables before using this library in production

		MEMCACHIER_SERVERS - used to determine which servers to connect to. Should be a comma separated list of [hostname:port].
		MEMCACHIER_USERNAME - if present with MEMCACHIER_PASSWORD, MemJS will try to authenticated to the server using SASL.
		MEMCACHIER_PASSWORD - if present with MEMCACHIER_USERNAME, MemJS will try to authenticated to the server using SASL.
		MEMCACHE_USERNAME - used if MEMCACHIER_USERNAME is not present
		MEMCACHE_PASSWORD - used if MEMCACHIER_PASSWORD is not present



		## Code Guardian

		[![<app> build verification](https://github.com/aicore/template-nodejs/actions/workflows/build_verify.yml/badge.svg)](https://github.com/aicore/template-nodejs/actions/workflows/build_verify.yml)
		[![<app> build verification](https://github.com/aicore/libcache/actions/workflows/build_verify.yml/badge.svg)](https://github.com/aicore/libcache/actions/workflows/build_verify.yml)

		<a href="https://sonarcloud.io/summary/new_code?id=aicore_template-nodejs-ts">
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=alert_status" alt="Sonar code quality check" />
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=security_rating" alt="Security rating" />
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=vulnerabilities" alt="vulnerabilities" />
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=coverage" alt="Code Coverage" />
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=bugs" alt="Code Bugs" />
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=reliability_rating" alt="Reliability Rating" />
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=sqale_rating" alt="Maintainability Rating" />
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=ncloc" alt="Lines of Code" />
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=sqale_index" alt="Technical debt" />
		<a href="https://sonarcloud.io/summary/new_code?id=aicore_libcache">
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_libcache&metric=alert_status" alt="Sonar code quality check" />
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_libcache&metric=security_rating" alt="Security rating" />
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_libcache&metric=vulnerabilities" alt="vulnerabilities" />
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_libcache&metric=coverage" alt="Code Coverage" />
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_libcache&metric=bugs" alt="Code Bugs" />
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_libcache&metric=reliability_rating" alt="Reliability Rating" />
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_libcache&metric=sqale_rating" alt="Maintainability Rating" />
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_libcache&metric=ncloc" alt="Lines of Code" />
		<img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_libcache&metric=sqale_index" alt="Technical debt" />
		</a>

		# TODOs after template use

		1. Update package.json with your app defaults
		2. Check Build actions on pull requests.
		3. In sonar cloud, enable Automatic analysis from `Administration
		Analysis Method` for the first time before a pull request is
		raised: ![image](https://user-images.githubusercontent.com/5336369/148695840-65585d04-5e59-450b-8794-54ca3c62b9fe.png)
		4. Check codacy runs on pull requests, set codacy defaults. You may remove codacy if sonar cloud is only needed.
		5. Update the above Code Guardian badges; change all `id=aicore_template-nodejs-ts` to the sonar id of your project
		fields.

		# Commands available

		## Building
		We run integration tests on `Ubuntu` so we recommend Ubuntu for building the packages.

		Since this is a pure JS template project, build command just runs test with coverage.

		```shell
		@@ -42,0 +39,0 @@ > npm install // do this only once.

@aicore/libcache - npm Package Compare versions

New alerts

Fixed alerts

Worsened metrics