AsyCLI

A CLI tool for generating TypeScript module files with NestJS, React, and React Native structure.

Features

• Generate complete module structure with a single command
• Support for multiple frameworks:
  • NestJS: Creates module structure with:
    • [module].service.ts
    • [module].repository.ts
    • [module].resolver.ts
    • [module].schema.ts
    • [module].dto.ts
    • [module].module.ts
  • React: Creates various React components and structures:
    • Pages: [page].tsx (with routing and layout)
    • Screens: [screen].tsx (for screen components)
    • Components:
      • Table components
      • Create form components
    • Context: [context].tsx (for state management)
    • Models: [model].ts (for TypeScript interfaces)
    • GraphQL:
      • Queries
      • Fragments
• Pre-populated with framework-specific decorators and basic structure
• Template-based system for easy customization

Installation

Prerequisites

• Node.js (v14 or higher)
• npm (v6 or higher)

Global Installation

1. Clone the repository:

git clone https://github.com/yourusername/asycli.git
cd asycli

2. Install dependencies:

npm install

3. Build the project:

npm run build

4. Install globally:

npm install -g .

Local Installation

1. Clone the repository:

git clone https://github.com/yourusername/asycli.git
cd asycli

2. Install dependencies:

npm install

3. Build the project:

npm run build

Usage

Basic Usage

asycli generate -d ./src -m user

This will create a user directory with all the necessary files in the src directory.

Options

• -d, --dir <directory>: Target directory for generated files (required)
• -m, --module <name>: Name of the module to generate (required)

Example

asycli generate -d ./src -m user

This will create the following structure:

src/
└── user/
    ├── user.service.ts
    ├── user.repository.ts
    ├── user.resolver.ts
    ├── user.schema.ts
    ├── user.dto.ts
    └── user.module.ts

Examples

NestJS Example

asycli generate -d ./src -m user -f nest

This will create the following structure:

src/
└── user/
    ├── user.service.ts
    ├── user.repository.ts
    ├── user.resolver.ts
    ├── user.schema.ts
    ├── user.dto.ts
    └── user.module.ts

Development

Building the Project

The build process includes:

1. Cleaning the dist directory
2. Compiling TypeScript files
3. Copying template files to dist directory

npm run build

Running in Development Mode

npm run dev

Testing the CLI

npm run dev -- -d ./src -m test

Available Scripts

• npm run clean: Remove the dist directory
• npm run copy-templates: Copy template files to dist directory
• npm run build: Full build process
• npm run start: Run the compiled version
• npm run dev: Run in development mode with ts-node
• npm run prepare: Run before npm install (automatically builds the project)

Project Structure

.
├── bin/
│   └── asycli              # CLI entry point
├── src/
│   ├── templates/          # Template files
│   │   ├── nest/          # NestJS templates
│   │   │   ├── service.template.txt
│   │   │   ├── repository.template.txt
│   │   │   ├── resolver.template.txt
│   │   │   ├── schema.template.txt
│   │   │   ├── dto.template.txt
│   │   │   └── module.template.txt
│   │   ├── react/         # React templates
│   │   │   ├── page.template.tsx.txt
│   │   │   ├── screen.template.tsx.txt
│   │   │   ├── context.template.tsx.txt
│   │   │   ├── model.template.ts.txt
│   │   │   ├── components/
│   │   │   │   ├── table.template.tsx.txt
│   │   │   │   └── create.template.tsx.txt
│   │   │   └── gql/
│   │   │       ├── query.template.ts.txt
│   │   │       └── fragment.template.ts.txt
│   │   └── react-native/  # React Native templates
│   │       ├── component.template.txt
│   │       ├── styles.template.txt
│   │       ├── test.template.txt
│   │       └── types.template.txt
│   └── index.ts            # Main CLI logic
├── dist/                   # Compiled JavaScript files
├── package.json
└── tsconfig.json

Dependencies

• @nestjs/common: For NestJS decorators and utilities
• @nestjs/graphql: For GraphQL support
• commander: For CLI argument parsing
• typescript: For TypeScript compilation

License

ISC