Merge pull request #120 - Alias Imports

osu-cascades · Apr 26, 2020 · cca963a · cca963a
2 parents 3f538a9 + c77d701
commit cca963a
Show file tree

Hide file tree

Showing 40 changed files with 106 additions and 57 deletions.
diff --git a/__tests__/commands/add.test.ts b/__tests__/commands/add.test.ts
@@ -1,4 +1,4 @@
-import Add from '../../src/commands/add';
+import Add from '@/commands/add';
 import { message as mockMessage, MockedMessage } from '../mocks/discord';
 
 let sendMock: MockedMessage;

diff --git a/__tests__/commands/format.test.ts b/__tests__/commands/format.test.ts
@@ -1,4 +1,4 @@
-import Format from '../../src/commands/format';
+import Format from '@/commands/format';
 
 import { message as mockMessage, MockedMessage } from '../mocks/discord';
 

diff --git a/__tests__/commands/gitProfile.test.ts b/__tests__/commands/gitProfile.test.ts
@@ -1,4 +1,4 @@
-import GitProfile from '../../src/commands/gitProfile';
+import GitProfile from '@/commands/gitProfile';
 import axiosMock from '../__mocks__/axios';
 import mockGithubProfile from '../mockData/githubProfile';
 import { message as mockMessage, MockedMessage } from '../mocks/discord';

diff --git a/__tests__/commands/help.test.ts b/__tests__/commands/help.test.ts
@@ -1,5 +1,5 @@
-import Help from '../../src/commands/help';
-import Commands from '../../src/library/commands';
+import Help from '@/commands/help';
+import Commands from '@/library/commands';
 import { message as mockMessage, MockedMessage } from '../mocks/discord';
 
 // TODO: These should be in a factory/mock

diff --git a/__tests__/commands/lmgtfy.test.ts b/__tests__/commands/lmgtfy.test.ts
@@ -1,4 +1,4 @@
-import Lmgtfy from '../../src/commands/lmgtfy';
+import Lmgtfy from '@/commands/lmgtfy';
 import { message as mockMessage, MockedMessage } from '../mocks/discord';
 
 let sendMock: MockedMessage;

diff --git a/__tests__/commands/magic8ball.test.ts b/__tests__/commands/magic8ball.test.ts
@@ -1,4 +1,4 @@
-import Magic8Ball from '../../src/commands/magic8ball';
+import Magic8Ball from '@/commands/magic8ball';
 import { message as mockMessage, MockedMessage } from '../mocks/discord';
 
 let sendMock: MockedMessage;

diff --git a/__tests__/commands/rules.test.ts b/__tests__/commands/rules.test.ts
@@ -1,4 +1,4 @@
-import Rules from '../../src/commands/rules';
+import Rules from '@/commands/rules';
 
 import { message as mockMessage, MockedMessage } from '../mocks/discord';
 

diff --git a/__tests__/commands/say.test.ts b/__tests__/commands/say.test.ts
@@ -1,4 +1,4 @@
-import Say from '../../src/commands/say';
+import Say from '@/commands/say';
 
 import { message as mockMessage, MockedMessage } from '../mocks/discord';
 

diff --git a/__tests__/commands/search.test.ts b/__tests__/commands/search.test.ts
@@ -1,11 +1,11 @@
-import Search from '../../src/commands/search';
-import config from '../../src/config';
+import Search from '@/commands/search';
+import config from '@/config';
 import axiosMock from '../__mocks__/axios';
 import { message as mockMessage, MockedMessage } from '../mocks/discord';
 import { noResults, results } from './../mockData/search';
 
 jest.mock('axios');
-jest.mock('../../src/config.ts');
+jest.mock('@/config.ts');
 
 let sendMock: MockedMessage;
 beforeEach(() => {

diff --git a/__tests__/commands/source.test.ts b/__tests__/commands/source.test.ts
@@ -1,5 +1,5 @@
 import { message as mockMessage, MockedMessage } from '../mocks/discord';
-import Source from './../../src/commands/source';
+import Source from '@/commands/source';
 
 let sendMock: MockedMessage;
 beforeEach(() => {

diff --git a/__tests__/commands/version.test.ts b/__tests__/commands/version.test.ts
@@ -1,6 +1,6 @@
 import { Message } from 'discord.js';
 import { message as mockMessage, MockedMessage } from '../mocks/discord';
-import Version from './../../src/commands/version';
+import Version from '@/commands/version';
 
 let sendMock: MockedMessage;
 beforeEach(() => {

diff --git a/__tests__/commands/xmas.test.ts b/__tests__/commands/xmas.test.ts
@@ -1,4 +1,4 @@
-import Xmas from '../../src/commands/xmas';
+import Xmas from '@/commands/xmas';
 import { message as mockMessage, MockedMessage } from '../mocks/discord';
 
 let sendMock: MockedMessage;

diff --git a/__tests__/library/commandLoader.test.ts b/__tests__/library/commandLoader.test.ts
@@ -1,5 +1,5 @@
 import glob from 'glob';
-import CommandLoader, { ICommandClasses } from '../../src/library/commandLoader';
+import CommandLoader, { ICommandClasses } from '@/library/commandLoader';
 
 describe('CommandLoader', () => {
   let commandClasses: ICommandClasses;

diff --git a/__tests__/library/commandParser.test.ts b/__tests__/library/commandParser.test.ts
@@ -1,4 +1,4 @@
-import CommandParser from '../../src/library/commandParser';
+import CommandParser from '@/library/commandParser';
 
 describe('CommandParser', () => {
   const messagePrefix = 'FAKE';

diff --git a/__tests__/library/commands.test.ts b/__tests__/library/commands.test.ts
@@ -1,6 +1,6 @@
-import { ICommandClasses } from '../../src/library/commandLoader';
-import Commands from '../../src/library/commands';
-import ICommand from '../../src/library/iCommand';
+import { ICommandClasses } from '@/library/commandLoader';
+import Commands from '@/library/commands';
+import ICommand from '@/library/interfaces/iCommand';
 
 describe('Commands', () => {
   let mockHelloCommand: ICommand;

diff --git a/__tests__/mockData/githubProfile.ts b/__tests__/mockData/githubProfile.ts
@@ -1,4 +1,4 @@
-import IGithubProfile from "../../src/commands/interfaces/iGithubProfile";
+import IGithubProfile from '@/commands/interfaces/iGithubProfile';
 
 export default {
   login: "ctsstc",

diff --git a/jest.config.js b/jest.config.js
@@ -12,5 +12,9 @@ module.exports = {
     "jsx",
     "json",
     "node"
-  ]
+  ],
+  moduleNameMapper: {
+    '^@/(.*)$': '<rootDir>/src/$1',
+    '@root/(.*)$': '<rootDir>/$1'
+  }
 };
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,14 +1,14 @@
 {
   "name": "hackbot",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "description": "Discord bot for the Cascades Tech Club Discord server.",
   "repository": {
     "type": "git",
     "url": "https://github.com/osu-cascades/hackbot.git"
   },
   "main": "hackbot.js",
   "scripts": {
-    "start": "ts-node src/index.ts",
+    "start": "ts-node -r tsconfig-paths/register src/index.ts",
     "start:dev": "ts-node src/index.ts --type-check",
     "bs": "npm run build && npm start",
     "watch": "nodemon build/hackbot.js",
@@ -43,6 +43,7 @@
   "devDependencies": {
     "jest": "^25.1.0",
     "ts-jest": "^25.1.0",
+    "tsconfig-paths": "^3.9.0",
     "tslint": "^5.11.0"
   }
 }
diff --git a/src/commands/_template.ts b/src/commands/_template.ts
@@ -1,5 +1,5 @@
+import ICommand from '@/library/interfaces/iCommand';
 import { Message } from 'discord.js';
-import ICommand from '../library/iCommand';
 
 // Hack for implementing with static properties/methods
 let CommandName: ICommand;

diff --git a/src/commands/add.ts b/src/commands/add.ts
@@ -1,5 +1,5 @@
 import { Message } from "discord.js";
-import ICommand from "../library/iCommand";
+import ICommand from "@/library/interfaces/iCommand";
 
 let Add: ICommand;
 

diff --git a/src/commands/format.ts b/src/commands/format.ts
@@ -1,5 +1,5 @@
 import { Message } from 'discord.js';
-import ICommand from '../library/iCommand';
+import ICommand from '@/library/interfaces/iCommand';
 
 // Hack for implementing with static properties/methods
 let Format: ICommand;

diff --git a/src/commands/gitProfile.ts b/src/commands/gitProfile.ts
@@ -1,7 +1,7 @@
 import axios from 'axios';
 import { Message } from 'discord.js';
 import moment from 'moment';
-import ICommand from '../library/iCommand';
+import ICommand from '@/library/interfaces/iCommand';
 import IGithubProfile from './interfaces/iGithubProfile';
 
 let GitProfile: ICommand;

diff --git a/src/commands/help.ts b/src/commands/help.ts
@@ -1,7 +1,7 @@
 import { Message } from 'discord.js';
-import config from '../config';
-import Commands from '../library/commands';
-import ICommand from '../library/iCommand';
+import config from '@/config';
+import Commands from '@/library/commands';
+import ICommand from '@/library/interfaces/iCommand';
 
 let Help: ICommand;
 

diff --git a/src/commands/lmgtfy.ts b/src/commands/lmgtfy.ts
@@ -1,5 +1,5 @@
 import { Message } from 'discord.js';
-import ICommand from '../library/iCommand';
+import ICommand from '@/library/interfaces/iCommand';
 
 let Lmgtfy: ICommand;
 

diff --git a/src/commands/magic8ball.ts b/src/commands/magic8ball.ts
@@ -1,5 +1,5 @@
 import { Message } from 'discord.js';
-import ICommand from '../library/iCommand';
+import ICommand from '@/library/interfaces/iCommand';
 
 let Magic8Ball: ICommand;
 

diff --git a/src/commands/purge.ts b/src/commands/purge.ts
@@ -1,5 +1,5 @@
+import ICommand from '@/library/interfaces/iCommand';
 import { Client, DMChannel, Message } from 'discord.js';
-import ICommand from '../library/iCommand';
 
 let Purge: ICommand;
 

diff --git a/src/commands/rules.ts b/src/commands/rules.ts
@@ -1,5 +1,5 @@
 import { Message } from 'discord.js';
-import ICommand from '../library/iCommand';
+import ICommand from '@/library/interfaces/iCommand';
 
 let Rules: ICommand;
 

diff --git a/src/commands/say.ts b/src/commands/say.ts
@@ -1,5 +1,5 @@
 import { Message } from 'discord.js';
-import ICommand from '../library/iCommand';
+import ICommand from '@/library/interfaces/iCommand';
 
 let Say: ICommand;
 

diff --git a/src/commands/search.ts b/src/commands/search.ts
@@ -1,7 +1,7 @@
+import config from '@/config';
+import ICommand from '@/library/interfaces/iCommand';
 import axios, { AxiosResponse } from 'axios';
 import { Message } from 'discord.js';
-import config from '../config';
-import ICommand from '../library/iCommand';
 
 let Search: ICommand;
 

diff --git a/src/commands/source.ts b/src/commands/source.ts
@@ -1,5 +1,5 @@
 import { Message } from 'discord.js';
-import ICommand from '../library/iCommand';
+import ICommand from '@/library/interfaces/iCommand';
 
 let Source: ICommand;
 

diff --git a/src/commands/version.ts b/src/commands/version.ts
@@ -1,7 +1,7 @@
+import config from '@/config';
+import { version } from '@root/package.json';
 import { Message } from 'discord.js';
-import { version } from '../../package.json';
-import config from '../config';
-import ICommand from '../library/iCommand';
+import ICommand from '@/library/interfaces/iCommand';
 
 let Version: ICommand;
 

diff --git a/src/commands/weather.ts b/src/commands/weather.ts
@@ -1,7 +1,7 @@
 import axios, { AxiosResponse } from 'axios';
 import { Message } from 'discord.js';
-import config from '../config';
-import ICommand from '../library/iCommand';
+import config from '@/config';
+import ICommand from '@/library/interfaces/iCommand';
 
 let Weather: ICommand;
 

diff --git a/src/commands/xmas.ts b/src/commands/xmas.ts
@@ -1,5 +1,5 @@
 import { Message } from 'discord.js';
-import ICommand from '../library/iCommand';
+import ICommand from '@/library/interfaces/iCommand';
 
 let Xmas: ICommand;
 

diff --git a/src/index.ts b/src/index.ts
@@ -1,6 +1,6 @@
+import config from '@/config';
+import Core from '@/library/core';
 import { Client } from 'discord.js';
-import config from './config';
-import Core from './library/core';
 
 const client = new Client();
 const core = new Core(client);

diff --git a/src/library/commandLoader.ts b/src/library/commandLoader.ts
@@ -1,6 +1,6 @@
 import camelCase from 'lodash.camelcase';
 import path from 'path';
-import Command from './iCommand';
+import Command from './interfaces/iCommand';
 
 export interface ICommandClasses { [key: string]: Command; }
 

diff --git a/src/library/commands.ts b/src/library/commands.ts
@@ -1,5 +1,5 @@
 import { ICommandClasses } from './commandLoader';
-import Command from './iCommand';
+import Command from './interfaces/iCommand';
 
 // TODO: debateable whether we even need this wrapper class
 /**

diff --git a/src/library/core.ts b/src/library/core.ts
@@ -1,6 +1,6 @@
+import config from '@/config';
 import { Client, GuildMember, Message, TextChannel } from 'discord.js';
 import glob from 'glob';
-import config from '../config';
 import CommandLoader from './commandLoader';
 import CommandParser from './commandParser';
 import Commands from './commands';

diff --git a/src/library/iCommand.ts → src/library/interfaces/iCommand.ts b/src/library/iCommand.ts → src/library/interfaces/iCommand.ts
@@ -1,5 +1,5 @@
 import { Client, Message } from "discord.js";
-import Commands from "./commands";
+import Commands from "@/commands";
 
 /**
  * An interface for all commands to extend, representing the API that all