Format and lint Markdown text files

[jason-fox]

Similar to #314 - This change to package.json introduces markdown linting, textlint linting and markdown formatting using prettier.

• The text is checked for spelling errors, bad grammar and dead links (on CI)
• The markdown is checked for consistency (on CI)
• The markdown is nicely formatted. (on Husky commit)
• The code snippets within the markdown are formatted (on Husky commit)

npm i
npm run prettier:text
npm run lint:text
npm run lint:md

[jason-fox]

Currently the Perseo Documentation has 3 dead links

./documentation/api.md
  56:67  error  https://colabora.tid.es/dca/SitePages/Inicio.aspx is dead. (307 Temporary Redirect)  no-dead-link

./documentation/architecture.md
  207:56  error  https://colabora.tid.es/dca/SitePages/Inicio.aspx is dead. (307 Temporary Redirect)                                                                       no-dead-link
  235:94  error  http://esper.codehaus.org is dead. (request to http://esper.codehaus.org failed, reason: getaddrinfo ENOTFOUND esper.codehaus.org esper.codehaus.org:80)  no-dead-link

This is the reason I commented out the Travis CI step.

[fgalan]

Please use ~ in new depedencies

[jason-fox]

Fixed 266b278 (textlint and remark)

[fgalan]

The three new targets should be added to https://github.com/telefonicaid/perseo-fe/blob/master/documentationT/development.md#development-documentation

In addition, what the diference between remark and textlint? Could you provide some link about it?

[jason-fox]

The links were in the head of the PR:

• remark-lint - check that the Markdown is well formated.
• textlint - check for spelling mistakes, dead links, poor grammar.

remark lint

remark-lint is required because prettier can only do so much with random human markup particularly if you've mixed up * and - for bullets and haven't spaced the bullets properly or used inconsistent bolding.

How can you tell how this should really be rendered?

* **XXXXX*- YYYY

remark-lint has the same role for markdown as eslint does for JavaScript - it means you can be confident that the prettier result is good.

text lint

This does nothing to the markup - it merely checks for consistent text and links so words like FIWARE or IoT Agent can be enforced to have consistency (which is good for documentation). It also adds a link checker so the docs shouldn't contain any dead links.

[jason-fox]

Targets added to documentation - fixed b4923d7

[fgalan]

This command on *.md is the one achieving "The code snippets within the markdown are formatted (on Husky commit)"? What about the other mentioned in the PR body "The markdown is nicely formatted. (on Husky commit)" ?

[jason-fox]

This command on *.md is the one achieves both.

• It nicely formats the markdown as markdown

Something like:

indented markdown      with      excess spaces 
* item one
- item two
  * item 2a
  * item 2b

Will be changed into:

indented markdown with excess spaces 

-   item one
-   item two
    -  item 2a
    -  item 2b

Properly indented, consistent markup

• It formats the codesnippets within the markdown according to the text highlighting indicator

Some markdown text:
```javascript
   crampedFunction(){var x; return dothis();}
``

Some markdown text:

```javascript
crampedFunction (){
    var x; 
    return dothis();
}
``

In this case the snippet is recognised as JavaScript and formatted accordingly

[fgalan]

NTC

[fgalan]

LGTM. Thanks!

Passing the ball to @cblanco for additional LGTM before merging.

[cblanco]

LGTM

Thanks for the contribution.

[fgalan]

Spin-off issue: #324