docs(changeset): feat: add library template, add ioredis module

.changeset/shy-mugs-nail.md

@@ -0,0 +1,6 @@
+---
+"@nailyjs/ioredis": patch
+"@nailyjs/cli": patch
+---
+
+feat: add library template, add ioredis module

.vscode/settings.json

@@ -83,7 +83,8 @@
     "typeorm": "database",
     "rpc": "api",
     "unplugin-rpc": "plugin",
-    "eslint": "config"
+    "eslint": "config",
+    "ioredis": "database"
   },
   "material-icon-theme.activeIconPack": "nest",
   "material-icon-theme.files.associations": {

naily.config.ts

@@ -16,8 +16,6 @@ export default defineConfig({
       },
     },
 
-    cacheManager: {},
-
     typeorm: {
       type: 'sqlite',
       database: path.join(cwd(), './node_modules/.cache/naily/typeorm.db'),

package.json

@@ -20,6 +20,7 @@
     "build:eslint": "pnpm -F @nailyjs/eslint build",
     "build:unplugin-rpc": "pnpm -F unplugin-rpc build",
     "build:cache": "pnpm -F @nailyjs/cache build",
+    "build:ioredis": "pnpm -F @nailyjs/ioredis build",
     "play:rpc": "pnpm -F rpc dev",
 
     "lint": "eslint .",

packages/cli/src/index.ts

@@ -34,6 +34,7 @@ export class CliBootstrap extends AbstractBootstrap {
       choices: [
         { title: 'backend-app', value: 'template-backend-app', description: 'Basic naily backend application' },
         { title: 'vitesse-naily', value: 'vitesse-naily', description: 'Antfu\'s Vitesse with Naily' },
+        { title: 'library', value: 'template-library', description: 'Naily library template' },
       ],
     }).catch(() => exit(0))
     if (!template.template) return exit(0)

packages/ioredis/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@nailyjs/ioredis",
+  "type": "module",
+  "version": "2.0.1",
+  "description": "ioredis module for naily.js.",
+  "author": "Naily Zero <[email protected]> (https://naily.cc)",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "watch": "tsup -w",
+    "prepublishOnly": "tsup"
+  },
+  "dependencies": {
+    "@nailyjs/config": "workspace:*",
+    "@nailyjs/ioc": "workspace:*",
+    "ioredis": "^5.4.1"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.0"
+  }
+}

packages/ioredis/src/configure-ioredis-protocol.ts

@@ -0,0 +1,4 @@
+export const CustomIoRedis = '__naily_custom_ioredis__'
+export interface CustomIoRedis {
+  configure(ioRedisOptions: Naily.Configuration.NailyUserConfig['ioRedis']): Naily.Configuration.NailyUserConfig['ioRedis'] | Promise<Naily.Configuration.NailyUserConfig['ioRedis']>
+}

packages/ioredis/src/index.ts

@@ -0,0 +1,3 @@
+export * from './configure-ioredis-protocol'
+export * from './ioredis.service'
+export * from './plugin'

packages/ioredis/src/ioredis.service.ts

@@ -0,0 +1,40 @@
+import { Value } from '@nailyjs/config'
+import { Autowired, ClassWrapper, Container, Optional, Service } from '@nailyjs/ioc'
+import Redis from 'ioredis'
+import { CustomIoRedis } from './configure-ioredis-protocol'
+
+@Service()
+export class IORedisFactoryService {
+  constructor(
+    @Value('naily.ioRedis')
+    private readonly ioRedisOptions: Naily.Configuration.NailyUserConfig['ioRedis'],
+    @Optional()
+    @Autowired(CustomIoRedis)
+    private readonly configureService: CustomIoRedis,
+  ) {}
+
+  async setup(container: Container): Promise<void> {
+    let ioRedisOptions = this.ioRedisOptions
+    if (this.configureService && typeof this.configureService.configure === 'function')
+      ioRedisOptions = await this.configureService.configure(ioRedisOptions)
+
+    if (Array.isArray(ioRedisOptions)) {
+      for (const ioRedisOption of ioRedisOptions) {
+        const ioRedisInstance = new Redis(ioRedisOption)
+        await ioRedisInstance.connect()
+        container.createConstantWrapper(ioRedisOption.injectionToken, ioRedisInstance).save()
+      }
+    }
+    else {
+      const ioRedisInstance = new Redis(ioRedisOptions)
+      await ioRedisInstance.connect()
+      container.createConstantWrapper(Redis, ioRedisInstance).save()
+    }
+  }
+
+  static getInstance(container: Container): IORedisFactoryService {
+    const wrapper = container.getContainer().get(IORedisFactoryService) as ClassWrapper<IORedisFactoryService>
+    if (wrapper && wrapper.wrapperType === 'class') return wrapper.getClassFactory().getOrCreateInstance()
+    return container.createClassWrapper(IORedisFactoryService).getClassFactory().getOrCreateInstance()
+  }
+}

packages/ioredis/src/plugin.ts

@@ -0,0 +1,14 @@
+import { Container, IocPlugin } from '@nailyjs/ioc'
+import { IORedisFactoryService } from './ioredis.service'
+
+class IoRedisPluginImpl implements IocPlugin {
+  name: string = 'naily:ioredis-plugin'
+
+  async beforeRun(container: Container): Promise<void> {
+    await IORedisFactoryService.getInstance(container).setup(container)
+  }
+}
+
+export function IoRedisPlugin(): IocPlugin {
+  return new IoRedisPluginImpl()
+}

packages/ioredis/src/types.ts

@@ -0,0 +1,17 @@
+import { InjectionTokenable } from '@nailyjs/ioc'
+import { RedisOptions } from 'ioredis'
+
+declare global {
+  namespace Naily {
+    namespace Configuration {
+      interface NailyUserConfig {
+        ioRedis?: IoRedisOptions | InjectionTokenable<IoRedisOptions>[]
+      }
+      interface NailyUserIntelliSense {
+        ioRedis?: IoRedisOptions
+      }
+    }
+  }
+}
+
+export interface IoRedisOptions extends RedisOptions {}

packages/ioredis/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "module": "ES2022",
+    "moduleResolution": "Bundler"
+  },
+  "include": ["src"]
+}

packages/ioredis/tsup.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig({
+  entry: {
+    index: './src/index.ts',
+  },
+  dts: true,
+  sourcemap: true,
+  clean: true,
+  format: ['cjs', 'esm'],
+})