samhstn / markdowntables

Markdown Tables

Create, Edit and Format your markdown tables.

Similar to these projects:

• Markdown table generator
• tablesgenerator.com

... but much better.

Running app locally

git clone [email protected]:samhstn/markdowntables.git && cd markdowntables
npm install
npm start

Running app in production

We have configured travis to automatically deploy to gh-pages branch.

To set this up, we simply need to generate a new token with a repo scope in our github developer settings.

Then add this token as an environment variable called GITHUB_TOKEN in our travis settings.

Every change to our master branch will trigger a new deploy to our gh-pages url.

A useful script to wait for gh-pages to be deployed is:

until [ "$(curl -s https://samhstn.github.io/markdowntables/version)" = "$(git rev-parse HEAD)" ];do
  printf "."
  sleep 5
done

AWS Setup

Checkout the infra documentation for guidance.

markdowntables's Issues

Highlight errors in textarea

Look to use the div textarea pattern described here: https://codersblock.com/blog/highlight-text-inside-a-textarea

Validate if table input is valid

We should check that the input has the correct number of rows in each column.

If invalid, we should show a cross with an invalid message and not update the state of the table.

We should also check how strict a markdown parser is on valid tables.

Domain and CDN implementation

• Configure our domain to point to our CDN with route53
• Configure our CDN to point to our gh-pages url

Npm depdency doesn't exist

Our ci is failing on the error:

npm ERR! code ETARGET
npm ERR! notarget No matching version found for ecstatic@^3.0.0
npm ERR! notarget In most cases you or one of your dependencies are requesting
npm ERR! notarget a package version that doesn't exist.
npm ERR! notarget
npm ERR! notarget It was specified as a dependency of 'http-server'
npm ERR! notarget

Looks like the issue is going to be resolved any minute as soon as this pr is merged: jfhbrook/node-ecstatic#256

Ci

Add ci which:

• runs our tests
• pushes to branch gh-pages if successful

Rethink what is generated from UserInput

We currently generate, from a UserInput (String for now), a Result UserInputErr TableRows.

Resulting in either the table rows, or some sort of error. This is quite limited and will only show the user one thing. We also stop on the first error/warning we find.

It would be nicer instead to always show a table result when possible. Along with all validation warnings and errors if the UserInput is or isn't parsable.

We should instead look to work with the following types:

type Generated
    = Generated (List Warning) (Result (List Error) TableRows)


type Warning
    = TrailingSpace Coordinate
    | ...


type Error
    = InvalidHeader Coordinate
    | ...


type alias Coordinate =
    { line : Int
    , characters : List Int
    }