Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Standardize code formatting in repository #1783

Merged
merged 19 commits into from
Jul 4, 2024
Merged

Standardize code formatting in repository #1783

merged 19 commits into from
Jul 4, 2024

Conversation

dlachaume
Copy link
Collaborator

@dlachaume dlachaume commented Jun 26, 2024 •
edited
Loading

Content

This PR includes a global configuration for the code formatting strategy.

This configuration is managed by Prettier and can be configured in the .prettierc file located at the root of the repository with options.

The Makefiles of mithril-client-wasm/www/, mithril-client-wasm/www-test/, and docs/website/ have been extended with make lint and make format commands.

make lint can also be executed from the root of the repository to facilitate usage and CI checks for the entire repository.

Pre-submit checklist

  • Branch
    • Tests are provided (if possible)
    • Crates versions are updated (if relevant)
    • CHANGELOG file is updated (if relevant)
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • No clippy warnings in the CI
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested
  • Documentation
    • Update README file (if relevant)
    • Update documentation website (if relevant)
    • Add dev blog post (if relevant)

Issue(s)

Closes #1754

@dlachaume dlachaume self-assigned this Jun 26, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 26, 2024 •
edited
Loading

Test Results

    4 files  ±0     52 suites  ±0   8m 38s ⏱️ -16s
1 141 tests ±0  1 141 ✅ ±0  0 💤 ±0  0 ❌ ±0 
1 307 runs  ±0  1 307 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit a91559a. ± Comparison against base commit 70d4fe6.

♻️ This comment has been updated with latest results.

@dlachaume dlachaume force-pushed the dlachaume/1754/lint-markdown-js-files-in-repo branch from dea726d to cc182ae Compare June 26, 2024 15:26
@dlachaume dlachaume force-pushed the dlachaume/1754/lint-markdown-js-files-in-repo branch 2 times, most recently from 73aa9c4 to c8fd276 Compare June 26, 2024 16:27
@dlachaume dlachaume force-pushed the dlachaume/1754/lint-markdown-js-files-in-repo branch 5 times, most recently from 18aadd6 to fa0d227 Compare July 4, 2024 09:31
@dlachaume dlachaume temporarily deployed to testing-sanchonet July 4, 2024 09:38 — with GitHub Actions Inactive
@dlachaume dlachaume changed the title Standardize Javascript and Markdown code formatting Standardize code formatting in repository Jul 4, 2024
@dlachaume dlachaume temporarily deployed to testing-sanchonet July 4, 2024 10:08 — with GitHub Actions Inactive
@dlachaume dlachaume temporarily deployed to testing-sanchonet July 4, 2024 10:09 — with GitHub Actions Inactive
@dlachaume dlachaume marked this pull request as ready for review July 4, 2024 10:11
@dlachaume dlachaume marked this pull request as draft July 4, 2024 10:13
@dlachaume dlachaume marked this pull request as ready for review July 4, 2024 10:40
@dlachaume dlachaume temporarily deployed to testing-sanchonet July 4, 2024 14:57 — with GitHub Actions Inactive
@dlachaume dlachaume temporarily deployed to testing-sanchonet July 4, 2024 15:11 — with GitHub Actions Inactive
jpraynaud
jpraynaud approved these changes Jul 4, 2024
View reviewed changes
Copy link
Member

@jpraynaud jpraynaud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

@dlachaume
Add .prettierrc to manage and propagate code formatting rules in th…
697e412 
…e repository
@dlachaume
Add prettier in www/
086665a
@dlachaume
Add prettier in www-test/
f5e6aae
@dlachaume
Add make commands to check www/ and www-test/ files respect pre…
bb06354 
…ttier rules
@dlachaume
Add prettier in docs/website/
36e1be8
@dlachaume
Add global make lint executed in the CI
2de5562 
- Add code formatting verification in the `check` step of the CI
- Remove `Check explorer` in `build-test-explorer` job, since the `make lint` command is executed by the `check` job
- Add `check` job require for `publish-docs`
- Add global `.prettierignore`
@dlachaume
Remove .prettierrc from explorer and move configuration to global l…
b15c2d1 
…evel
@dlachaume
Fix www/ and www-test/ code formatting
faa4833 
By running `make format`
@dlachaume
Fix docs/website/ code formatting
154f168 
By running `make format`
@dlachaume
Fix project code formatting
a0cb6e3 
By running 'make format'
@dlachaume
Format .yaml files with prettier
e8b01a9
@dlachaume
Format .json files with prettier
a486d8d
@dlachaume
Fix extra columns issue in aggregator developer doc
89a02d3 
The parameters `snapshot_bucket_name` and `snapshot_bucket_name` had additional information that was not displayed because it was included in a missing column of the table.
Other extra columns were included in the other commands tables
@dlachaume
Skip formatting of files located in `mithril-test-lab/mithril-devnet/…
98f542c 
…configuration`
@dlachaume
Skip formatting of flake.lock
cdf896d
@dlachaume
Rename Make commands and add additional information when prettier is …
56848f6 
…not installed
@dlachaume
Fix format issues in docs/
251dd64
@dlachaume
Update CHANGELOG
a6fdf5f
@dlachaume
Bump JS packages versions
a91559a
@dlachaume dlachaume force-pushed the dlachaume/1754/lint-markdown-js-files-in-repo branch from 58105d2 to a91559a Compare July 4, 2024 15:37
@dlachaume dlachaume temporarily deployed to testing-sanchonet July 4, 2024 15:44 — with GitHub Actions Inactive
@dlachaume dlachaume merged commit e38d6b7 into main Jul 4, 2024
40 checks passed
@dlachaume dlachaume deleted the dlachaume/1754/lint-markdown-js-files-in-repo branch July 4, 2024 15:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Alenar Alenar Alenar approved these changes

@sfauvel sfauvel sfauvel approved these changes

@jpraynaud jpraynaud jpraynaud approved these changes

Assignees

@dlachaume dlachaume

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Lint Markdown/JavaScript files in repository
4 participants
@dlachaume @Alenar @sfauvel @jpraynaud