@@ -960,7 +960,6 @@ <h3 id="development-prerequisites">Development prerequisites<a class="headerlink
960
960
< p > To build Arduino Lint from sources you need the following tools to be available in your local environment:</ p >
961
961
< ul >
962
962
< li > < a href ="https://golang.org/doc/install "> Go</ a > </ li >
963
- < li > < a href ="https://taskfile.dev/#/installation "> Taskfile</ a > to help you run the most common tasks from the command line</ li >
964
963
</ ul >
965
964
< p > If you want to run integration tests or work on documentation, you will also need:</ p >
966
965
< ul >
@@ -979,7 +978,7 @@ <h3 id="development-prerequisites">Development prerequisites<a class="headerlink
979
978
</ ul >
980
979
< h3 id ="building-the-source-code "> Building the source code< a class ="headerlink " href ="#building-the-source-code " title ="Permanent link "> ¶</ a > </ h3 >
981
980
< p > From the project folder root, just run:</ p >
982
- < div class ="highlight "> < pre > < span > </ span > < code > task< span class ="w "> </ span > build
981
+ < div class ="highlight "> < pre > < span > </ span > < code > go < span class =" w " > </ span > tool < span class =" w " > </ span > github.com/go-task/task/v3/cmd/ task< span class ="w "> </ span > build
983
982
</ code > </ pre > </ div >
984
983
< p > The project uses Go modules, so dependencies will be downloaded automatically. At the end of the build, you should find
985
984
the < code > arduino-lint</ code > executable in the same folder.</ p >
@@ -988,11 +987,11 @@ <h3 id="running-the-checks">Running the checks<a class="headerlink" href="#runni
988
987
< p > There are several checks and test suites in place to ensure the code works as expected and is written in a way that's
989
988
consistent across the whole codebase. To avoid pushing changes that will cause the CI system to fail, you can run the
990
989
checks locally by running this command:</ p >
991
- < div class ="highlight "> < pre > < span > </ span > < code > task check
990
+ < div class ="highlight "> < pre > < span > </ span > < code > go tool github.com/go-task/task/v3/cmd/ task check
992
991
</ code > </ pre > </ div >
993
992
< h4 id ="go-unit-tests "> Go unit tests< a class ="headerlink " href ="#go-unit-tests " title ="Permanent link "> ¶</ a > </ h4 >
994
993
< p > To run only the Go unit tests, run:</ p >
995
- < div class ="highlight "> < pre > < span > </ span > < code > task go:test
994
+ < div class ="highlight "> < pre > < span > </ span > < code > go tool github.com/go-task/task/v3/cmd/ task go:test
996
995
</ code > </ pre > </ div >
997
996
< p > By default, all tests for all Arduino Lint's Go packages are run. To run unit tests for only one or more specific
998
997
packages, you can set the < code > TARGETS</ code > environment variable, e.g.:</ p >
@@ -1011,23 +1010,23 @@ <h4 id="integration-tests">Integration tests<a class="headerlink" href="#integra
1011
1010
< code > arduino-lint</ code > in a different process and assess the options are correctly understood and the output is what we expect.</ p >
1012
1011
< h5 id ="running-tests "> Running tests< a class ="headerlink " href ="#running-tests " title ="Permanent link "> ¶</ a > </ h5 >
1013
1012
< p > After the software requirements have been installed, you should be able to run the tests with:</ p >
1014
- < div class ="highlight "> < pre > < span > </ span > < code > task go:test-integration
1013
+ < div class ="highlight "> < pre > < span > </ span > < code > go tool github.com/go-task/task/v3/cmd/ task go:test-integration
1015
1014
</ code > </ pre > </ div >
1016
1015
< p > This will automatically install the necessary dependencies, if not already installed, and run the integration tests
1017
1016
automatically.</ p >
1018
1017
< p > To run specific tests, you must run < code > pytest</ code > from the virtual environment created by Poetry.</ p >
1019
- < div class ="highlight "> < pre > < span > </ span > < code > task poetry:install && poetry run pytest tests/test_all.py::test_report_file
1018
+ < div class ="highlight "> < pre > < span > </ span > < code > go tool github.com/go-task/task/v3/cmd/ task poetry:install && poetry run pytest tests/test_all.py::test_report_file
1020
1019
</ code > </ pre > </ div >
1021
1020
< p > You can avoid writing the < code > poetry run</ code > prefix each time by creating a new shell inside the virtual environment:</ p >
1022
- < div class ="highlight "> < pre > < span > </ span > < code > task poetry:install
1021
+ < div class ="highlight "> < pre > < span > </ span > < code > go tool github.com/go-task/task/v3/cmd/ task poetry:install
1023
1022
poetry shell
1024
1023
pytest test_lib.py
1025
1024
pytest test_lib.py::test_list
1026
1025
</ code > </ pre > </ div >
1027
1026
< h3 id ="dependency-license-metadata "> Dependency license metadata< a class ="headerlink " href ="#dependency-license-metadata " title ="Permanent link "> ¶</ a > </ h3 >
1028
1027
< p > Metadata about the license types of all dependencies is cached in the repository. To update this cache, run the
1029
1028
following command from the repository root folder:</ p >
1030
- < div class ="highlight "> < pre > < span > </ span > < code > task general:cache-dep-licenses
1029
+ < div class ="highlight "> < pre > < span > </ span > < code > go tool github.com/go-task/task/v3/cmd/ task general:cache-dep-licenses
1031
1030
</ code > </ pre > </ div >
1032
1031
< p > The necessary < strong > Licensed</ strong > tool can be installed by following
1033
1032
< a href ="https://github.com/github/licensed#as-an-executable "> these instructions</ a > .</ p >
@@ -1039,7 +1038,7 @@ <h3 id="dependency-license-metadata">Dependency license metadata<a class="header
1039
1038
< h3 id ="automated-corrections "> Automated corrections< a class ="headerlink " href ="#automated-corrections " title ="Permanent link "> ¶</ a > </ h3 >
1040
1039
< p > Tools are provided to automatically bring the project into compliance with some required checks. Run them all with this
1041
1040
command:</ p >
1042
- < div class ="highlight "> < pre > < span > </ span > < code > task fix
1041
+ < div class ="highlight "> < pre > < span > </ span > < code > go tool github.com/go-task/task/v3/cmd/ task fix
1043
1042
</ code > </ pre > </ div >
1044
1043
< h3 id ="working-on-documentation "> Working on documentation< a class ="headerlink " href ="#working-on-documentation " title ="Permanent link "> ¶</ a > </ h3 >
1045
1044
< p > Documentation is provided to final users in form of static HTML content generated from a tool called
@@ -1051,7 +1050,7 @@ <h4 id="local-development">Local development<a class="headerlink" href="#local-d
1051
1050
< p > When working on the documentation, it is useful to be able to see the effect the changes will have on the generated
1052
1051
documentation website. You can build the documentation website and serve it from your personal computer by running the
1053
1052
command:</ p >
1054
- < div class ="highlight "> < pre > < span > </ span > < code > task website:serve
1053
+ < div class ="highlight "> < pre > < span > </ span > < code > go tool github.com/go-task/task/v3/cmd/ task website:serve
1055
1054
</ code > </ pre > </ div >
1056
1055
< p > The documentation will build. If you don't see any error, open < code > http://127.0.0.1:8000</ code > in your browser to view the local
1057
1056
copy of the documentation.</ p >
0 commit comments