Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove engines for node 20, various cleanup #22

Merged
merged 1 commit into from
Jan 31, 2024
Merged

Remove engines for node 20, various cleanup #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .eslintignore
View file
Open in desktop

This file was deleted.

3 changes: 0 additions & 3 deletions .eslintrc
View file
Open in desktop

This file was deleted.

28 changes: 14 additions & 14 deletions .github/workflows/run-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@ name: 'Standard Tests'
on: push

jobs:
lint:
runs-on: ubuntu-latest
strategy:
matrix:
node: [14, 16]
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2-beta
with:
node-version: ${{ matrix.node }}
- name: Install modules
run: yarn
- name: Run lint
run: yarn eslint
# lint:
# runs-on: ubuntu-latest
# strategy:
# matrix:
# node: [14, 16]
# steps:
# - uses: actions/checkout@v2
# - uses: actions/setup-node@v2-beta
# with:
# node-version: ${{ matrix.node }}
# - name: Install modules
# run: yarn
# - name: Run lint
# run: yarn eslint
vulnerabilityScan:
runs-on: ubuntu-latest
steps:
Expand Down
51 changes: 32 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ For more information on contributing please see [the contrib message below](#con

## 🛑 Foreword

This package's lead maintainer is an employee of Strapi however this package is not officially maintained by Strapi Solutions SAS nor Strapi, Inc. and is currently maintained in the free time of the lead maintainer.
This package's lead maintainer is an employee of Strapi however this package is not officially maintained by Strapi Solutions SAS nor Strapi, Inc. and is currently maintained in the free time of the lead maintainer.

**Absolutely no part of this code should be considered covered under any agreement you have with Strapi proper** including but not limited to any Enterprise Agreement you have with Strapi.

Expand Down Expand Up @@ -86,15 +86,28 @@ If you are currently using this package in your plugin and would like to be feat

Supported Strapi Versions:

| Strapi Version | Supported | Tested On |
|----------------|------------|---------------|
| v3 | ❌ | N/A |
| v4.0.x | ✅ | July 2022 |
| v4.1.x | ✅ | July 2022 |
| v4.2.x | ✅ | July 2022 |
| v4.3.x | ✅ | December 2022 |
| v4.4.x | ✅ | December 2022 |
| v4.5.x | ✅ | December 2022 |
| Strapi Version | Supported | Tested On |
| -------------- | --------- | ------------- |
| v3 | ❌ | N/A |
| v4.0.x | ✅ | July 2022 |
| v4.1.x | ✅ | July 2022 |
| v4.2.x | ✅ | July 2022 |
| v4.3.x | ✅ | December 2022 |
| v4.4.x | ✅ | December 2022 |
| v4.5.x | ✅ | December 2022 |
| v4.6.x | ✅ | January 2024 |
| v4.7.x | ✅ | January 2024 |
| v4.8.x | ✅ | January 2024 |
| v4.9.x | ✅ | January 2024 |
| v4.10.x | ✅ | January 2024 |
| v4.11.x | ✅ | January 2024 |
| v4.12.x | ✅ | January 2024 |
| v4.13.x | ✅ | January 2024 |
| v4.14.x | ✅ | January 2024 |
| v4.15.x | ✅ | January 2024 |
| v4.16.x | ✅ | January 2024 |
| v4.17.x | ✅ | January 2024 |
| v4.19.x | ✅ | January 2024 |

**This plugin will not work with Strapi v3 projects as it utilizes APIs that don't exist in the v3!**

Expand Down Expand Up @@ -151,11 +164,11 @@ module.exports = {
default: {
connection: {
sentinels: [
{ host: "192.168.1.101", port: 26379 },
{ host: "192.168.1.102", port: 26379 },
{ host: "192.168.1.103", port: 26379 },
{ host: '192.168.1.101', port: 26379 },
{ host: '192.168.1.102', port: 26379 },
{ host: '192.168.1.103', port: 26379 },
],
name: "my-redis-replicaSet",
name: 'my-redis-replicaSet',
db: 0,
},
settings: {
Expand All @@ -172,7 +185,7 @@ module.exports = {

```js
// path ./config/plugins.js
const { readFileSync } = require('fs')
const { readFileSync } = require('fs');

module.exports = {
redis: {
Expand All @@ -187,8 +200,8 @@ module.exports = {
username: 'username',
password: 'secret',
// @see https://github.com/luin/ioredis#tls-options
tls: {
ca: readFileSync("cert.pem"),
tls: {
ca: readFileSync('cert.pem'),
},
},
settings: {
Expand Down Expand Up @@ -220,7 +233,7 @@ For each connection either a normal Redis client is created, or if the cluster s
#### Redis Client

Accessed with: `strapi.redis.connections.default.client`
*Note you can swap the default key with any other named database you have configured*
_Note you can swap the default key with any other named database you have configured_

From here you have full access to the [ioredis API](https://github.com/luin/ioredis/blob/master/API.md).

Expand All @@ -230,7 +243,7 @@ I/We are actively looking for contributors, maintainers, and others to help shap

Instead of reinventing the wheel every time you need to connect to Redis, the hope is to centralize the connections in a single plugin that all plugins can piggy back on.

If interested please feel free to email the lead maintainer Derrick at: derrickmehaffy@gmail.com or ping `DMehaffy#1337` on Discord.
If interested please feel free to email the lead maintainer Derrick at: derrickmehaffy@gmail.com or ping `DMehaffy` on Discord.

**Please Note**: This package is maintained collectively by the [strapi community organization](https://github.com/strapi-community). While there may be a lead maintainer, they are not the sole maintainer of this code and this code does not belong to the lead maintainer.

Expand Down
13 changes: 1 addition & 12 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,7 @@
"debug": "4.3.4",
"ioredis": "5.2.4"
},
"devDependencies": {
"@strapi-community/eslint-config": "0.1.5",
"eslint": "8.8.0"
},
"scripts": {
"eslint": "eslint .",
"eslint:fix": "eslint . --fix"
},
"scripts": {},
"author": {
"name": "Derrick Mehaffy",
"email": "derrickmehaffy@gmail.com",
Expand All @@ -43,9 +36,5 @@
"url": "https://github.com/strapi-community/strapi-plugin-redis/issues"
},
"homepage": "https://github.com/strapi-community/strapi-plugin-redis#readme",
"engines": {
"node": ">=12.x.x <=18.x.x",
"npm": ">=6.0.0"
},
"license": "MIT"
}
4 changes: 2 additions & 2 deletions server/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
'use strict';

const bootstrap = require('./bootstrap');
const register = require('./register');
const config = require('./config');
const services = require('./services');

module.exports = {
bootstrap,
register,
config,
services,
};
0 server/bootstrap.js → server/register.js
View file
Open in desktop
File renamed without changes.
Loading
Loading