@@ -95,24 +95,18 @@ task build
9595The project uses Go modules, so dependencies will be downloaded automatically. At the end of the build, you should find
9696the ` arduino-lint ` executable in the same folder.
9797
98- ### Running the tests
98+ < a id = " running- the- tests" ></ a >
9999
100- There are several checks and test suites in place to ensure the code works as expected and is written in a way that's
101- consistent across the whole codebase. To avoid pushing changes that will cause the CI system to fail, you can run most
102- of the tests locally.
100+ ### Running the checks
103101
104- To ensure code style is consistent, run:
102+ There are several checks and test suites in place to ensure the code works as expected and is written in a way that's
103+ consistent across the whole codebase. To avoid pushing changes that will cause the CI system to fail, you can run the
104+ checks locally by running this command:
105105
106106```
107107task check
108108```
109109
110- To run all tests:
111-
112- ```
113- task test
114- ```
115-
116110#### Go unit tests
117111
118112To run only the Go unit tests, run:
@@ -173,49 +167,17 @@ pytest test_lib.py
173167pytest test_lib.py::test_list
174168```
175169
176- #### Linting and formatting
177-
178- When editing any Python file in the project, remember to run linting checks with:
179-
180- ```
181- task python:check
182- ```
170+ <a id =" linting-and-formatting " ></a > <a id =" configuration-files-formatting " ></a > <a id =" documentation-formatting " ></a >
183171
184- This will run [ ` flake8 ` ] ( https://flake8.pycqa.org/ ) automatically and return any error in the code formatting.
172+ ### Automated corrections
185173
186- In case of linting errors you should be able to solve most of them by automatically formatting with:
174+ Tools are provided to automatically bring the project into compliance with some required checks. Run them all with this
175+ command:
187176
188- ``` shell
189- task python:format
190177```
191-
192- #### Configuration files formatting
193-
194- We use [ Prettier] ( https://prettier.io/ ) to automatically format all YAML files in the project. Keeping and enforcing a
195- formatting standard helps everyone make small PRs and avoids the introduction of formatting changes made by unconfigured
196- editors.
197-
198- There are several ways to run Prettier. If you're using Visual Studio Code you can easily use the
199- [ ` prettier-vscode ` extension] ( https://github.com/prettier/prettier-vscode ) to automatically format as you write.
200-
201- Otherwise you can use the following tasks. To do so you'll need to install ` npm ` if not already installed. Check the
202- [ official documentation] ( https://docs.npmjs.com/downloading-and-installing-node-js-and-npm ) to learn how to install
203- ` npm ` for your platform.
204-
205- To check if the files are correctly formatted run:
206-
207- ``` shell
208- task config:check
178+ task fix
209179```
210180
211- If the output tells you that some files are not formatted correctly run:
212-
213- ``` shell
214- task config:format
215- ```
216-
217- Checks are automatically run on every pull request to verify that configuration files are correctly formatted.
218-
219181### Working on documentation
220182
221183Documentation is provided to final users in form of static HTML content generated from a tool called
@@ -238,33 +200,6 @@ task website:serve
238200The documentation will build. If you don't see any error, open ` http://127.0.0.1:8000 ` in your browser to local the
239201local copy of the documentation.
240202
241- #### Documentation formatting
242-
243- We use [ Prettier] ( https://prettier.io/ ) to automatically format all Markdown files in the project. Keeping and enforcing
244- a formatting standard helps everyone make small PRs and avoids the introduction of formatting changes made by
245- misconfigured editors.
246-
247- There are several ways to run Prettier. If you're using Visual Studio Code you can easily use the
248- [ ` prettier-vscode ` extension] ( https://github.com/prettier/prettier-vscode ) to automatically format as you write.
249-
250- Otherwise you can use the following tasks. To do so you'll need to install ` npm ` if not already installed. Check the
251- [ official documentation] ( https://docs.npmjs.com/downloading-and-installing-node-js-and-npm ) to learn how to install
252- ` npm ` for your platform.
253-
254- To check if the files are correctly formatted run:
255-
256- ``` shell
257- task website:check
258- ```
259-
260- If the output tells you that some files are not formatted correctly run:
261-
262- ``` shell
263- task docs:format
264- ```
265-
266- Checks are automatically run on every pull request to verify that documentation is correctly formatted.
267-
268203#### Documentation publishing
269204
270205The Arduino Lint git repository has a special branch called ` gh-pages ` that contains the generated HTML code for the
0 commit comments