eightball/PluralKit
1
0
Fork 0
mirror of https://github.com/PluralKit/PluralKit.git synced 2026-02-08 23:07:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

More minor changes

Browse source
This commit is contained in:
Ske 2020-06-12 11:32:54 +02:00
parent 701a0e5054
commit 6b6cce486d
3 changed files with 78 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

52
docs/content/.vuepress/components/CommandInfo.vue
View file

@ -8,6 +8,7 @@
<slot></slot>
<h4>Syntax <small>(how the command is used)</small></h4>
<CmdGroup>
<Cmd v-for="usage in command.usage" :comment="usage.desc">
<span v-for="part in parseUsage(usage)">
@ -17,9 +18,28 @@
</Cmd>
</CmdGroup>
<h4>Arguments</h4>
<div v-for="(arg, key) in command.arguments">
<Arg>{{ key }}</Arg> (<strong v-if="arg.type === 'string'">text</strong><strong v-if="arg.type === 'system'">system ID</strong><span v-if="arg.optional">, <em>optional</em></span>) - {{ arg.desc }}.
<h4 v-if="command.examples">Examples</h4>
<CmdGroup v-if="command.examples">
<Cmd v-for="example in command.examples" :comment="example.desc">
<span v-for="part in parseUsage(example)">
<span v-if="part.type === 'str'">{{ part.str }}</span>
<span v-if="part.type === 'arg'"><Arg>{{ part.arg }}</Arg></span>
</span>
</Cmd>
</CmdGroup>
<h4 v-if="command.arguments">Arguments <small>(fill in above)</small></h4>
<div class="info-arg" v-for="(arg, key) in command.arguments">
<Arg>{{ key }}</Arg>
(<strong v-if="arg.type === 'string'">text</strong><strong v-if="arg.type === 'system'">system
ID</strong><span v-if="arg.optional">, <em>optional</em></span>) - {{ arg.desc }}.
</div>
<h4 v-if="command.flags">Flags <small>(all optional, starts with a hyphen, place anywhere in the
command)</small></h4>
<div class="info-flag" v-for="(flag, key) in command.flags">
<Arg>-{{ key }}</Arg>
- {{ flag.desc }}
</div>
<!--table>
@ -57,16 +77,20 @@
parseUsage(usage) {
if (usage.cmd) usage = usage.cmd;
const parts = usage.split(/\s/);
const output = [];
for (const part of parts) {
const match = part.match(/`([\w\-]+)`/);
if (match)
output.push({type: "arg", arg: match[1]});
else
output.push({type: "str", str: part})
const argRegex = /`([^`]+)`/g;
const parts = [];
let lastMatch = 0;
for (const match of usage.matchAll(argRegex)) {
if (match.index > 0)
parts.push({type: "str", str: usage.substring(lastMatch, match.index)});
parts.push({type: "arg", arg: match[1]});
lastMatch = match.index + match[0].length;
}
return output;
if (lastMatch < usage.length)
parts.push({type: "str", str: usage.substring(lastMatch)});
console.log("INPUT STRING:", usage);
console.log("OUTPUT TOKENS:", parts);
return parts;
}
}
}
@ -88,4 +112,8 @@
.command-info h4 {
margin-bottom: 0.75rem;
}
.info-arg, .info-flag {
margin-bottom: 0.5rem;
}
</style>

6
docs/content/guide/commands.md
View file

@ -21,8 +21,10 @@ When an argument asks for a **member ID**, you can either fill in a member's [5-
You can use <CmdInline>s</CmdInline> instead of <CmdInline>system</CmdInline> as a short-hand.
:::
<CommandInfo cmd="system-info"></CommandInfo>
<CommandInfo cmd="system-new"></CommandInfo>
<CommandInfo cmd="systemInfo"></CommandInfo>
<CommandInfo cmd="systemNew"></CommandInfo>
<CommandInfo cmd="systemName"></CommandInfo>
<CommandInfo cmd="systemDesc"></CommandInfo>
## Member commands
::: tip