ljneon/patron

The cleanest discord.js and eris command framework.

About

Patron is an efficient and maintainable command framework for discord.js and Eris that aims for true flexibility. Patron doesn't have a modified client, manage the message event for you, or clutter other libraries with extensions. Patron has full support for TypeScript, as well as ECMAScript Modules.

Should I use Patron?

Patron isn't designed for beginners, but for those who want a highly flexible framework and fast development time. Bots with complex or many features will see higher maintainability and reusable code.

Installation

Patron is available on NPM and can be installed easily.

npm install patron

If you are using TypeScript (or rely on typings for code completion) you will need to use an additional command to properly set up typings. You need to have the Discord library installed beforehand. This command will need to be run again if you switch between libraries.

npx patron --typings=eris // or 'discordjs'

Documentation

Patron's API documentation is in an index.d.ts file with detailed comments, and there's a folder of guides explaining features with example code.

patron's Issues

Typings are out of date

patron.Libraries and potentially other things have not been added to the typings.

No spacing preservation with remainder arguments.

All remainder arguments are joined with a single space, however, they are originally split by any whitespace. This means that if tabs or several spaces were used in a remainder argument, the parsed value would simply replace all contiguous whitespace with a single space.

Breaking change at Handler modularization

A breaking change was introduced here: 0c7134f

Here is the error when using this commit version, and no errors are produced from the previous commit.

johnpyp@johnpyp-UX330UAK:~/Desktop/Coding/dice-nation$ node src/index
/home/johnpyp/Desktop/Coding/dice-nation/node_modules/patron.js/src/structures/Handler.js:322
      throw new TypeError('Handler.registry must be an instance of the registry.');
      ^

TypeError: Handler.registry must be an instance of the registry.
    at Function.validateHandler (/home/johnpyp/Desktop/Coding/dice-nation/node_modules/patron.js/src/structures/Handler.js:322:13)
    at new Handler (/home/johnpyp/Desktop/Coding/dice-nation/node_modules/patron.js/src/structures/Handler.js:25:22)
    at Object.<anonymous> (/home/johnpyp/Desktop/Coding/dice-nation/src/events/message.js:10:17)
    at Module._compile (module.js:660:30)
    at Object.Module._extensions..js (module.js:671:10)
    at Module.load (module.js:573:32)
    at tryModuleLoad (module.js:513:12)
    at Function.Module._load (module.js:505:3)
    at Module.require (module.js:604:17)
    at require (internal/module.js:11:18)

People deserve the truth

Maybe you should list some of the actual good frameworks, and not lie to people that yours is the "only" real flexible one, because that's just a big lie. You base this off of frameworks that are either in a heavy development stage (discord.js-commando) or haven't even looked at the ones listed below 👍

• https://github.com/1Computer1/discord-akairo
• https://github.com/zajrik/yamdbf
• https://github.com/dirigeants/klasa
• https://github.com/Gawdl3y/discord.js-commando

No support for libs other than discord.js

If this had support for eris I'd consider using it, same probably goes for other people who use discord.io or discord.ie.