You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2022/01/06 07:53:34 UTC
[GitHub] [arrow-rs] bkmgit opened a new issue #1139: Formatting of markdown with Prettier
bkmgit opened a new issue #1139:
URL: https://github.com/apache/arrow-rs/issues/1139
**Is your feature request related to a problem or challenge? Please describe what you are trying to do.**
If editing markdown files in the browser, CI checks with [Prettier](https://prettier.io) only give a warning message that a file is improperly formatted. This can make editing markdown in the browser tedious.
**Describe the solution you'd like**
Since only markdown files are checked by prettier, a javascript dependency, it may be good to change the [CI configuration](https://github.com/bkmgit/arrow-rs/blob/simd/.github/workflows/dev.yml) to
```
npx prettier@2.3.0 --write {arrow,arrow-flight,dev,integration-testing,parquet}/**/*.md README.md CODE_OF_CONDUCT.md CONTRIBUTING.md
```
Or otherwise ensure that CI checks are able to output the suggested changes.
**Describe alternatives you've considered**
- Consider a rust based formatter to minimize local toolchain project dependencies such as [comrak](https://github.com/kivikakk/comrak)
- Suggest using an online formatter in the [CONTRIBUTING.md](https://github.com/apache/arrow-rs/blob/master/CONTRIBUTING.md), such as https://codebeautify.org/javascript-pretty-print or https://codebeautify.org/markdown-formatter
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] alamb commented on issue #1139: Formatting of markdown with Prettier
Posted by GitBox <gi...@apache.org>.
alamb commented on issue #1139:
URL: https://github.com/apache/arrow-rs/issues/1139#issuecomment-1062802002
This is a good idea -- datafusion does something similar so it should be a strightforward change
https://github.com/apache/arrow-datafusion/blob/4ea865230d5bc1d916926acc7fb7f008481e8c6c/.github/workflows/dev.yml#L67-L74
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org