typings/docs: Various Typescript adjustement (#78)

Khaaz · May 5, 2020 · 41315e3 · 41315e3
1 parent 2d8b708
commit 41315e3
Show file tree

Hide file tree

Showing 38 changed files with 53 additions and 22 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -27,7 +27,8 @@
               "requireLast": true
             }
           }
-        ]
+        ],
+        "@typescript-eslint/ban-ts-ignore": 0
       }
     }
   ]

diff --git a/index.d.ts b/index.d.ts
@@ -1,2 +1,6 @@
+/* eslint-disable @typescript-eslint/ban-ts-ignore */
 import * as AxonCore from './types';
-export = AxonCore;
+declare module 'axoncore' {
+    // @ts-ignore
+    export = AxonCore;
+}
diff --git a/types/AxonClient.ts b/types/AxonClient.ts
@@ -2,9 +2,8 @@ import { EventEmitter } from 'events';
 import {
     AxonConfs, AxonParams, Info, AxonInfo, ALogger, AxonUtils, LibClient, LibraryInterface, Utils, ADBProvider, ModuleRegistry, CommandRegistry, ListenerRegistry,
     EventManager, GuildConfigCache, AxonConfig, ModuleLoader, CommandDispatcher, MessageManager, AxonStaffIDs, AxonOptions, Collection, AHandler, Listener, Resolver,
-    Webhooks, AxonTemplate, Module, Command, LOG_LEVELS, Ctx, LibMessage, GuildConfig, DEBUG_FLAGS,
+    Webhooks, AxonTemplate, Module, Command, LOG_LEVELS, Ctx, LibMessage, GuildConfig, DEBUG_FLAGS, Executor,
 } from './';
-import { Executor } from '..';
 
 export declare class AxonClient extends EventEmitter {
     /** Configs (webhooks, template, custom) */

diff --git a/types/Database/ADBProvider.ts b/types/Database/ADBProvider.ts
@@ -1,6 +1,6 @@
 import {
     AxonClient, AxonOptions, AxonConfig, GuildConfig, updateDBVal,
-} from '../../';
+} from '..';
 
 /**
  * Abstract class for all DB services.

diff --git a/types/Database/DBSelector.ts b/types/Database/DBSelector.ts
@@ -1,6 +1,6 @@
 import {
     ASelector, AxonClient, AxonOptions, InMemoryProvider, JsonProvider, MongoProvider,
-} from '../../';
+} from '..';
 
 /**
  * Database Selector

diff --git a/types/Database/InMemoryProvider.ts b/types/Database/InMemoryProvider.ts
@@ -1,6 +1,6 @@
 import {
     ADBProvider, AxonConfig, GuildConfig, Module, Command, Listener,
-} from '../../';
+} from '..';
 
 /**
  * A schema designed use an InMemory solution in AxonCore

diff --git a/types/Database/JsonProvider.ts b/types/Database/JsonProvider.ts
@@ -1,6 +1,6 @@
 import {
     ADBProvider, JsonManager, AxonOptions, AxonConfig, GuildConfig, updateDBVal,
-} from '../../';
+} from '..';
 
 /**
  * DB interface to interact with a Json Database.

diff --git a/types/Database/MongoProvider.ts b/types/Database/MongoProvider.ts
@@ -1,7 +1,8 @@
+// @ts-ignore
 import { Model } from 'mongoose';
 import {
-    ADBProvider, AxonConfig, GuildConfig, AxonOptions, GuildSchema, updateDBVal,
-} from '../../';
+    ADBProvider, AxonConfig, GuildConfig, AxonOptions, GuildSchema, updateDBVal, AxonSchema,
+} from '..';
 
 /**
  * DB interface to interact with a MongoDB Database.
@@ -12,8 +13,8 @@ import {
  * @extends ADBProvider
  */
 export declare class MongoProvider extends ADBProvider {
-    public AxonSchema?: AxonConfig;
-    public GuildSchema?: GuildConfig;
+    public AxonSchema?: AxonSchema;
+    public GuildSchema?: GuildSchema;
 
     /**
      * Override init method.

diff --git a/types/Error/AxonCommandError.ts b/types/Error/AxonCommandError.ts
@@ -1,4 +1,4 @@
-import { CommandContext } from '../../';
+import { CommandContext } from '..';
 /**
  * Custom error with better formatting and context informations.
  * Used for errors thrown by AxonCore commands.

diff --git a/types/Error/AxonError.ts b/types/Error/AxonError.ts
@@ -1,4 +1,4 @@
-import { Module } from '../../';
+import { Module } from '..';
 
 /**
  * Custom error with better formatting + information about where the error is originated from.

diff --git a/types/Langs/MessageManager.ts b/types/Langs/MessageManager.ts
@@ -1,6 +1,6 @@
 import {
     AxonClient, Languages, TranslationManager, MessageParser, AxonLanguageResponse,
-} from '../../';
+} from '..';
 
 /**
  * Holds all messages.

diff --git a/types/Langs/MessageParser.ts b/types/Langs/MessageParser.ts
@@ -1,4 +1,4 @@
-import { AxonLanguageResponse } from '../../';
+import { AxonLanguageResponse } from '..';
 
 /**
  * Parse a message and replace custom variable with arguments

diff --git a/types/Langs/TranslationManager.ts b/types/Langs/TranslationManager.ts
@@ -1,4 +1,4 @@
-import { MessageManager, Languages, AxonLanguageResponse } from '../../';
+import { MessageManager, Languages, AxonLanguageResponse } from '..';
 
 /**
  * Class dedicated to manage translations.

diff --git a/types/Libraries/definitions/Message.ts b/types/Libraries/definitions/Message.ts
@@ -1,6 +1,6 @@
 import {
     LibraryInterface, LibMessage, LibUser, LibMember, LibTextableChannel, LibGuild, AxonMSGCont,
-} from '../../../';
+} from '../..';
 
 export declare class Message {
     public lib: LibraryInterface;

diff --git a/types/Libraries/definitions/Resolver.ts b/types/Libraries/definitions/Resolver.ts
@@ -1,6 +1,6 @@
 import {
     LibClient, LibUser, LibGuild, LibMember, LibRole, LibChannel,
-} from '../../../';
+} from '../..';
 
 /**
  * Static Resolver class for AxonCore

diff --git a/types/Libraries/definitions/User.ts b/types/Libraries/definitions/User.ts
@@ -1,4 +1,4 @@
-import { LibraryInterface, LibUser, LibDMChannel } from '../../../';
+import { LibraryInterface, LibUser, LibDMChannel } from '../..';
 
 export declare class User {
     public lib: LibraryInterface;

diff --git a/types/Libraries/definitions/types.ts b/types/Libraries/definitions/types.ts
@@ -1,4 +1,6 @@
+// @ts-ignore
 import * as Eris from 'eris';
+// @ts-ignore
 import * as Djs from 'discord.js';
 
 declare type LibMessage = Eris.Message | Djs.Message;

diff --git a/types/Libraries/discordjs/Channel.ts b/types/Libraries/discordjs/Channel.ts
@@ -1,5 +1,5 @@
 import * as djs from 'discord.js';
-import { DjsContent } from '../../../';
+import { DjsContent } from '../../';
 import { Channel } from '../definitions/Channel';
 import { DISCORD_LIB_PERMISSIONS } from './Enums';
 

diff --git a/types/Libraries/discordjs/Client.ts b/types/Libraries/discordjs/Client.ts
@@ -1,6 +1,7 @@
-import { DjsPresenceGame, DjsWebhookContent, WebhookResponse } from '../../../';
+import { DjsPresenceGame, DjsWebhookContent, WebhookResponse } from '../../';
 import { DjsInterface } from './LibraryInterface';
 import { Client } from '../definitions/Client';
+// @ts-ignore
 import * as djs from 'discord.js';
 
 export declare class DjsClient extends Client {

diff --git a/types/Libraries/discordjs/Guild.ts b/types/Libraries/discordjs/Guild.ts
@@ -1,4 +1,5 @@
 import { Guild } from '../definitions/Guild';
+// @ts-ignore
 import * as djs from 'discord.js';
 
 export declare class DjsGuild extends Guild {

diff --git a/types/Libraries/discordjs/LibraryInterface.ts b/types/Libraries/discordjs/LibraryInterface.ts
@@ -7,6 +7,7 @@ import { DjsGuild } from './Guild';
 import { DjsResolver } from './Resolver';
 import { DjsClient } from './Client';
 import { DjsEnums } from './Enums';
+// @ts-ignore
 import * as djs from 'discord.js';
 
 export declare class DjsInterface extends LibraryInterface {

diff --git a/types/Libraries/discordjs/Member.ts b/types/Libraries/discordjs/Member.ts
@@ -1,4 +1,5 @@
 import { Member } from '../definitions/Member';
+// @ts-ignore
 import * as djs from 'discord.js';
 import { DISCORD_LIB_PERMISSIONS } from './Enums';
 

diff --git a/types/Libraries/discordjs/Message.ts b/types/Libraries/discordjs/Message.ts
@@ -1,4 +1,5 @@
 import { Message } from '../definitions/Message';
+// @ts-ignore
 import * as djs from 'discord.js';
 import { DjsContent } from '../../';
 

diff --git a/types/Libraries/discordjs/Resolver.ts b/types/Libraries/discordjs/Resolver.ts
@@ -1,4 +1,5 @@
 import { Resolver } from '../definitions/Resolver';
+// @ts-ignore
 import * as djs from 'discord.js';
 
 export declare class DjsResolver extends Resolver {

diff --git a/types/Libraries/discordjs/User.ts b/types/Libraries/discordjs/User.ts
@@ -1,4 +1,5 @@
 import { User } from '../definitions/User';
+// @ts-ignore
 import * as djs from 'discord.js';
 
 export declare class DjsUser extends User {

diff --git a/types/Libraries/discordjs/types.ts b/types/Libraries/discordjs/types.ts
@@ -1,5 +1,6 @@
 import {
     Message, GuildMember, Client, Guild, User, TextChannel, Role, Channel, DMChannel, PermissionOverwrites, MessageMentionOptions,
+    // @ts-ignore
 } from 'discord.js';
 
 declare type LibMessage = Message;

diff --git a/types/Libraries/eris/Channel.ts b/types/Libraries/eris/Channel.ts
@@ -1,4 +1,5 @@
 import { Channel } from '../definitions/Channel';
+// @ts-ignore
 import * as Eris from 'eris';
 import { DISCORD_LIB_PERMISSIONS } from './Enums';
 import { ErisContent } from '../../';

diff --git a/types/Libraries/eris/Client.ts b/types/Libraries/eris/Client.ts
@@ -1,4 +1,5 @@
 import { Client } from '../definitions/Client';
+// @ts-ignore
 import * as Eris from 'eris';
 import { ErisPresenceGame, ErisWebhookContent, WebhookResponse } from '../../';
 

diff --git a/types/Libraries/eris/Guild.ts b/types/Libraries/eris/Guild.ts
@@ -1,4 +1,5 @@
 import { Guild } from '../definitions/Guild';
+// @ts-ignore
 import * as Eris from 'eris';
 
 export declare class ErisGuild extends Guild {

diff --git a/types/Libraries/eris/LibraryInterface.ts b/types/Libraries/eris/LibraryInterface.ts
@@ -7,6 +7,7 @@ import { ErisMessage } from './Message';
 import { ErisResolver } from './Resolver';
 import { ErisClient } from './Client';
 import { ErisEnums } from './Enums';
+// @ts-ignore
 import * as Eris from 'eris';
 
 export declare class ErisInterface extends LibraryInterface {

diff --git a/types/Libraries/eris/Member.ts b/types/Libraries/eris/Member.ts
@@ -1,4 +1,5 @@
 import { Member } from '../definitions/Member';
+// @ts-ignore
 import * as Eris from 'eris';
 import { DISCORD_LIB_PERMISSIONS } from './Enums';
 

diff --git a/types/Libraries/eris/Message.ts b/types/Libraries/eris/Message.ts
@@ -1,4 +1,5 @@
 import { Message } from '../definitions/Message';
+// @ts-ignore
 import * as Eris from 'eris';
 import { ErisContent } from '../../';
 

diff --git a/types/Libraries/eris/Resolver.ts b/types/Libraries/eris/Resolver.ts
@@ -1,4 +1,5 @@
 import { Resolver } from '../definitions/Resolver';
+// @ts-ignore
 import * as Eris from 'eris';
 
 /**

diff --git a/types/Libraries/eris/User.ts b/types/Libraries/eris/User.ts
@@ -1,4 +1,5 @@
 import { User } from '../definitions/User';
+// @ts-ignore
 import * as Eris from 'eris';
 
 export declare class ErisUser extends User {

diff --git a/types/Libraries/eris/types.ts b/types/Libraries/eris/types.ts
@@ -1,5 +1,6 @@
 import {
     Message, Member, Client, Guild, User, TextableChannel, Role, Channel, PrivateChannel, Permission, PermissionOverwrite, AllowedMentions,
+    // @ts-ignore
 } from 'eris';
 
 declare type LibMessage = Message;

diff --git a/types/Loggers/SignaleLogger.ts b/types/Loggers/SignaleLogger.ts
@@ -1,4 +1,5 @@
 import { ALogger } from '../';
+// @ts-ignore
 import { Signale } from 'signale';
 
 /**

diff --git a/types/Loggers/WinstonLogger.ts b/types/Loggers/WinstonLogger.ts
@@ -1,4 +1,5 @@
 import { ALogger } from '../';
+// @ts-ignore
 import * as Winston from 'winston';
 
 export declare class WinstonLogger extends ALogger {

diff --git a/types/misc/interfaces.ts b/types/misc/interfaces.ts
@@ -2,7 +2,9 @@ import {
     CommandOptions, CommandPermissions, LibTextableChannel, LibMember, LibMessage, Command, LibGuild, LibUser, LIBRARY_TYPES, LOGGER_TYPES, DB_TYPES,
     Utils, ALogger, ADBProvider, AxonConfig, GuildConfig, User, Member, Message, Channel, Guild, Resolver, Embed, COMMAND_EXECUTION_TYPES, LibAllowedMentions,
 } from '../';
+// @ts-ignore
 import * as djs from 'discord.js';
+// @ts-ignore
 import * as Eris from 'eris';
 
 interface ModuleInfo {
@@ -380,6 +382,7 @@ interface CommandData {
 interface AxonTemplate {
     embeds: {[key: string]: number;};
     emotes: {[key: string]: string;};
+    [key: string]: {[key: string]: unknown;};
 }
 
 interface ListenerInfo {
@@ -719,11 +722,13 @@ interface AxonOptionsInfo {
     description: string;
     /** The application version */
     version: string;
+    [key: string]: string;
 }
 
 interface AxonOptionsStaff {
     owners: {name: string; id: string;}[];
     admins: {name: string; id: string;}[];
+    [key: string]: {name: string; id: string;}[];
 }
 
 interface AxonOptionsExtensions {
-Original file line number
+Diff line change
@@ Expand Up / @@ -27,7 +27,8 @@ @@
                   "requireLast": true
                 }
               }
-            ]
+            ],
+            "@typescript-eslint/ban-ts-ignore": 0
           }
         }
       ]
@@ Expand Down @@