artusx-best-practices

ArtusX Best Practices

Quick Start

Install ArtusX CLI

npm install -g @artusx/init

Create New Application

# Create a web application
artusx-init --name web --type apps

# Create a plugin
artusx-init --name postgres --type plugins

# Create a library
artusx-init --name common --type libs

Run Your Application

cd web
npm install
npm run dev

Package Types

Type	Description	Example
apps	Web applications	artusx-koa, artusx-nest
plugins	ArtusX plugins	plugin-redis, plugin-sequelize
libs	Shared libraries	@artusx/core, @artusx/utils

Note: If you're developing ArtusX itself (contributing to the monorepo), see references/rush-workflow.md for Rush.js commands.

---

Common Tasks

Create a New Plugin

Standard plugin structure:

packages/plugins/mongodb/src/
├── client.ts       # Client with @Injectable
├── constants.ts    # InjectEnum definitions
├── lifecycle.ts    # @LifecycleHookUnit with hooks
├── index.ts        # Export entry point
└── config/config.default.ts  # Default configuration

client.ts:

import { Injectable, ScopeEnum } from '@artus/core';
import { InjectEnum } from './constants';

@Injectable({ id: InjectEnum.MongoDB, scope: ScopeEnum.SINGLETON })
export default class MongoDBClient {
  async init(config: MongoDBConfig) {
    if (!config) return;
    // Initialize client
  }
  getClient() { return this.client; }
}

constants.ts:

export enum InjectEnum {
  MongoDB = 'ARTUSX_MONGODB',
}

lifecycle.ts:

import { LifecycleHookUnit, LifecycleHook, Inject, ArtusInjectEnum, Logger } from '@artus/core';

@LifecycleHookUnit()
export default class MongoDBLifecycle implements ApplicationLifecycle {
  @Inject(ArtusInjectEnum.Application) app: ArtusApplication;
  @Inject(ArtusInjectEnum.Logger) logger: Logger;

  @LifecycleHook()
  async willReady() {
    const config = this.app.config.mongodb;
    if (!config || !config.uri) return;
    this.logger.info('MongoDB plugin initializing...');
    const client = this.app.container.get(InjectEnum.MongoDB);
    await client.init(config);
    this.logger.info('MongoDB plugin initialized successfully');
  }
}

// Verify lifecycle.ts is exported in index.ts:
// export { default as MongoDBLifecycle } from './lifecycle';