clragon / swan Goto Github PK

if you paste a really long text into the input in discord, it will turn into a text file automatically.
this is really annoying because it ruins our pastebin uploads.
for example:

some preamble about my problem

\```dart
a really long piece of code
\```

this entire text will end up in the file, including the text block, which then breaks syntax highlighting.
it would be nice if we somehow detected this and threw away any text outside the code block.

however, we should be careful about this and only do it if it actually contains a single code block,
maybe even an open one, since the ending backticks might not be included.

the pastebin plugin right now uses an extremely crude method for language detection:
all text is dart. all pastes are therefore with dart highlights.

it would be nicer if we would actually try some detection.
we could use mime types.

however, we should still treat txt as dart, as some people will inevitably upload raw text files with dart code in them.

since we are replacing flutterdocs functionality, its vital we also add an anti-spam plugin.

like flutterdoc, this includes:

• warnings for duplicate messages (2+) in different channels
• instant bans for duplicate messages in large quantities (5?)

the bot needs extra permissions for bans.

we can use a userid to message content hash map for this.

searching the flutter docs sometimes leads to a very large emebed size that breaks sending the message

right now, the pastebin plugin uses mime types to detect text files.
other files are rejected.
this works poorly, as some desired files like pubspec.yml are definitely text and should be uploaded.
we have to find some other way to figure out if any given file is a raw text file.

Here's one idea:

When a user send a message containing this:

✗ Unable to find bundled Java version.

Reply with a common reply:

Java is already included in your installation of your Android Studio. If you encounter this problem, please don't install Java to fix it.
If you have Java installed and you don't have any reason to have it installed, you can uninstall Java to fix this problem.
If that doesn't fix your problem, run this following command:

flutter config --jdk-dir "path to your jdk"

You can find more information on that command and other configuration flags by running flutter config --help

the new swa parser supports more syntax, including anonymous arrow functions, e.g.
() => a or (a, b) => c
however, currently the parser breaks on this input.

For reproduction:

A(() => b)

The command: .swa > Column > [ Row > [ Flexible(flex: 1), Flexible(flex: 4) ] ]
will produce

Column(
  child: Row( // uses `child`
    children: [
      Flexible(flex: 1),
      Flexible(flex: 4),
    ],
  ),
);

and I expect the content of the Column to be with children, not child like this:

Column(
  children: [ // uses `children`
    Row(
      children: [ 
        Flexible(flex: 1),
        Flexible(flex: 4),
      ]
    ),
  ]
);

apparently those use the wrong hash

the bot's status message somehow keeps turning off after a while.
I have no idea why.
There doesnt seem to be a duration setting on the status and I dont see why it would disappear.

it might be that discord applies the usual 24h decay to such a status as well, but again,
where is the option to turn that off?

There are few instances where documentation search returns a random unrelated documentation from a random package instead of the actual documentation page that should appear first. Here is a recent example:

Command:

![Visibility]

Expected result:

https://api.flutter.dev/flutter/widgets/Visibility-class.html

Actual result:

https://api.flutter.dev/flutter/package-material_color_utilities_scheme_variant/package-material_color_utilities_scheme_variant-library.html

Workaround:

![widgets.Visibility]

This isn't the case with the search feature in api.flutter.dev which has the correct top result. While having workaround isn't bad, the workaround isn't memorable enough to get use to, ended up trying bunch of commands to get it working, some times completely never return the intended documentation page.

contains nothing of use.

it would be useful if the help message of the bot somehow printed out its version.
we could probably do that easily by just adding a plugin that prints out the version in its help text.

however, I am not sure how we are gonna get the version. this is a pure dart program after all.
it would be nice if it was in sync with the pubspec.yaml somehow.

Since we are deploying Swan with search capabilites as of the sunset of flutterdoc, we no longer need this option.
However, we could bring it back as a server specific option instead.

Rough outline for the idea:

1. check if text is over 2000 chars
2. detect all codeblocks
3. cut all code blocks to 200 chars, store full text in map
4. cut the entire text to 2000 chars
5. check which code blocks are still present
6. upload the full text of all cut code blocks which are still present to pastebin
7. add titles with links to all cut code blocks
8. check if the message exceeds 2000, then cut the code blocks to reach 2000
9. create files with the title and full text
10. post message

it would be nice if plugin help messages could do both async work as well as server/channel dependant information.
this requires a refactor on how they are built.

currently, doc searches are parsed even when inside of code blocks. we should filter those.