Add github workflows, docker support, rollup build

Author: hashemirafsan

.docker/Dockerfile.test

@@ -0,0 +1,6 @@
+FROM node:14.17-alpine
+
+WORKDIR /usr/src/app
+COPY package*.json ./
+RUN npm i
+COPY . .

.docker/docker-compose.yml

@@ -0,0 +1,23 @@
+version: '3.1'
+
+services:
+  redis-cache-manager:
+    container_name: redis-cache-manager
+    build:
+      context: .
+      dockerfile: Dockerfile.test
+    volumes:
+      - ../:/usr/src/app
+    depends_on:
+      - redis
+    command: npm run test
+
+  redis: # Redis
+    image: redis
+    logging:
+      driver: none
+    healthcheck:
+      test: [ "CMD", "redis-cli", "--raw", "incr", "ping" ]
+      interval: 20s
+      timeout: 5s
+      retries: 3

.github/workflows/npm-publish.yml

@@ -0,0 +1,47 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Publish package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish-package:
+    name: Publish package redis-caching-manager
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      
+      - name: Install Node.js 14.x
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14.x
+          registry-url: 'https://registry.npmjs.org'
+      
+      - name: Install Redis 6
+        uses: supercharge/[email protected]
+        with:
+          redis-version: 6
+
+      - name: Install dependency
+        run: npm install
+
+      - name: Format package
+        run: npm run format
+
+      - name: Build Package
+        run: npm run build
+
+      - name: Test Package
+        run: npm run test
+        env: 
+          REDIS_URL: redis://localhost:6379
+
+      - name: Publish into npm registry
+        run: npm publish
+        env: 
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,5 +1,4 @@
 .idea
 node_modules/
 lib/
-Dockerfile.test
-docker-compose.yml
+pnpm-lock.yaml

.npmignore

@@ -5,4 +5,7 @@ src/
 tsconfig.json
 tslint.json
 .prettierrc
-.docker
+.docker
+examples/
+rollup.config.ts
+pnpm-lock.yaml

package.json

@@ -1,18 +1,19 @@
 {
   "name": "redis-caching-manager",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A cache manager for redis",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
+  "module": "lib/index.mjs",
   "scripts": {
-    "build": "tsc",
+    "clean": "rm -rf lib/",
+    "build": "npm run clean && rollup -c",
     "format": "prettier --write \"src/**/*.ts\"",
     "lint": "tslint -p tsconfig.json",
     "test": "jest --config jestconfig.json --detectOpenHandles --unhandled-rejections=strict",
     "test:docker": "docker-compose --file ./.docker/docker-compose.yml up --abort-on-container-exit --exit-code-from redis-cache-manager",
     "posttest:docker": "docker-compose --file ./.docker/docker-compose.yml down --volumes --remove-orphans",
     "prepare": "npm run build",
-    "prepublishOnly": "npm run test:docker && npm run lint",
     "preversion": "npm run lint",
     "version": "npm run format && git add -A src",
     "postversion": "git push && git push --tags"
@@ -24,8 +25,12 @@
   },
   "devDependencies": {
     "@types/jest": "^27.4.0",
+    "esbuild": "^0.14.27",
     "jest": "^27.4.7",
     "prettier": "^2.5.1",
+    "rollup": "^2.70.1",
+    "rollup-plugin-dts": "^4.2.0",
+    "rollup-plugin-esbuild": "^4.8.2",
     "ts-jest": "^27.1.3",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",

rollup.config.js

@@ -0,0 +1,35 @@
+import dts from 'rollup-plugin-dts'
+import esbuild from 'rollup-plugin-esbuild'
+
+const name = require('./package.json').main.replace(/\.js$/, '')
+
+const bundle = config => ({
+  ...config,
+  input: 'src/index.ts',
+  external: id => !/^[./]/.test(id),
+})
+
+export default [
+  bundle({
+    plugins: [esbuild()],
+    output: [
+      {
+        file: `${name}.js`,
+        format: 'cjs',
+        sourcemap: true,
+      },
+      {
+        file: `${name}.mjs`,
+        format: 'es',
+        sourcemap: true,
+      },
+    ],
+  }),
+  bundle({
+    plugins: [dts()],
+    output: {
+      file: `${name}.d.ts`,
+      format: 'es',
+    },
+  }),
+]

tests/destroy.test.ts

@@ -8,7 +8,7 @@ beforeEach(async () => {
 
 beforeAll(async () => {
   await cacheManager.connect({
-    url: 'redis://redis:6379',
+    url: process.env.REDIS_URL ?? 'redis://redis:6379',
   });
 });
 

tests/enable.test.ts

@@ -8,7 +8,7 @@ beforeEach(async () => {
 
 beforeAll(async () => {
   await cacheManager.connect({
-    url: 'redis://redis:6379',
+    url: process.env.REDIS_URL ?? 'redis://redis:6379',
     prefix: 'dorik',
   });
 });

tests/get.test.ts

@@ -9,7 +9,7 @@ beforeEach(async () => {
 beforeAll(async () => {
   await cacheManager.connect({
     prefix: 'prefix_',
-    url: 'redis://redis:6379',
+    url: process.env.REDIS_URL ?? 'redis://redis:6379',
   });
 });
 

tests/has.test.ts

@@ -8,7 +8,7 @@ beforeEach(async () => {
 
 beforeAll(async () => {
   await cacheManager.connect({
-    url: 'redis://redis:6379',
+    url: process.env.REDIS_URL ?? 'redis://redis:6379',
   });
 });
 

tests/pull.test.ts

@@ -8,7 +8,7 @@ beforeEach(async () => {
 
 beforeAll(async () => {
   await cacheManager.connect({
-    url: 'redis://redis:6379',
+    url: process.env.REDIS_URL ?? 'redis://redis:6379',
   });
 });
 

tests/put.test.ts

@@ -8,7 +8,7 @@ beforeEach(async () => {
 
 beforeAll(async () => {
   await cacheManager.connect({
-    url: 'redis://redis:6379',
+    url: process.env.REDIS_URL ?? 'redis://redis:6379',
   });
 });
 

tests/remember.test.ts

@@ -8,7 +8,7 @@ beforeEach(async () => {
 
 beforeAll(async () => {
   await cacheManager.connect({
-    url: 'redis://redis:6379',
+    url: process.env.REDIS_URL ?? 'redis://redis:6379',
   });
 });
 

tests/set.test.ts

@@ -8,7 +8,7 @@ beforeEach(async () => {
 
 beforeAll(async () => {
   await cacheManager.connect({
-    url: 'redis://redis:6379',
+    url: process.env.REDIS_URL ?? 'redis://redis:6379',
   });
 });
 

tests/tags.test.ts

@@ -8,7 +8,7 @@ beforeEach(async () => {
 
 beforeAll(async () => {
   await cacheManager.connect({
-    url: 'redis://redis:6379',
+    url: process.env.REDIS_URL ?? 'redis://redis:6379',
   });
 });