Add TypeScript types

[remcohaszing]

This add TypeScript types for the following packages:

• rehype
• rehype-parse
• rehype-stringify

Also Prettier has been properly configured. It runs on the entire code base. Markdown and HTML files are ignored. Because of this, many JSON files have been touched.

[ChristianMurphy]

/cc @Rokt33r

[ChristianMurphy]

Thanks @remcohaszing!

[wooorm]

I’d prefer not formatting JSON either, what do y’all think?
JSON for us is either tree fixtures or package.json, they’re generated and modified by tools instead of written by hand, and their main role is to be read in git diffs, for which a more stable format like JSON.stringify would be less noisy?

[remcohaszing]

@wooorm wrote:

I’d prefer not formatting JSON either, what do y’all think?
JSON for us is either tree fixtures or package.json, they’re generated and modified by tools instead of written by hand, and their main role is to be read in git diffs, for which a more stable format like JSON.stringify would be less noisy?

I think Prettier should be used to format JSON, because it forces consistent formatting and very importantly, proper spacing, newlines, and a newline at the end of the file.

Prettier supports 2 formatters for JSON: json and json-stringify. By default all JSON files are formatted using their json formatter, except the ones listed here

@wooorm’s preferred format matches json-stringify. Prettier can be configured to enforce this style instead using the following option:

"overrides": [
      {
        "files": [
          "*.json"
        ],
        "options": {
          "parser": "json-stringify"
        }
      }
    ]

Although I personally like json-stringify better as well, I also like how Prettier is about giving up your preference of coding style for a consistent one enforced by a tool.

Note that the Prettier json format is actually jsonc, so it supports comments.

[wooorm]

Ah. Yeah. Overrides sounds silly.
Still feel like proper spacing, newlines, and a end-of-file newline is mostly done automatically. You did catch one missing eof eol, and I don’t like them either, but in my opinion it also doesn’t hurt that much.
/cc @ChristianMurphy, @Murderlon, what do you think?

[Murderlon]

First off, nice work @remcohaszing!

/cc @ChristianMurphy, @Murderlon, what do you think?

I don’t think it matters a lot but I might be slightly inclined to not using Prettier on JSON as well. Mostly because the files, like @wooorm said, are fixtures or package.json. Future formatting updates to Prettier might create diff noise, or require a new PR to be made to update the fixtures.

[ChristianMurphy]

I don't have a strong opinion on the json formatting. 🤷
I skip json formatting in most of my personal prettier setups.

If this config were getting bundled into a unified-dx tool which could apply the override to every project it may be a good idea. 👍
Trying to remember to add the override to every project manually sounds like a recipe for confusion and inconsistency 😅

[remcohaszing]

I think running Prettier on the entire directory, instead of using a glob is the correct way of running it. Files are excluded using .prettierignore. This way, running prettier . yields the same results as saving supported project files in the editor.

I reconfigured Prettier, because I needed it to format TypeScript files as well. I decided to format JSON as well, as the impact isn’t that big. Markdown is excluded, because remark-preset-wooorm conflicts with prettier, and HTML files are excluded, because these fixtures are sometimes malformed on purpose for the sake of testing Rehype.

All file of these file formats are formatted by Prettier. Excluding a specific file extension in .prettierignore is more configuration just formatting the file. Also for example .travis.yml is formatted. It just happens to conform to the prettier formatting.

Even if files are generated, people can mess with them before committing them, so I think it makes sense to validate any file if possible, especially if a file type is already supported by a tool that’s already in use.

If you do have strong feelings about the JSON formatting, I’ll exclude it from syntax-tree/hast-util-from-parse5#10 and later this PR. Otherwise, I’ll wait on that PR, since this one depends on it.

[wooorm]

I, relatively strongly, would say that we should do a ‘.’ for prettier always, but would like to exclude through prettierignore: 1) gitignored files when needed, 2) markdown because we dog food our own, 3) HTML because it’s probably a fixture when needed, 4) json (if included). Everything else, yaml, TS, JS, etc., is probably handwritten and really benefits from formatting.
But this preference is for the projects I originally authored, and there may be exceptions per project.

I agree on formatting as important, but don’t think the churn of updating 100s of mostly generated files is worth it.

[ChristianMurphy]

friendly ping @remcohaszing

[remcohaszing]

@ChristianMurphy sorry, I have been busy unexpectedly lately. Anyway, the feedback is processed now. :)

[wooorm]

Released, thanks @remcohaszing and others!