The typeMap is shown to have these contained within all, yet TypeError occurs when it fails to find a class or typedef.

An additional change to /search requires the consideration of an entity if it's a typedef to treat it similar to a class, but also as it's own type (/docs class class: * -> /docs typedef typedef: *).

https://github.com/slash-create/docs-bot/blob/98c07eb007ca3d699b37f530f3a66e6cb1e690d8/src/commands/search.ts#L42-L43

For now, an onError catch would work for the command itself - but it would be troubling if it persists after fix is implemented.

Fixes #23

Warning Access to app commands appears to be refused if SEND_MESSAGES isn't available. - I guess the main reason I misunderstood it was due to how USE_APP_COMMANDS was described and how API Docs describe what users have access to when they have certain permissions granted or revoked (which has been quite unclear to me in some cases in the past - TinkerStorm/interaction-prototypes#4).

This is functional for both internal documentation, and a limited number of entries on MDN known to be contained within the docgen manifest. Brace replacement is also fully functional with the forced escape sequence and having it join together for Discord to safely render it. - 9dd8b974c8dc1355445b220b4602e214bda1d96f

In addition to that...

• 815b26748736d6116418ec8fefd36818fabcd5e4 now uses default limit for fuzzy filtering on class autocompletion.
• 067723e8ff8743eb62cf906ce628a849839e72b3 finally adds a description for the parent structures.
• 55a3337f7e61088c0e1657bf4fd33658c2c0d958 getArgumentEntityFields now accepts an entityType argument.

  This was intended for class constructors, but the spacing and layout of the resulting embed became a concern, so it was commented out for classes specifically. - Still there, it just won't show for now until another opportunity arises to improve its structure.

Bumps fastify from 4.7.0 to 4.10.2.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps fastify from 4.7.0 to 4.8.1.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Given the constrains content indents have on code blocks, it is a considerable choice to sling it forward - but also a hinderance as mentioned in #24 with regard to content limits. This would require all code specific lines to be prefixed with >, which isn't difficult - but is more concerning for the effect it would have on the limits described... and the reasons to justify the change in formatting without impacting user experience.

https://github.com/slash-create/docs-bot/blob/445f311298a1bb44992a7ff4416927356606a03e/src/commands/code.ts#L214-L215

When content is trimmed or requested content does not include an opening comment brace /*, formatting errors cascade throughout the file.

Comparing between around: 6 and around: 10 when running /code entity on query: SlashCommand#throttle.

This isn't as big of a problem as other hitches, but it does persist when comment braces are not included - and HighlightJS takes over by considering them as standard markup.

A solution would be to inject a forward slash / before the first asterisk * of the requested content, and then add an 'amendment' #24 stating it's inaccuracy for formatting reasons - but also... inaccurate in general.

In the unlikelihood that commands can be run from a command mention in a channel a user would not normally have access to send messages, a failover should trip to ensure its response remains ephemeral.

import { CommandContext } from 'slash-create';

class DocsCommand {
  async run(ctx: CommandContext) {
    // ...
    const shouldRemainEphemeral = !ctx.permissions.has("SEND_MESSAGES");
    // ...
   
    ctx.send({
      // ...
      ephemeral: shouldRemainEphemeral || !options.share
      // ...
    });
  }
}

This feature requires an additional option on each subcommand, and the behavioural change internally to handle the presence of the option as a default inversion.

{
  "name": "share",
  "description": "Share the documentation entry to the channel (=false)",
  "type": 5,
  "required": false
}

It should be worth noting that a command sent with /docs ... share: true won't be dismissible, and default back to the regular behaviour of needing access to MANAGE_MESSAGES. On the plus side, users would be able to query the documentation alongside a conversation - and then decide to share when they've found what they wanted.

Math.round(...) is pretty much the same as floor and trunc along with the modulus operation. Although based on the provided logic, it will always be raised to the nearest whole number - leaving no room for alternating line trimming.

Line trimming has always been a problem when dealing with Discord's content limit and ensuring a response is always delivered correctly. Another option can be provided as trim_from with it's available choices as Start and End or Top and Bottom, etc.

https://github.com/slash-create/docs-bot/blob/8109ff639778e5db7f3fd94f52041dbba5324ced/src/commands/code.ts#L176-L185

That is all it would be affecting, and it would have to be a boolean - or require a rework of it's trimming logic.

• comment initiators are injected only if the comment is not defined as open
• if line numbers have not been requested, it then reassigns commentOpen to revert to it's standard behavior of searching for the next comment terminator

Using a Set<string> is probably a bit of a cheat when it comes to handling alteration notes, but it's better than having to build a wrapper around an array and then also performing an O(n + 1) check and insertion (below). My only remaining concern is how the defined Set is handled within it's context after it is assembled.

It's not an exact solution, but the principle is there. - Expected to fail.

interface AmendNotesConstructor {
  (note: string): AmendNotesConstructor;
  (): string[];
}

const getNoteInstance = (): AmendNotesConstructor => {
  const notes: string[] = [];
  return function $internal(note?: string) {
    if (!note) return notes;
    if (notes.indexOf(note) <= -1) notes.push(note);
    return $internal;
  };
};

const func = getNoteInstance();
func('note1');
func('note2');
func('note1');
console.log(func()); // ['note1', 'note2']

Given the functional complexity of this service, localization is impossible for documentation entries in the way it is currently built... but localization for command names, options and descriptions as well as button components can be within an achievable scope.

... that said, they'd be hard coded into the response.

This is something I've wanted to do for a while, only hitch being the version either has to be optional (and after all the required arguments) or an entirely new command to specifically handle versioning (which is what Eris Docs does /vdocs). It's not a bad way of handling distinct logic between latest and {branch/tag/ref}.

Some files on the docs branch refer to branches that may have been merged or outright removed, but their manifest remains - docs site has filtered this out.

This intends to be a long-term enhancement, uncommon knowledge about the framework and it's nuances can be documented here - similar to how docs site has guides. The recent inclusion of Select Menus in modals serves to be a good example.

Given the structure of an FAQ, autocomplete would serve better over a series of choices.

https://github.com/sudojunior/hack-n-slash/blob/d1f6c876551de09727465ef39e7cc7b9529fc47d/src/commands/about.ts#L26-L34

Current structure of Hack 'n Slash's /about command, but it could be structured better.

Close ties with #6 and #7