@erisa/commands - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4-0

dist/index.d.ts

@@ -1,28 +0,9 @@
-import { Erisa, Matchable, MiddlewareHandler } from 'erisa';
-import Context from './Context';
-import { default as defaultHelp } from './defaultHelp';
-export { default as SubCommand, decorator as subcommand } from './SubCommand';
-export { default as Context, ContextDestinations, PermissionTargets } from './Context';
-export { default as Command } from './Command';
-export { default as Holder } from './Holder';
-export { default as parseArgs } from './parseArgs';
-export { default as Paginator } from './Paginator';
-export { default as Constants } from './Constants';
-export declare const DefaultHelp: typeof defaultHelp;
-export interface ICommandPermissions {
-    self: string | string[];
-    author: string | string[];
-    both: string | string[];
-}
-interface CommandHandlerOptionsOptionals {
-    commandDirectory?: string;
-    autoLoad?: boolean;
-    defaultHelp?: boolean;
-    contextClass?: typeof Context;
-}
-interface CommandHandlerOptionsRequired {
-    owner: string;
-    prefixes: (string | RegExp)[];
-}
-declare type CommandHandlerOptions = CommandHandlerOptionsOptionals & CommandHandlerOptionsRequired;
-export default function setup(erisa: Erisa, options: CommandHandlerOptions): [Matchable, MiddlewareHandler][];
+export { default as SubCommand, decorator as subcommand } from './src/SubCommand';
+export { default as Context, ContextDestinations, PermissionTargets, GuildContext, DMContext } from './src/Context';
+export { default as Command } from './src/Command';
+export { default as Holder } from './src/Holder';
+export { parseArgs, parseOpts } from './src/parseArgs';
+export { default as Paginator } from './src/Paginator';
+export { default as Constants } from './src/Constants';
+export { default as DefaultHelp } from './src/defaultHelp';
+export { default as default, ICommandOpts, ICommandPermissions } from './src';

dist/index.js

 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const eris_1 = require("eris");
-const Context_1 = __importDefault(require("./Context"));
-const Holder_1 = __importDefault(require("./Holder"));
-const defaultHelp_1 = __importDefault(require("./defaultHelp"));
-var SubCommand_1 = require("./SubCommand");
+var SubCommand_1 = require("./src/SubCommand");
 exports.SubCommand = SubCommand_1.default;
 exports.subcommand = SubCommand_1.decorator;
-var Context_2 = require("./Context");
-exports.Context = Context_2.default;
-var Command_1 = require("./Command");
+var Context_1 = require("./src/Context");
+exports.Context = Context_1.default;
+exports.GuildContext = Context_1.GuildContext;
+exports.DMContext = Context_1.DMContext;
+var Command_1 = require("./src/Command");
 exports.Command = Command_1.default;
-var Holder_2 = require("./Holder");
-exports.Holder = Holder_2.default;
-var parseArgs_1 = require("./parseArgs");
-exports.parseArgs = parseArgs_1.default;
-var Paginator_1 = require("./Paginator");
+var Holder_1 = require("./src/Holder");
+exports.Holder = Holder_1.default;
+var parseArgs_1 = require("./src/parseArgs");
+exports.parseArgs = parseArgs_1.parseArgs;
+exports.parseOpts = parseArgs_1.parseOpts;
+var Paginator_1 = require("./src/Paginator");
 exports.Paginator = Paginator_1.default;
-var Constants_1 = require("./Constants");
+var Constants_1 = require("./src/Constants");
 exports.Constants = Constants_1.default;
-exports.DefaultHelp = defaultHelp_1.default; // tslint:disable-line variable-name
-const defaults = {
-    commandDirectory: './commands',
-    autoLoad: true,
-    defaultHelp: true,
-    contextClass: Context_1.default
-};
-function setup(erisa, options) {
-    const mergedOpts = {
-        commandDirectory: (options.commandDirectory || defaults.commandDirectory),
-        autoLoad: (options.autoLoad !== undefined ? options.autoLoad : defaults.autoLoad),
-        defaultHelp: (options.defaultHelp !== undefined ? options.defaultHelp : defaults.defaultHelp),
-        contextClass: (options.contextClass || defaults.contextClass),
-        owner: options.owner,
-        prefixes: options.prefixes
-    };
-    const holder = erisa.extensions.commands = new Holder_1.default(erisa, mergedOpts.prefixes, mergedOpts.owner);
-    if (!erisa.eventNames().includes('rawWS'))
-        erisa.on('rawWS', erisa.handleEvent('rawWS')); // Needed so that Eris fires rawWS events at all.
-    if (mergedOpts.defaultHelp)
-        holder.add(defaultHelp_1.default, 'help');
-    return [
-        [
-            'rawWS',
-            function handler({ erisa: client, event }, packet) {
-                return __awaiter(this, void 0, void 0, function* () {
-                    if (packet.op !== eris_1.Constants.GatewayOPCodes.EVENT || packet.t !== 'MESSAGE_CREATE' ||
-                        !packet.d.content || !holder.testPrefix(packet.d.content)[0])
-                        return;
-                    const ctx = new mergedOpts.contextClass(packet.d, client);
-                    try {
-                        yield holder.run(ctx);
-                        client.emit('erisa.commands.run', ctx);
-                    }
-                    catch (err) {
-                        yield ctx.send(`There was an error when trying to run your command:\n${err}`);
-                    }
-                });
-            }
-        ],
-        [
-            'ready',
-            function handler({ erisa: client }) {
-                return __awaiter(this, void 0, void 0, function* () {
-                    yield holder.loadAll(mergedOpts.commandDirectory, true);
-                    client.emit('erisa.commands.loaded');
-                });
-            }
-        ]
-    ];
-}
-exports.default = setup;
+var defaultHelp_1 = require("./src/defaultHelp");
+exports.DefaultHelp = defaultHelp_1.default;
+var src_1 = require("./src");
+exports.default = src_1.default;

package.json

 {
   "name": "@erisa/commands",
-  "version": "0.0.3",
+  "version": "0.0.4-0",
   "description": "The default commands framework for Erisa.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "repository": "https://github.com/Ovyerus/erisa",
+  "repository": "https://github.com/erisaaa/commands",
   "author": "Ovyerus <[e-mail]>",
   "license": "MIT",
+  "files": [
+    "dist/"
+  ],
   "scripts": {
-    "lint": "tslint -p . -c ../../tslint.json",
+    "test": "mocha",
+    "coverage": "nyc mocha",
+    "lint": "tslint -p . -c tslint.json",
     "compile": "tsc -p .",
@@ -18,15 +23,46 @@ "clean": "rimraf dist",
   "dependencies": {
-    "eris": "^0.8.6"
+    "getopts": "^2.2.2",
+    "split-string": "^6.0.0"
   },
   "peerDependencies": {
-    "erisa": "^0.0.2"
+    "eris": "^0.9.0",
+    "erisa": "^0.0.3"
   },
   "devDependencies": {
+    "@types/chai": "^4.1.6",
+    "@types/chai-as-promised": "^7.1.0",
+    "@types/mocha": "^5.2.5",
+    "@types/node": "^10.12.0",
+    "chai": "^4.2.0",
+    "chai-as-promised": "^7.1.1",
+    "erisa": "^0.0.3",
+    "mocha": "^5.2.0",
+    "nyc": "^13.1.0",
     "rimraf": "^2.6.2",
+    "source-map-support": "^0.5.9",
+    "ts-node": "^7.0.1",
     "tslint": "^5.11.0",
-    "typescript": "^2.9.2"
+    "typescript": "^3.1.3"
   },
-  "publishConfig": {
-    "access": "public"
+  "nyc": {
+    "include": [
+      "src/**/*.ts"
+    ],
+    "exclude": [
+      "test/**/*.test.ts"
+    ],
+    "extension": [
+      ".ts"
+    ],
+    "require": [
+      "ts-node/register"
+    ],
+    "reporter": [
+      "text-summary",
+      "html",
+      "lcov"
+    ],
+    "sourceMap": true,
+    "instrument": true
   }
 }

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Fixed alerts

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

44246

decreased by-33.02%

Dependency count

4

increased by100%

Dev dependency count

14

increased by366.67%

Number of package files

23

decreased by-23.33%

Lines of code

997

decreased by-35.05%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedgetopts@^2.2.2

• + Addedsplit-string@^6.0.0

• + Addederis@0.9.0(transitive)

• + Addederisa@0.0.3(transitive)

• + Addedgetopts@2.3.0(transitive)

• + Addedsplit-string@6.1.0(transitive)

• + Addedws@6.2.3(transitive)

• - Removederis@^0.8.6

• - Removederisa@0.0.2(transitive)