ci(Testing): add TypeScript test job (#4002)

* ci(Testing): add TypeScript job

* chore: add eol before eof

.github/tsc.json

@@ -0,0 +1,18 @@
+{
+  "problemMatcher": [
+      {
+          "owner": "tsc",
+          "pattern": [
+              {
+                  "regexp": "^(?:\\s+\\d+\\>)?([^\\s].*)\\((\\d+),(\\d+)\\)\\s*:\\s+(error|warning|info)\\s+(\\w{1,2}\\d+)\\s*:\\s*(.*)$",
+                  "file": 1,
+                  "line": 2,
+                  "column": 3,
+                  "severity": 4,
+                  "code": 5,
+                  "message": 6
+              }
+          ]
+      }
+  ]
+}

.github/workflows/test-cron.yml

@@ -39,6 +39,27 @@ jobs:
       - name: Run TSLint
         run: npm run lint:typings
 
+  typescript:
+    name: TypeScript
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install Node v12
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Register Problem Matcher
+        run: echo "##[add-matcher].github/tsc.json"
+
+      - name: Run TypeScript compiler
+        run: npm run test:typescript
+
   docs:
     name: Documentation
     runs-on: ubuntu-latest

.github/workflows/test.yml

@@ -37,6 +37,27 @@ jobs:
       - name: Run TSLint
         run: npm run lint:typings
 
+  typescript:
+    name: TypeScript
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install Node v12
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Register Problem Matcher
+        run: echo "##[add-matcher].github/tsc.json"
+
+      - name: Run TypeScript compiler
+        run: npm run test:typescript
+
   docs:
     name: Documentation
     runs-on: ubuntu-latest

.gitignore

@@ -19,4 +19,5 @@ deploy/deploy_key.pub
 .tmp/
 .vscode/
 docs/docs.json
+typings/index.js
 webpack/

package.json

@@ -6,6 +6,7 @@
   "types": "./typings/index.d.ts",
   "scripts": {
     "test": "npm run lint && npm run docs:test && npm run lint:typings",
+    "test:typescript": "tsc",
     "docs": "docgen --source src --custom docs/index.yml --output docs/docs.json",
     "docs:test": "docgen --source src --custom docs/index.yml",
     "lint": "eslint src",

tsconfig.json

@@ -5,11 +5,17 @@
     "declaration": false,
     "removeComments": false,
     "alwaysStrict": true,
-    "pretty": true,
+    "pretty": false,
     "module": "commonjs",
     "target": "es2019",
-    "lib": ["esnext", "esnext.array", "esnext.asynciterable", "esnext.intl", "esnext.symbol"],
+    "lib": [
+      "esnext",
+      "esnext.array",
+      "esnext.asynciterable",
+      "esnext.intl",
+      "esnext.symbol"
+    ],
     "sourceMap": false,
-    "skipLibCheck": true
+    "skipDefaultLibCheck": true
   }
 }

typings/index.ts

@@ -0,0 +1,28 @@
+/// <reference path="index.d.ts" />
+
+import { Client } from 'discord.js';
+
+const client: Client = new Client();
+
+client.on('ready', () => {
+  console.log(`Client is logged in as ${client.user!.tag} and ready!`);
+});
+
+client.on('guildCreate', g => {
+  const channel = g.channels.cache.random();
+  if (!channel) return;
+
+  channel.setName('foo').then(updatedChannel => {
+    console.log(`New channel name: ${updatedChannel.name}`);
+  });
+});
+
+client.on('messageReactionRemoveAll', async message => {
+  console.log(`messageReactionRemoveAll - id: ${message.id} (${message.id.length})`);
+
+  if (message.partial) message = await message.fetch();
+
+  console.log(`messageReactionRemoveAll - content: ${message.content}`);
+});
+
+client.login('absolutely-valid-token');