From c005db31d67c63a6e6059b72ba3a775955f7431c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Hillerstr=C3=B6m?= Date: Mon, 25 Oct 2021 18:02:38 +0200 Subject: [PATCH] Fied README and added .codeclimate.yml --- .codeclimate.yml | 43 +++++++++++++++++++++++++++++++++++++++++++ README.md | 2 +- 2 files changed, 44 insertions(+), 1 deletion(-) create mode 100644 .codeclimate.yml diff --git a/.codeclimate.yml b/.codeclimate.yml new file mode 100644 index 0000000..9fef816 --- /dev/null +++ b/.codeclimate.yml @@ -0,0 +1,43 @@ +version: "2" # required to adjust maintainability checks +checks: + argument-count: + config: + threshold: 6 + complex-logic: + config: + threshold: 50 + file-lines: + config: + threshold: 300 + method-complexity: + config: + threshold: 6 + method-count: + config: + threshold: 30 + method-lines: + config: + threshold: 100 + nested-control-flow: + config: + threshold: 6 + return-statements: + config: + threshold: 6 + similar-code: + config: + threshold: 50 + identical-code: + config: + threshold: 25 +plugins: + duplication: + enabled: true + config: + count_threshold: 3 +exclude_patterns: + - "**/test/*" + - "**/adapter-tests/*" + - "**/dist/*" + - "**/*.dist.js" + - "**/templates/*" \ No newline at end of file diff --git a/README.md b/README.md index 2434639..c0e18c9 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![Known Vulnerabilities](https://snyk.io/test/github/feathersjs-offline/localforage/badge.svg)](https://snyk.io/test/github/feathersjs-offline/localforage) [![Maintainability](https://api.codeclimate.com/v1/badges/29bdb5362c208a740016/maintainability)](https://codeclimate.com/github/feathersjs-offline/localforage/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/29bdb5362c208a740016/test_coverage)](https://codeclimate.com/github/feathersjs-offline/localforage/test_coverage) -[![Download Status](https://img.shields.io/npm/dm/feathersjs-offline/localforage)](https://www.npmjs.com/package/feathersjs-offline/localforage) +[![Download Status](https://img.shields.io/npm/dm/@feathersjs-offline/localforage)](https://www.npmjs.com/package/@feathersjs-offline/localforage) [@featherjs-offline/localforage](https://github.com/feathersjs-offline/localforage/) is a database service adapter wrapping `localForage` that persists to either `IndexedDB`, `WebSQL`, or `LocalStorage` making it very useful for mobile and offline-first applications with the additional ability to seamlessly handle Blobs, TypedArrays, and other JS objects.