I have written a PHP script which coverts a text file in a yaml format. Please find the attached hooks.yaml (

hooks.txt has a lot of test cases and I tried to cover all of them using regular expressions. I tested hooks.yaml manually and on one online YAML parser. I don't know what exactly would be the best method to test if some information is getting lost/misinterpreted from hooks.txt to hooks.yaml.

YAML syntaxes like literal blocks, sequences and maps might make it inconvenient for developers adding hooks. Should we add some instructions in hooks.yaml for adding hooks?

key: value (Plainer style) has a lot of limitations . Top of that, It has a lot more limitations on first character. All these limitations make it difficult to follow. So, whenever a line contains a character that doesn't belong to A-Z a-z 0-9 _ . \n space , I used '|' .

I preferred '|' over '>' because of test cases in which we would like to preserve new line breaks for example, in argument $param :

'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
Returning false will prevent the string from being added to the OutputPage.
&$s: html string to show for the log extract
$types: String or Array Log types to show
$page: String or Title The page title to show log entries for
$user: String The user who made the log entries
$param: Associative Array with the following additional options:
  - lim Integer Limit of items to show, default is 50
  - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
  - showIfEmpty boolean Set to false if you don't want any output in case the
    loglist is empty if set to true (default), "No matching items in log" is
    displayed if loglist is empty
  - msgKey Array If you want a nice box with a message, set this to the key of
    the message. First element is the message key, additional optional elements
    are parameters for the key that are processed with
    wfMessage()->params()->parseAsBlock()
  - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
    offset
  - wrap String Wrap the message in html (usually something like
    "<div ...>$1</div>").
  - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)

Here is the script for this task P2218 and corresponding yaml file

Change 248677 had a related patch set uploaded (by Akangupt):
Adding hooks.yaml for T115388

https://gerrit.wikimedia.org/r/248677

Change 248677 had a related patch set uploaded (by Akangupt):
Convert hooks.txt to hooks.yaml

https://gerrit.wikimedia.org/r/248677

Hello @Akangupt. At first: I am a huge fan of YAML which is very convenient for human consumption and has a ton of nice features.

The hooks documentation definitely needs love. I did an attempt ages ago to convert the plain text file to doxygen format which we use to generate the mediawiki/core doc. Got buried / abandoned eventually https://gerrit.wikimedia.org/r/#/c/66128/ . So I am quite happy to see this task!

A potential concern (from T116965) is: that the YAML file defines a layout. We would want to make sure that future changes will not break it and respect whatever fields are required. Maybe that is out of the scope of this task though.

Do we have any idea what is going to consume the .yaml file?

Yes, this is an Outreachy microtask so the scope needs to be limited. Those issues need to be solved before the patch can be merged, but are not part of this task.

@Akangupt, @Tgr: Is there anything left to do in this task, as per last comment? Should this task still be open / assigned?

In T115388#5701668, @Aklapper wrote:

@Akangupt, @Tgr: Is there anything left to do in this task, as per last comment? Should this task still be open / assigned?

Ping.

Change 248677 abandoned by Gergő Tisza:

[mediawiki/core@master] Convert hooks.txt to hooks.yaml

Reason:

Obsoleted by the hooks system refactor.

https://gerrit.wikimedia.org/r/248677