diff --git a/docs/howto.md b/docs/howto.md index cbdee791fc771018dbbf0481cb07da5d15c3357b..f43902f5b683228d426dabb541354ff0b4538d32 100644 --- a/docs/howto.md +++ b/docs/howto.md @@ -15,7 +15,7 @@ is formatted as https://discordapp.com/channels/``guildid``/``channelid`` * The ``adminme`` script is provided to set Admin/Moderator or any other custom power level to a specific user. * e.g. To set Alice to Admin on her ``example.com`` HS on default config. (``config.yaml``) - * ``npm run adminme -- -r '!AbcdefghijklmnopqR:example.com' -u '@Alice:example.com' -p '100'`` + * ``npm run adminme -- -m '!AbcdefghijklmnopqR:example.com' -u '@Alice:example.com' -p '100'`` * Run ``npm run adminme -- -h`` for usage. Please note that `!AbcdefghijklmnopqR:example.com` is the internal room id and will always begin with `!`. diff --git a/tools/addRoomsToDirectory.ts b/tools/addRoomsToDirectory.ts index 200bebb500f7e85ece31b7cd5575334106aa2518..aeb037e7507c89a6598b9d1eb4f45e96c0774d69 100644 --- a/tools/addRoomsToDirectory.ts +++ b/tools/addRoomsToDirectory.ts @@ -44,6 +44,14 @@ const optionDefinitions = [ type: String, typeLabel: "<config.yaml>", }, + { + alias: "r", + defaultValue: "discord-registration.yaml", + description: "The AS registration file.", + name: "registration", + type: String, + typeLabel: "<discord-registration.yaml>", + }, { alias: "s", defaultValue: "room-store.db", @@ -69,7 +77,7 @@ if (options.help) { ])); process.exit(0); } -const yamlConfig = yaml.safeLoad(fs.readFileSync("./discord-registration.yaml", "utf8")); +const yamlConfig = yaml.safeLoad(fs.readFileSync(options.registration, "utf8")); const registration = AppServiceRegistration.fromObject(yamlConfig); const config: DiscordBridgeConfig = yaml.safeLoad(fs.readFileSync(options.config, "utf8")) as DiscordBridgeConfig; diff --git a/tools/addbot.ts b/tools/addbot.ts index b8ef769b7ad9c5e5e9fe4e372f370531290d81cd..2dda777537df95d53e6cbb8bdaed47175e89b2f6 100644 --- a/tools/addbot.ts +++ b/tools/addbot.ts @@ -20,9 +20,45 @@ limitations under the License. */ import * as yaml from "js-yaml"; import * as fs from "fs"; +import * as args from "command-line-args"; +import * as usage from "command-line-usage"; import { Util } from "../src/util"; -const yamlConfig = yaml.safeLoad(fs.readFileSync("config.yaml", "utf8")); +const optionDefinitions = [ + { + alias: "h", + description: "Display this usage guide.", + name: "help", + type: Boolean, + }, + { + alias: "c", + defaultValue: "config.yaml", + description: "The AS config file.", + name: "config", + type: String, + typeLabel: "<config.yaml>", + }, +]; + +const options = args(optionDefinitions); + +if (options.help) { + /* tslint:disable:no-console */ + console.log(usage([ + { + content: "A tool to obtain the Discord bot invitation URL.", + header: "Add bot", + }, + { + header: "Options", + optionList: optionDefinitions, + }, + ])); + process.exit(0); +} + +const yamlConfig = yaml.safeLoad(fs.readFileSync(options.config, "utf8")); if (yamlConfig === null) { console.error("You have an error in your discord config."); } diff --git a/tools/adminme.ts b/tools/adminme.ts index a45887968beffc0bee9d2039680531f1f3b90506..234c161fa34e36d39475e8825548d59102bd9df5 100644 --- a/tools/adminme.ts +++ b/tools/adminme.ts @@ -43,6 +43,14 @@ const optionDefinitions = [ }, { alias: "r", + defaultValue: "discord-registration.yaml", + description: "The AS registration file.", + name: "registration", + type: String, + typeLabel: "<discord-registration.yaml>", + }, + { + alias: "m", description: "The roomid to modify", name: "roomid", type: String, @@ -90,7 +98,7 @@ if (!options.userid) { process.exit(1); } -const yamlConfig = yaml.safeLoad(fs.readFileSync("discord-registration.yaml", "utf8")); +const yamlConfig = yaml.safeLoad(fs.readFileSync(options.registration, "utf8")); const registration = AppServiceRegistration.fromObject(yamlConfig); const config: DiscordBridgeConfig = yaml.safeLoad(fs.readFileSync(options.config, "utf8")) as DiscordBridgeConfig; diff --git a/tools/chanfix.ts b/tools/chanfix.ts index a3f5095231f489dc78aea5c87d4ed20911b9d2f2..5607454c12c0e0b159ff048ca2e8ab13f8c6118b 100644 --- a/tools/chanfix.ts +++ b/tools/chanfix.ts @@ -44,6 +44,14 @@ const optionDefinitions = [ type: String, typeLabel: "<config.yaml>", }, + { + alias: "r", + defaultValue: "discord-registration.yaml", + description: "The AS registration file.", + name: "registration", + type: String, + typeLabel: "<discord-registration.yaml>", + }, ]; const options = args(optionDefinitions); @@ -64,7 +72,7 @@ if (options.help) { process.exit(0); } -const yamlConfig = yaml.safeLoad(fs.readFileSync("./discord-registration.yaml", "utf8")); +const yamlConfig = yaml.safeLoad(fs.readFileSync(options.registration, "utf8")); const registration = AppServiceRegistration.fromObject(yamlConfig); const config = new DiscordBridgeConfig(); config.applyConfig(yaml.safeLoad(fs.readFileSync(options.config, "utf8")) as DiscordBridgeConfig); diff --git a/tools/ghostfix.ts b/tools/ghostfix.ts index b4e99e9dc95eaf4aab792f9ad39c4f99c2bc7588..59e34aa63103e6a1c9cc5f6fa602c23f6d065ef3 100644 --- a/tools/ghostfix.ts +++ b/tools/ghostfix.ts @@ -53,6 +53,14 @@ const optionDefinitions = [ type: String, typeLabel: "<config.yaml>", }, + { + alias: "r", + defaultValue: "discord-registration.yaml", + description: "The AS registration file.", + name: "registration", + type: String, + typeLabel: "<discord-registration.yaml>", + }, ]; const options = args(optionDefinitions); @@ -73,7 +81,7 @@ if (options.help) { process.exit(0); } -const yamlConfig = yaml.safeLoad(fs.readFileSync("./discord-registration.yaml", "utf8")); +const yamlConfig = yaml.safeLoad(fs.readFileSync(options.registration, "utf8")); const registration = AppServiceRegistration.fromObject(yamlConfig); const config = new DiscordBridgeConfig(); config.applyConfig(yaml.safeLoad(fs.readFileSync(options.config, "utf8")) as DiscordBridgeConfig);