refactor: typescript migration #24

Merged
Anri merged 10 commits from ts-migration into main 2022-07-20 23:01:49 +02:00
16 changed files with 1662 additions and 1665 deletions

View file

@ -4,3 +4,4 @@
!package.json !package.json
!package-lock.json !package-lock.json
!LICENCE !LICENCE
!tsconfig.json

View file

@ -1,13 +1,16 @@
{ {
"extends": "eslint:recommended",
"env": { "extends": [
"node": true, "eslint:recommended",
"es6": true "plugin:@typescript-eslint/recommended"
}, ],
"parser": "@typescript-eslint/parser",
"parserOptions": { "parserOptions": {
"ecmaVersion": 2021, "project": ["./tsconfig.json"]
"sourceType": "module"
}, },
"plugins": [
"@typescript-eslint"
],
"rules": { "rules": {
"arrow-spacing": ["warn", { "before": true, "after": true }], "arrow-spacing": ["warn", { "before": true, "after": true }],
"brace-style": ["error"], "brace-style": ["error"],

3
.gitignore vendored
View file

@ -6,3 +6,6 @@ node_modules/
# Docker # Docker
docker-compose.yml docker-compose.yml
# JS generated files
dist/

View file

@ -10,4 +10,8 @@ WORKDIR /app
COPY --chown=node:node . . COPY --chown=node:node . .
RUN npm ci --only=production RUN npm ci --only=production
CMD ["dumb-init", "node", "src/index.js"] RUN npx tsc
RUN rm -r src/ tsconfig.json
CMD ["dumb-init", "node", "./dist/index.js"]

2969
package-lock.json generated

File diff suppressed because it is too large Load diff

View file

@ -4,9 +4,9 @@
"description": "Bot discord", "description": "Bot discord",
"main": "src/index.js", "main": "src/index.js",
"scripts": { "scripts": {
"main": "node .", "main": "npx tsc && node ./dist/index.js",
"debug": "nodemon .", "debug": "npx tsnd --respawn ./src/index.ts",
"eslint": "npx eslint src" "lint": "npx eslint src"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
@ -17,12 +17,14 @@
"dependencies": { "dependencies": {
"@discordjs/rest": "^0.5.0", "@discordjs/rest": "^0.5.0",
"discord-api-types": "^0.36.0", "discord-api-types": "^0.36.0",
"discord.js": "^13.8.1" "discord.js": "^13.8.1",
"typescript": "^4.7.4"
}, },
"devDependencies": { "devDependencies": {
"@typescript-eslint/eslint-plugin": "^5.30.7",
"@typescript-eslint/parser": "^5.30.7",
"dotenv": "^16.0.1", "dotenv": "^16.0.1",
"eslint": "^8.13.0", "eslint": "^8.20.0",
"nodemon": "^2.0.18" "ts-node-dev": "^2.0.0"
}, }
"type": "module"
} }

View file

@ -1,19 +1,20 @@
import { REST } from '@discordjs/rest'; import { REST } from '@discordjs/rest';
import { Routes } from 'discord-api-types/v9'; import { Routes } from 'discord-api-types/v9';
import { Client } from 'discord.js';
import { readdir } from 'fs/promises'; import { readdir } from 'fs/promises';
export default async client => { export default async (client: Client) => {
const rest = new REST({ version: '9' }).setToken(client.token); const rest = new REST({ version: '9' }).setToken(client.token ?? '');
const command_categories = (await readdir('./src/commands')) const command_categories = (await readdir(__dirname))
.filter(element => !element.endsWith('.js')); .filter(element => !element.endsWith('.js') && !element.endsWith('.ts'));
const commands = ( const commands = (
await Promise.all( await Promise.all(
// For each categorie // For each categorie
command_categories.map(async command_category => { command_categories.map(async command_category => {
// Retrieve all the commands // Retrieve all the commands
const command_files = await readdir(`./src/commands/${command_category}`); const command_files = await readdir(`${__dirname}/${command_category}`);
// Add the command // Add the command
return Promise.all( return Promise.all(
@ -31,7 +32,7 @@ export default async client => {
) )
).flat(2); ).flat(2);
return await rest.put(Routes.applicationCommands(client.user.id), { return await rest.put(Routes.applicationCommands(client.user?.id ?? ''), {
body: commands, body: commands,
}); });
}; };

View file

@ -1,13 +1,13 @@
import { SlashCommandBuilder } from '@discordjs/builders'; import { SlashCommandBuilder } from '@discordjs/builders';
import { Client, CommandInteraction, Message } from 'discord.js';
export default { export default {
data: new SlashCommandBuilder() data: new SlashCommandBuilder()
.setName('ping') .setName('ping')
.setDescription('Pong!'), .setDescription('Pong!'),
interaction: async (interaction, client) => { interaction: async (interaction: CommandInteraction, client: Client) => {
const sent = await interaction.reply({ content: 'Pinging...', fetchReply: true }) as Message;
const sent = await interaction.reply({ content: 'Pinging...', fetchReply: true });
interaction.editReply( interaction.editReply(
`Roundtrip latency: \ `Roundtrip latency: \

View file

@ -1,4 +1,6 @@
export default (interaction, client) => { import { Client, Interaction } from 'discord.js';
export default (interaction: Interaction, client: Client) => {
if (interaction.isCommand()) { if (interaction.isCommand()) {
const command = client.commands.get(interaction.commandName); const command = client.commands.get(interaction.commandName);
if (!command) { if (!command) {

View file

@ -1,12 +1,13 @@
import { Client } from 'discord.js';
import { readdir } from 'fs/promises'; import { readdir } from 'fs/promises';
export default async client => { export default async (client: Client) => {
const events_categories = (await readdir('./src/events')) const events_categories = (await readdir(__dirname))
.filter(element => !element.endsWith('.js')); .filter(element => !element.endsWith('.js') && !element.endsWith('.ts'));
events_categories.forEach(async event_category => { events_categories.forEach(async event_category => {
// Retrieve events // Retrieve events
const events = await readdir(`./src/events/${event_category}`); const events = await readdir(`${__dirname}/${event_category}`);
// Load them into the client // Load them into the client
Promise.all( Promise.all(
@ -15,12 +16,13 @@ export default async client => {
`../events/${event_category}/${event_file}` `../events/${event_category}/${event_file}`
); );
// Remove .js // Remove extension
let event_type = event_file.split('.'); const event_type_ext = event_file.split('.');
if (event_type.pop() !== 'js') { const ext = event_type_ext.pop();
if (!(ext === 'js' || ext === 'ts')) {
throw `Unknown file in ${event_category}: ${event_file}`; throw `Unknown file in ${event_category}: ${event_file}`;
} }
event_type = event_type.join('.'); const event_type = event_type_ext.join('.');
if (once) { if (once) {
return client.once(event_type, (...args) => { return client.once(event_type, (...args) => {

View file

@ -1,39 +0,0 @@
import loadClient from './utils/client.js';
import loadEvents from './events/loader.js';
import loadCommands from './commands/loader.js';
const run = async () => {
console.log('Starting Botanique...');
// Load .env if not in prod
if (process.env.NODE_ENV !== 'production') {
(await import('dotenv')).config({ path: './config/.env' });
}
// Client Discord.JS
const client = await loadClient()
.catch(() => {
throw 'Client ❌';
});
if (client) {
console.log('Client ✅');
}
await loadEvents(client)
.then(console.log('Events ✅'))
.catch(() => {
throw 'Events ❌';
});
await client.login(client.config.token_discord);
await loadCommands(client)
.then(console.log('Commands ✅'))
.catch(() => {
throw 'Commands ❌';
});
console.log(`Botanique "${client.user.username}" ${client.config.version} started!`);
};
run().catch(error => console.error(error));

40
src/index.ts Normal file
View file

@ -0,0 +1,40 @@
import loadClient from './utils/client';
import loadEvents from './events/loader';
import loadCommands from './commands/loader';
const run = async () => {
console.log('Starting Botanique...');
// Load .env if not in prod
if (process.env.NODE_ENV !== 'production') {
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
(await import('dotenv')).config({ path: './config/.env' });
}
// Client Discord.JS
await loadClient()
.then(async client => {
console.log('Client ✅');
await loadEvents(client)
.then(() => console.log('Events ✅'))
.catch(() => {
throw 'Events ❌';
});
await client.login(client.config.token_discord);
await loadCommands(client)
.then(() => console.log('Commands ✅'))
.catch(() => {
throw 'Commands ❌';
});
console.log(`Botanique "${client.user?.username}" ${client.config.version} started!`);
})
.catch(() => {
throw 'Client ❌';
});
};
run().catch(error => console.error(error));

View file

@ -1,24 +0,0 @@
import { Client, Collection, Intents } from 'discord.js';
import { readFileSync } from 'fs';
const { version } = JSON.parse(readFileSync('./package.json'));
// Création du client et de ses propriétés
export default async () => {
const client = new Client({
intents: [
Intents.FLAGS.GUILDS,
],
});
// Store the client configuration
client.config = {
version: version,
token_discord: process.env.TOKEN_DISCORD,
};
// Store the commands available
client.commands = new Collection();
return client;
};

42
src/utils/client.ts Normal file
View file

@ -0,0 +1,42 @@
import { Client, Collection, Intents } from 'discord.js';
import { readFileSync } from 'fs';
import { SlashCommandBuilder } from '@discordjs/builders';
const { version } = JSON.parse(readFileSync('./package.json').toString());
declare module 'discord.js' {
// eslint-disable-next-line no-shadow
export interface Client {
config: {
version: string,
token_discord: string | undefined
},
commands: Collection<
string,
{
data: SlashCommandBuilder,
interaction: (interaction: CommandInteraction, client: Client) => unknown
}
>
}
}
// Création du client et de ses propriétés
export default async () => {
const client: Client = new Client({
intents: [
Intents.FLAGS.GUILDS,
],
});
// Store the client configuration
client.config = {
version: version,
token_discord: process.env.TOKEN_DISCORD,
};
// Store the commands available
client.commands = new Collection();
return client;
};

103
tsconfig.json Normal file
View file

@ -0,0 +1,103 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */
/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "es6", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "commonjs", /* Specify what module code is generated. */
"rootDir": "./src", /* Specify the root folder within your source files. */
// "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
"outDir": "./dist", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
}