Skip to content

Commit

Permalink
build: simplify naming
Browse files Browse the repository at this point in the history
  • Loading branch information
Kikobeats committed Jul 16, 2021
1 parent b2b95b7 commit f1e08e3
Show file tree
Hide file tree
Showing 26 changed files with 56 additions and 56 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

![Last version](https://img.shields.io/github/tag/keyvhq/keyv.svg?style=flat-square)
[![Coverage Status](https://img.shields.io/coveralls/keyvhq/keyv.svg?style=flat-square)](https://coveralls.io/github/keyvhq/keyv)
[![NPM Status](https://img.shields.io/npm/dm/@keyvhq/keyv.svg?style=flat-square)](https://www.npmjs.org/package/@keyvhq/keyv)
[![NPM Status](https://img.shields.io/npm/dm/@keyvhq/core.svg?style=flat-square)](https://www.npmjs.org/package/@keyvhq/core)

> **Keyv** is a simple key-value storage with support for multiple backend adapters (MySQL, PostgreSQL, SQLite, Redis, Mongo, DynamoDB, Firestore, Memcached, and more).
Expand All @@ -27,17 +27,17 @@
## Installation

```bash
npm install @keyvhq/keyv --save
npm install @keyvhq/core --save
```

You can optionally install the storage adapter you want to use:

```bash
npm install @keyvhq/keyv-redis --save
npm install @keyvhq/keyv-mongo --save
npm install @keyvhq/keyv-sqlite --save
npm install @keyvhq/keyv-postgres --save
npm install @keyvhq/keyv-mysql --save
npm install @keyvhq/redis --save
npm install @keyvhq/mongo --save
npm install @keyvhq/sqlite --save
npm install @keyvhq/postgres --save
npm install @keyvhq/mysql --save
```

If you don't provide a specific storage adapter, a in-memory storage adapter is used by default.
Expand Down Expand Up @@ -115,7 +115,7 @@ Caching will work in memory by default and users have the option to also install

```js
const got = require('got')
const keyv = require('@keyvhq/keyv')
const keyv = require('@keyvhq/core')
const keyvRedis = require('@keyvhq/redis')

const cache = new KeyvRedis('redis://user:pass@localhost:6379')
Expand All @@ -128,7 +128,7 @@ The recommended pattern is to expose a `cache` option in your modules options wh
For example, [quick-lru](https://github.com/sindresorhus/quick-lru) is a completely unrelated module that implements the [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) API.

```js
const Keyv = require('@keyvhq/keyv')
const Keyv = require('@keyvhq/core')
const QuickLRU = require('quick-lru')

const lru = new QuickLRU({ maxSize: 1000 })
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<meta name="twitter:description" content="Keyv is a simple key-value storage with support for multiple backend adapters (MySQL, PostgreSQL, SQLite, Redis, Mongo, DynamoDB, Firestore, Memcached, and more).">
<meta name="twitter:image" content="https://keyv.js.org/static/banner.png">
<meta name="twitter:label1" value="Installation" />
<meta name="twitter:data1" value="npm install @keyvhq/keyv --save" />
<meta name="twitter:data1" value="npm install @keyvhq/core --save" />
<!-- Open Graph general (Facebook, Pinterest & Google+) -->
<meta property="og:title" content="keyv">
<meta property="og:logo" content="https://keyv.js.org/static/logo.jpg">
Expand Down
2 changes: 1 addition & 1 deletion packages/keyv-mongo/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline

## [0.2.4](https://github.com/microlinkhq/keyv/compare/v0.2.0...v0.2.4) (2021-07-01)

**Note:** Version bump only for package @keyvhq/keyv-mongo
**Note:** Version bump only for package @keyvhq/mongo
6 changes: 3 additions & 3 deletions packages/keyv-mongo/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@keyvhq/keyv-mongo",
"name": "@keyvhq/mongo",
"description": "MongoDB storage adapter for Keyv",
"homepage": "https://github.com/microlinkhq/keyv",
"version": "1.0.0",
Expand Down Expand Up @@ -34,8 +34,8 @@
"pify": "^5.0.0"
},
"devDependencies": {
"@keyvhq/keyv": "latest",
"@keyvhq/keyv-test-suite": "latest",
"@keyvhq/core": "latest",
"@keyvhq/test-suite": "latest",
"ava": "latest",
"nyc": "latest"
},
Expand Down
4 changes: 2 additions & 2 deletions packages/keyv-mongo/test/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
'use strict'

const keyvTestSuite = require('@keyvhq/keyv-test-suite')
const Keyv = require('@keyvhq/keyv')
const keyvTestSuite = require('@keyvhq/test-suite')
const Keyv = require('@keyvhq/core')
const test = require('ava')

const KeyvMongo = require('..')
Expand Down
2 changes: 1 addition & 1 deletion packages/keyv-mysql/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline

## [0.2.4](https://github.com/microlinkhq/keyv/compare/v0.2.0...v0.2.4) (2021-07-01)

**Note:** Version bump only for package @keyvhq/keyv-mysql
**Note:** Version bump only for package @keyvhq/mysql
8 changes: 4 additions & 4 deletions packages/keyv-mysql/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@keyvhq/keyv-mysql",
"name": "@keyvhq/mysql",
"description": "MySQL/MariaDB storage adapter for Keyv",
"homepage": "https://github.com/microlinkhq/keyv",
"version": "1.0.0",
Expand Down Expand Up @@ -31,12 +31,12 @@
"value"
],
"dependencies": {
"@keyvhq/keyv-sql": "^1.0.0",
"@keyvhq/sql": "^1.0.0",
"mysql2": "2.2.5"
},
"devDependencies": {
"@keyvhq/keyv": "latest",
"@keyvhq/keyv-test-suite": "latest",
"@keyvhq/core": "latest",
"@keyvhq/test-suite": "latest",
"ava": "latest",
"nyc": "latest"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/keyv-mysql/src/index.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'use strict'

const KeyvSql = require('@keyvhq/keyv-sql')
const KeyvSql = require('@keyvhq/sql')
const mysql = require('mysql2/promise')

class KeyvMysql extends KeyvSql {
Expand Down
4 changes: 2 additions & 2 deletions packages/keyv-mysql/test/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
'use strict'

const keyvTestSuite = require('@keyvhq/keyv-test-suite')
const Keyv = require('@keyvhq/keyv')
const keyvTestSuite = require('@keyvhq/test-suite')
const Keyv = require('@keyvhq/core')
const test = require('ava')

const KeyvMysql = require('..')
Expand Down
2 changes: 1 addition & 1 deletion packages/keyv-postgres/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline

## [0.2.4](https://github.com/microlinkhq/keyv/compare/v0.2.0...v0.2.4) (2021-07-01)

**Note:** Version bump only for package @keyvhq/keyv-postgres
**Note:** Version bump only for package @keyvhq/postgres
8 changes: 4 additions & 4 deletions packages/keyv-postgres/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@keyvhq/keyv-postgres",
"name": "@keyvhq/postgres",
"description": "PostgreSQL storage adapter for Keyv",
"homepage": "https://github.com/microlinkhq/keyv",
"version": "1.0.0",
Expand Down Expand Up @@ -31,12 +31,12 @@
"value"
],
"dependencies": {
"@keyvhq/keyv-sql": "^1.0.0",
"@keyvhq/sql": "^1.0.0",
"pg": "8.6.0"
},
"devDependencies": {
"@keyvhq/keyv": "latest",
"@keyvhq/keyv-test-suite": "latest",
"@keyvhq/core": "latest",
"@keyvhq/test-suite": "latest",
"ava": "latest",
"nyc": "latest"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/keyv-postgres/src/index.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'use strict'

const KeyvSql = require('@keyvhq/keyv-sql')
const KeyvSql = require('@keyvhq/sql')
const Pool = require('pg').Pool

class KeyvPostgres extends KeyvSql {
Expand Down
4 changes: 2 additions & 2 deletions packages/keyv-postgres/test/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
'use strict'

const keyvTestSuite = require('@keyvhq/keyv-test-suite')
const Keyv = require('@keyvhq/keyv')
const keyvTestSuite = require('@keyvhq/test-suite')
const Keyv = require('@keyvhq/core')
const test = require('ava')

const KeyvPostgres = require('..')
Expand Down
2 changes: 1 addition & 1 deletion packages/keyv-redis/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline

## [0.2.4](https://github.com/microlinkhq/keyv/compare/v0.2.0...v0.2.4) (2021-07-01)

**Note:** Version bump only for package @keyvhq/keyv-redis
**Note:** Version bump only for package @keyvhq/redis
6 changes: 3 additions & 3 deletions packages/keyv-redis/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@keyvhq/keyv-redis",
"name": "@keyvhq/redis",
"description": "Redis storage adapter for Keyv",
"homepage": "https://github.com/microlinkhq/keyv",
"version": "1.0.0",
Expand Down Expand Up @@ -33,8 +33,8 @@
"p-event": "~4.2.0"
},
"devDependencies": {
"@keyvhq/keyv": "latest",
"@keyvhq/keyv-test-suite": "latest",
"@keyvhq/core": "latest",
"@keyvhq/test-suite": "latest",
"ava": "latest",
"nyc": "latest"
},
Expand Down
4 changes: 2 additions & 2 deletions packages/keyv-redis/test/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
'use strict'

const keyvTestSuite = require('@keyvhq/keyv-test-suite')
const Keyv = require('@keyvhq/keyv')
const keyvTestSuite = require('@keyvhq/test-suite')
const Keyv = require('@keyvhq/core')
const Redis = require('ioredis')
const test = require('ava')

Expand Down
2 changes: 1 addition & 1 deletion packages/keyv-sql/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline

## [0.2.4](https://github.com/microlinkhq/keyv/compare/v0.2.0...v0.2.4) (2021-07-01)

**Note:** Version bump only for package @keyvhq/keyv-sql
**Note:** Version bump only for package @keyvhq/sql
6 changes: 3 additions & 3 deletions packages/keyv-sql/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@keyvhq/keyv-sql",
"name": "@keyvhq/sql",
"description": "Parent class for SQL based Keyv storage adapters",
"homepage": "https://github.com/microlinkhq/keyv",
"version": "1.0.0",
Expand Down Expand Up @@ -33,8 +33,8 @@
"sqlite3": "^5.0.2"
},
"devDependencies": {
"@keyvhq/keyv": "latest",
"@keyvhq/keyv-test-suite": "latest",
"@keyvhq/core": "latest",
"@keyvhq/test-suite": "latest",
"ava": "latest",
"nyc": "latest"
},
Expand Down
4 changes: 2 additions & 2 deletions packages/keyv-sql/test/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
'use strict'

const keyvTestSuite = require('@keyvhq/keyv-test-suite')
const Keyv = require('@keyvhq/keyv')
const keyvTestSuite = require('@keyvhq/test-suite')
const Keyv = require('@keyvhq/core')
const sqlite3 = require('sqlite3')
const pify = require('pify')
const test = require('ava')
Expand Down
2 changes: 1 addition & 1 deletion packages/keyv-sqlite/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline

## [0.2.4](https://github.com/microlinkhq/keyv/compare/v0.2.0...v0.2.4) (2021-07-01)

**Note:** Version bump only for package @keyvhq/keyv-sqlite
**Note:** Version bump only for package @keyvhq/sqlite
8 changes: 4 additions & 4 deletions packages/keyv-sqlite/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@keyvhq/keyv-sqlite",
"name": "@keyvhq/sqlite",
"description": "SQLite storage adapter for Keyv",
"homepage": "https://github.com/microlinkhq/keyv",
"version": "1.0.0",
Expand Down Expand Up @@ -30,13 +30,13 @@
"value"
],
"dependencies": {
"@keyvhq/keyv-sql": "^1.0.0",
"@keyvhq/sql": "^1.0.0",
"pify": "5.0.0",
"sqlite3": "^5.0.2"
},
"devDependencies": {
"@keyvhq/keyv": "latest",
"@keyvhq/keyv-test-suite": "latest",
"@keyvhq/core": "latest",
"@keyvhq/test-suite": "latest",
"ava": "latest",
"nyc": "latest"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/keyv-sqlite/src/index.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'use strict'

const KeyvSql = require('@keyvhq/keyv-sql')
const KeyvSql = require('@keyvhq/sql')
const sqlite3 = require('sqlite3')
const pify = require('pify')

Expand Down
4 changes: 2 additions & 2 deletions packages/keyv-sqlite/test/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
'use strict'

const keyvTestSuite = require('@keyvhq/keyv-test-suite')
const Keyv = require('@keyvhq/keyv')
const keyvTestSuite = require('@keyvhq/test-suite')
const Keyv = require('@keyvhq/core')
const test = require('ava')

const KeyvSqlite = require('..')
Expand Down
2 changes: 1 addition & 1 deletion packages/keyv-test-suite/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@keyvhq/keyv-test-suite",
"name": "@keyvhq/test-suite",
"description": "Test suite for Keyv API compliancy",
"homepage": "https://github.com/microlinkhq/keyv",
"version": "1.0.0",
Expand Down
4 changes: 2 additions & 2 deletions packages/keyv/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@keyvhq/keyv",
"name": "@keyvhq/core",
"description": "Simple key-value storage with support for multiple backends",
"homepage": "https://github.com/microlinkhq/keyv",
"version": "1.0.0",
Expand Down Expand Up @@ -28,7 +28,7 @@
"json-buffer": "~3.0.1"
},
"devDependencies": {
"@keyvhq/keyv-test-suite": "latest",
"@keyvhq/test-suite": "latest",
"ava": "latest",
"nyc": "latest",
"timekeeper": "latest"
Expand Down
2 changes: 1 addition & 1 deletion packages/keyv/test/keyv.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'use strict'

const keyvTestSuite = require('@keyvhq/keyv-test-suite')
const keyvTestSuite = require('@keyvhq/test-suite')
const tk = require('timekeeper')
const test = require('ava')

Expand Down

0 comments on commit f1e08e3

Please sign in to comment.