Skip to content

ArshSSandhu/Nodejs-cli-plugin-system

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

100 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nodejs-cli-plugin-system

This project demonstrates a simple plugin system built with Node.js and TypeScript. It features a Command Line Interface (CLI) application that allows users to select and apply various text transformation plugins to input text. The system is designed to be modular and extensible, making it easy to add new plugins and extend functionality.

License

Features

  • Pluggable Architecture: Easily add or remove plugins to extend functionality.
  • Built with TypeScript: Ensures type safety and better code maintainability.
  • Command Line Interface: Simple and intuitive CLI for applying text transformations.
  • Modular Design: Clear separation of concerns, making the codebase easier to understand and extend.

Installation

Prerequisites

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

Steps

  1. Clone the repository:

    git clone https://github.com/yourusername/text-cli.git
    cd text-cli
  2. Install dependencies:

    npm install
  3. Build the project:

    cd src
    npx tsc

Usage

  1. Navigate to the build directory:

    cd ../jsfiles
  2. Run the application:

    node index.js
  3. Follow the prompts to enter the text and choose a plugin for transformation.

Example

Refer to this image

Refer to this image

Refer to this image

Want to Contribute?

Build Plugins of your Choice and create PR. It's easier than you think. Refer to my website here to build your own plugin Plugin Tutorial

Refer to this image

Resource I Used

I found the following article extremely helpful in creating this system:

Acknowledgments

I want to express my gratitude to:
MIE My internship company for the opportunity and support throughout the project.
Doug Horner The CEO, for his invaluable guidance and mentorship.

About

This project demonstrates a simple plugin system built with Node.js and TypeScript. It features a Command Line Interface (CLI) application that allows users to select and apply various text transformation plugins to input text. The system is designed to be modular and extensible, making it easy to add new plugins and extend functionality. Plugins->

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages