Update `.editorconfig` and improve and run our linting and formatting process

rmccar commented 1 month ago

What is the context of this PR?

Fixes: #3169

This updates the .editorconfig file. I think changing the trim_trailing_whitespace option to true would be a good change due to how often this is missed in PRs. I have also updated the file to cover .yaml files and updated the syntax to what is recommended in the docs.

We currently have indentation not standardised across our different files. For template files we indent with a width of 4 and with any other file its a width of 2.

We have decided to set this to 4 across all files because of this updated .eslintrc.json and .stylelintrc.yml. I have then run the linters and prettier across all the files to update the formatting in them and then made some updates to resolve the warnings and errors that were thrown up.

This dealt with all the .js, .md, .yml and .scss files the Nunjucks files will be added and formatted in another PR.

Ive also removed the VSCode recommended settings section from the readme as this should be irrelevant after this PR and everyone has the Editor Config extension installed. Also all stylelint dependancies have been updated.

How to review this PR

Review changes and see if they make sense as per discussion
Review all changes to formatting the files and check it hasn't introduced any other issues from being incorrectly formatted

Checklist

This needs to be completed by the person raising the PR.

[x] I have selected the correct Assignee
[x] I have linked the correct Issue

netlify[bot] commented 1 month ago

Deploy Preview for ons-design-system-preview ready!

Name	Link
Latest commit	b82232c74be2f3d5dc92594c3825b3fc0edee5e6
Latest deploy log	https://app.netlify.com/sites/ons-design-system-preview/deploys/665ecf42f865930008035134
Deploy Preview	https://deploy-preview-3190--ons-design-system-preview.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

rmccar commented 1 month ago

I have tested this locally to see if the editor would fix my changes on commit and although it did fix my incorrect changes it also added some unexpected changes to the _mq.scss file which were then not committed.

This should be sorted now

ONSdigital / design-system