Student Proposal: Nested List parsing in elm-markdown

[btofficiel]

Nested List parsing in elm-markdown

Name : Bhaskar Thakur
Name in Slack : bhaskarthakur
Email: [email protected]
Possible Mentor: Dilon Kearns @dillonkearns

Summary

The idea is to add the ability to parse Nested Lists to elm-markdown. This has been been ongoing issue in the package for quite some time (dillonkearns/elm-markdown#7) and solving this would help getting the library more recognition in the community. Changes are required in the parser as well as the Block custom type to enable Nested List parsing. Our focus would be to do the above two and get the test suites passing.

How will I achieve this

• Modify the List Block representation in Block custom type to a recursive type to represent Nested lists (List within List within List)

• Modify Nested List parsing in the Parser to enable recursive calls.

• Follow Contribution guide (https://github.com/dillonkearns/elm-markdown/blob/master/CONTRIBUTING.md) and document the changes made

Benefits

elm-markdown is used in elm-pages which is a static site generator in Elm. Nested lists is a common feature supported by all blogging platforms and static site generators, thus building this would make the package at par with tools from ecosystems other than Elm.

Timeline

May 17 - June 7 (Community bonding)

Get familiar with the team and the mentors and study Dilon's elm-markdown implementation in more depth. This period would be used to schedule the tasks and checkpoints so that the progress of the project can be kept in check.

June 8 - June 22

This period would contain most of the work that is to be done in the project. Specifically, I plan to complete the modification of Block custom type during this period of time.

June 23 - July 11

The focus in this period would be to get done with the parsing part of the project. The remaining time will be used to see how the renderer has to be modified so that the nested lists are rendered correctly.

July 12 - July 16 (First Evaluation)

The work will be reviewed by the mentor in this period and any changes required in the project would be scheduled as tasks to complete further.

July 17 - July 31

The changes prescribed by the mentor in the previous phase would be completed during this period.

August 1 - August 15

Documentation work related to the changes made in the library would be done during this period. The remaining time would be spent on fixing any major bugs that are left in the package.

August 16 - August 23 (Code Submission and Final Evaluation)

I will get my final work reviewed by the mentors and would recap my experience in GSoc in a blog post.

Goals

• Modify the Block custom type to accommodate a recursive structure for lists
• Modifying the parser to parse the the nested lists correctly
• Make sure the test suites are passing
• Documentation of the work done

Requirements

Language: Elm
Packages: elm/parser, dillonkearns/elm-markdown