Merge pull request #2965 from InspectorCaracal/slash-sort Add `/sort` slash command

33a126491ef513c1393bd53afba532be92ef216c

Cohee <18619528+Cohee1207@users.noreply.github.com>

Signed

Parents: 9f23a7852fe7e9bdb13e49264f4700e8bead2166 8333f44e2b5566acc9db5d1e8754ea6e76627ffc

public/scripts/variables.js+79 -0 Viewed

     return value;
+}
 +function customSortComparitor(a, b) {
 +    if (typeof a != typeof b) {
 +        a = typeof a;
 +        b = typeof b;
 +    }
 +    return a > b ? 1 : a < b ? -1 : 0;
 +}
++
 +function sortArrayObjectCallback(args, value) {
 +    let parsedValue;
 +    if (typeof value == 'string') {
 +        try {
 +            parsedValue = JSON.parse(value);
 +        } catch {
 +            // return the original input if it was invalid
 +            return value;
 +        }
 +    } else {
 +        parsedValue = value;
 +    }
 +    if (Array.isArray(parsedValue)) {
 +        // always sort lists by value
 +        parsedValue.sort(customSortComparitor);
 +    } else if (typeof parsedValue == 'object') {
 +        let keysort = args.keysort;
 +        if (isFalseBoolean(keysort)) {
 +            parsedValue = Object.keys(parsedValue).sort(function (a, b) { return customSortComparitor(parsedValue[a], parsedValue[b]); });
 +        } else {
 +            parsedValue = Object.keys(parsedValue).sort(customSortComparitor);
 +        }
 +    }
 +    return JSON.stringify(parsedValue);
 +}
++
 /**
  * Declare a new variable in the current scope.
  * @param {NamedArguments} args Named arguments.

         `,
     }));
     SlashCommandParser.addCommandObject(SlashCommand.fromProps({
 +        name: 'sort',
 +        callback: sortArrayObjectCallback,
 +        returns: 'the sorted list or dictionary keys',
 +        namedArgumentList: [
 +            SlashCommandNamedArgument.fromProps({ name: 'keysort',
 +                description: 'whether to sort by key or value; ignored for lists',
 +                typeList: [ARGUMENT_TYPE.BOOLEAN],
 +                enumList: ['true', 'false'],
 +                defaultValue: 'true',
 +            }),
 +        ],
 +        unnamedArgumentList: [
 +            SlashCommandArgument.fromProps({
 +                description: 'value',
 +                typeList: [ARGUMENT_TYPE.STRING, ARGUMENT_TYPE.NUMBER, ARGUMENT_TYPE.LIST, ARGUMENT_TYPE.DICTIONARY],
 +                isRequired: true,
 +                forceEnum: false,
 +            }),
 +        ],
 +        helpString: `
 +            <div>
 +                Sorts a list or dictionary in ascending order and passes the result down the pipe.
 +                <ul>
 +                    <li>
 +                        For lists, returns the list sorted by value.
 +                    </li>
 +                    <li>
 +                        For dictionaries, returns the ordered list of keys after sorting. Setting keysort=false means keys are sorted by associated value.
 +                    </li>
 +                </ul>
 +            </div>
 +            <div>
 +                <strong>Examples:</strong>
 +                <ul>
 +                    <li>
 +                        <pre><code class="language-stscript">/sort [5,3,4,1,2] | /echo</code></pre>
 +                    </li>
 +                    <li>
 +                        <pre><code class="language-stscript">/sort keysort=false {"a": 1, "d": 3, "c": 2, "b": 5} | /echo</code></pre>
 +                    </li>
 +                </ul>
 +            </div>
 +        `,
 +    }));
 +    SlashCommandParser.addCommandObject(SlashCommand.fromProps({
         name: 'rand',
         callback: (args, value) => String(randValuesCallback(Number(args.from ?? 0), Number(args.to ?? (value ? value : 1)), args)),
         returns: 'random number',