Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit bf0d1b4

Browse filesBrowse files
per1234per1234
authored
Merge pull request #157 from arduino/per1234/update-product-name
Use "Arduino Lint" as the project name
2 parents 9c045ec + 4c62d7f commit bf0d1b4
Copy full SHA for bf0d1b4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Dismiss banner

77 files changed

+185
-185
lines changed

‎README.md

Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# arduino-lint
1+
# Arduino Lint
22

33
[![Tests Status](https://github.com/arduino/arduino-lint/workflows/Run%20tests/badge.svg)](https://github.com/arduino/arduino-lint/actions?workflow=Run+tests)
44
[![Nightly Status](https://github.com/arduino/arduino-lint/workflows/Nightly%20build/badge.svg)](https://github.com/arduino/arduino-lint/actions?workflow=Nightly+build)
55
[![Docs Status](https://github.com/arduino/arduino-lint/workflows/Publish%20documentation/badge.svg)](https://github.com/arduino/arduino-lint/actions?workflow=Publish+documentation)
66

7-
**arduino-lint** is a command line tool that checks for common problems in [Arduino](https://www.arduino.cc/) projects:
7+
**Arduino Lint** is a command line tool that checks for common problems in [Arduino](https://www.arduino.cc/) projects:
88

99
- Sketches
1010
- Libraries
@@ -16,7 +16,7 @@ For usage instructions, see [the documentation](https://arduino.github.io/arduin
1616

1717
## Continuous Integration
1818

19-
There is a GitHub Actions action that makes it easy to use **arduino-lint**` in your CI workflows!
19+
There is a GitHub Actions action that makes it easy to use **Arduino Lint**` in your CI workflows!
2020

2121
See https://github.com/arduino/arduino-lint-action for more information.
2222

‎docs/CONTRIBUTING.md

Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+9-9Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ There are several ways you can get involved:
2121

2222
## Issue Reports
2323

24-
Do you need help or have a question about using arduino-lint? Support requests should be made to the
24+
Do you need help or have a question about using Arduino Lint? Support requests should be made to the
2525
[Arduino forum](https://forum.arduino.cc/index.php?board=3.0).
2626

27-
High quality bug reports and feature requests are valuable contributions to the arduino-lint project.
27+
High quality bug reports and feature requests are valuable contributions to the Arduino Lint project.
2828

2929
### Before reporting an issue
3030

@@ -63,7 +63,7 @@ submitting a PR:
6363
- <a id="breaking"></a> If the PR contains a breaking change, please start the commit message and PR title with the
6464
string **[breaking]**. Don't forget to describe in the PR description what changes users might need to make in their
6565
workflow or application due to this PR. A breaking change is a change that forces users to change their command-line
66-
invocations or parsing of the JSON formatted output when upgrading from an older version of arduino-lint.
66+
invocations or parsing of the JSON formatted output when upgrading from an older version of Arduino Lint.
6767
- PR titles indirectly become part of the CHANGELOG so it's crucial to provide a good record of **what** change is being
6868
made in the title; **why** it was made will go in the PR description, along with
6969
[a link to a GitHub issue](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)
@@ -76,7 +76,7 @@ submitting a PR:
7676

7777
### Development prerequisites
7878

79-
To build arduino-lint from sources you need the following tools to be available in your local environment:
79+
To build Arduino Lint from sources you need the following tools to be available in your local environment:
8080

8181
- [Go](https://golang.org/doc/install) version 1.14 or later
8282
- [Taskfile](https://taskfile.dev/#/installation) to help you run the most common tasks from the command line
@@ -123,7 +123,7 @@ To run only the Go unit tests, run:
123123
task go:test-unit
124124
```
125125

126-
By default, all tests for all arduino-lint's Go packages are run. To run unit tests for only one or more specific
126+
By default, all tests for all Arduino Lint's Go packages are run. To run unit tests for only one or more specific
127127
packages, you can set the `TARGETS` environment variable, e.g.:
128128

129129
```
@@ -144,11 +144,11 @@ TEST_REGEX='^TestFindProjects$' TARGETS=./internal/project task go:test-unit
144144

145145
#### Integration tests
146146

147-
Being a command line interface, arduino-lint is heavily interactive and it has to stay consistent in accepting the user
147+
Being a command line interface, Arduino Lint is heavily interactive and it has to stay consistent in accepting the user
148148
input and providing the expected output and proper exit codes.
149149

150150
For these reasons, in addition to regular unit tests the project has a suite of integration tests that actually run
151-
arduino-lint in a different process and assess the options are correctly understood and the output is what we expect.
151+
`arduino-lint` in a different process and assess the options are correctly understood and the output is what we expect.
152152

153153
##### Running tests
154154

@@ -227,7 +227,7 @@ https://arduino.github.io/arduino-lint/dev/
227227
#### Local development
228228

229229
The documentation consists of static content written over several Markdown files under the `docs` subfolder of the
230-
arduino-lint repository, as well as the dynamically generated [command line reference](commands/arduino-lint.md).
230+
Arduino Lint repository, as well as the dynamically generated [command line reference](commands/arduino-lint.md).
231231

232232
When working on the documentation, it is useful to be able to see the effect the changes will have on the generated
233233
documentation website. You can build the documentation website and serve it from your personal computer by running the
@@ -269,7 +269,7 @@ Checks are automatically run on every pull request to verify that documentation
269269

270270
#### Documentation publishing
271271

272-
The arduino-lint git repository has a special branch called `gh-pages` that contains the generated HTML code for the
272+
The Arduino Lint git repository has a special branch called `gh-pages` that contains the generated HTML code for the
273273
documentation website. Every time a change is pushed to this special branch, GitHub automatically triggers a deployment
274274
to pull the change and publish a new version of the website. Do not open Pull Requests to push changes to the `gh-pages`
275275
branch; that will be done exclusively from the CI.

‎docs/build.py

Copy file name to clipboardExpand all lines: docs/build.py
+10-10Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# This file is part of arduino-lint.
1+
# This file is part of Arduino Lint.
22

33
# Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44

55
# This software is released under the GNU General Public License version 3,
6-
# which covers the main part of arduino-lint.
6+
# which covers the main part of Arduino Lint.
77
# The terms of this license can be found at:
88
# https://www.gnu.org/licenses/gpl-3.0.en.html
99

@@ -21,37 +21,37 @@
2121
import click
2222
from git import Repo
2323

24-
# In order to provide support for multiple arduino-lint releases, Documentation is versioned so that visitors can select
24+
# In order to provide support for multiple Arduino Lint releases, Documentation is versioned so that visitors can select
2525
# which version of the documentation website should be displayed. Unfortunately this feature isn't provided by GitHub
2626
# pages or MkDocs, so we had to implement it on top of the generation process.
2727
#
2828
# Before delving into the details of the generation process, here follow some requirements that were established to
2929
# provide versioned documentation:
3030
#
31-
# - A special version of the documentation called `dev` is provided to reflect the status of the arduino-lint on the
31+
# - A special version of the documentation called `dev` is provided to reflect the status of Arduino Lint on the
3232
# `main` branch - this includes unreleased features and bugfixes.
33-
# - Docs are versioned after the minor version of an arduino-lint release. For example, arduino-lint `0.99.1` and
33+
# - Docs are versioned after the minor version of an Arduino Lint release. For example, Arduino Lint `0.99.1` and
3434
# `0.99.2` will be both covered by documentation version `0.99`.
3535
# - The landing page of the documentation website will automatically redirect visitors to the documentation of the most
36-
# recently released version of arduino-lint.
36+
# recently released version of Arduino Lint.
3737
#
3838
# To implement the requirements above, the execution of MkDocs is wrapped using a CLI tool called Mike
3939
# (https://github.com/jimporter/mike) that does a few things for us:
4040
#
41-
# - It runs MkDocs targeting subfolders named after the arduino-lint version, e.g. documentation for version `0.10.1`
41+
# - It runs MkDocs targeting subfolders named after the Arduino Lint version, e.g. documentation for version `0.10.1`
4242
# can be found under the folder `0.10`.
4343
# - It injects an HTML control into the documentation website that lets visitors choose which version of the docs to
4444
# browse from a dropdown list.
4545
# - It provides a redirect to a version we decide when visitors hit the landing page of the documentation website.
4646
# - It pushes generated contents to the `gh-pages` branch.
4747
#
48-
# In order to avoid unwanted changes to the public website hosting the arduino-lint documentation, only Mike is allowed
48+
# In order to avoid unwanted changes to the public website hosting the Arduino Lint documentation, only Mike is allowed
4949
# to push changes to the `gh-pages` branch, and this only happens from within the CI, in the "Publish documentation"
5050
# workflow: https://github.com/arduino/arduino-lint/blob/main/.github/workflows/publish-docs.yml
5151
#
52-
# The CI is responsible for guessing which version of arduino-lint we're building docs for, so that generated content
52+
# The CI is responsible for guessing which version of Arduino Lint we're building docs for, so that generated content
5353
# will be stored in the appropriate section of the documentation website. Because this guessing might be fairly complex,
54-
# the logic is implemented in this Python script. The script will determine the version of arduino-lint that was
54+
# the logic is implemented in this Python script. The script will determine the version of Arduino Lint that was
5555
# modified in the current commit (either `dev` or an official, numbered release) and whether the redirect to the latest
5656
# version that happens on the landing page should be updated or not.
5757

‎docs/index.md

Copy file name to clipboardExpand all lines: docs/index.md
+10-10Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**arduino-lint** is a command line tool that checks for common problems with [Arduino](https://www.arduino.cc/)
1+
**Arduino Lint** is a command line tool that checks for common problems with [Arduino](https://www.arduino.cc/)
22
projects.
33

44
Its focus is on the structure, metadata, and configuration of Arduino projects, rather than the code. Rules cover
@@ -18,7 +18,7 @@ arduino-lint
1818

1919
This will automatically detect the project type and check it against the relevant rules.
2020

21-
The default configuration of **arduino-lint** provides for the most common use case, but you have the option of changing
21+
The default configuration of **Arduino Lint** provides for the most common use case, but you have the option of changing
2222
settings via [command line flags](commands/arduino-lint.md):
2323

2424
### Compliance setting
@@ -42,7 +42,7 @@ accepted by this flag are:
4242
updates of Arduino libraries. In order to be accepted for inclusion in Library Manager, a library is required to meet
4343
[some requirements](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ).
4444

45-
**arduino-lint** provides checks for these requirements as well, controlled by the `--library-manager` flag.
45+
**Arduino Lint** provides checks for these requirements as well, controlled by the `--library-manager` flag.
4646

4747
The Library Manager submission-specific rules are enabled via `--library-manager submit`. Even if your library isn't yet
4848
ready to be added to Library Manager, it's a good idea to use this setting to ensure no incompatibilities are
@@ -54,11 +54,11 @@ tell you whether your library is compliant with these rules.
5454

5555
### Integration
5656

57-
The `--format` flag configures the format of **arduino-lint**'s output. The default `--format text` setting provides
58-
human readable output. For automation or integration with other tools, the machine readable output provided by
59-
`--format json` may be more convenient. This setting exposes every detail of the rules that were applied.
57+
The `--format` flag configures the format of `arduino-lint`'s output. The default `--format text` setting provides human
58+
readable output. For automation or integration with other tools, the machine readable output provided by `--format json`
59+
may be more convenient. This setting exposes every detail of the rules that were applied.
6060

61-
The `--report-file` flag causes **arduino-lint** to write the JSON output to the specified file.
61+
The `--report-file` flag causes `arduino-lint` to write the JSON output to the specified file.
6262

6363
### Environment variables
6464

@@ -72,7 +72,7 @@ Additional configuration options intended for internal use or development can be
7272

7373
## Continuous integration
7474

75-
**arduino-lint** would be a great addition to your
75+
**Arduino Lint** would be a great addition to your
7676
[continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) system. Running the tool after each
7777
change to the project can allow you to identify any problems that were introduced.
7878

@@ -81,11 +81,11 @@ This is easily done by using the `arduino/arduino-lint-action`
8181
https://github.com/arduino/arduino-lint-action
8282

8383
Add [a simple workflow file](https://github.com/arduino/arduino-lint-action#usage) to the repository of your Arduino
84-
project and GitHub will automatically run arduino-lint on every pull request and push.
84+
project and GitHub will automatically run Arduino Lint on every pull request and push.
8585

8686
## Support and feedback
8787

88-
You can discuss or get assistance with using **arduino-lint** on the
88+
You can discuss or get assistance with using **Arduino Lint** on the
8989
[Arduino Forum](https://forum.arduino.cc/index.php?board=3.0).
9090

9191
Feedback is welcome! Please submit feature requests or bug reports to the

‎docs/installation.md

Copy file name to clipboardExpand all lines: docs/installation.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The script requires `sh`, which is always available on Linux and macOS. `sh` is not available by default on Windows. The
44
script can be run on Windows by installing [Git for Windows](https://gitforwindows.org/), then running it from Git Bash.
55

6-
This script will install the latest version of arduino-lint to `$PWD/bin`:
6+
This script will install the latest version of Arduino Lint to `$PWD/bin`:
77

88
```
99
curl -fsSL https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/install.sh | sh
@@ -15,10 +15,10 @@ If you want to target a different directory, for example `~/local/bin`, set the
1515
curl -fsSL https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/install.sh | BINDIR=~/local/bin sh
1616
```
1717

18-
If you would like to use the `arduino-lint` command from any location, install arduino-lint to a directory already in
19-
your `PATH` or add the arduino-lint installation path to your `PATH` environment variable.
18+
If you would like to use the `arduino-lint` command from any location, install Arduino Lint to a directory already in
19+
your `PATH` or add the Arduino Lint installation path to your `PATH` environment variable.
2020

21-
If you want to download a specific arduino-lint version, for example `0.9.0` or `nightly-latest`, pass the version
21+
If you want to download a specific Arduino Lint version, for example `0.9.0` or `nightly-latest`, pass the version
2222
number as a parameter like this:
2323

2424
```
@@ -30,7 +30,7 @@ curl -fsSL https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/insta
3030
Pre-built binaries for all the supported platforms are available for download from the links below.
3131

3232
If you would like to use the `arduino-lint` command from any location, extract the downloaded file to a directory
33-
already in your `PATH` or add the arduino-lint installation path to your `PATH` environment variable.
33+
already in your `PATH` or add the Arduino Lint installation path to your `PATH` environment variable.
3434

3535
#### Latest release
3636

@@ -81,5 +81,5 @@ Checksums for the nightly builds are available at
8181

8282
### Build from source
8383

84-
If you’re familiar with Golang or if you want to contribute to the project, you will probably build arduino-lint locally
84+
If you’re familiar with Golang or if you want to contribute to the project, you will probably build Arduino Lint locally
8585
with your Go toolchain. See the ["How to contribute"](CONTRIBUTING.md#building-the-source-code) page for instructions.

‎docsgen/main.go

Copy file name to clipboardExpand all lines: docsgen/main.go
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
// Arduino software without disclosing the source code of your own applications.
1414
// To purchase a commercial license, send an email to license@arduino.cc.
1515

16-
// Package main generates Markdown documentation for the arduino-lint CLI.
16+
// Package main generates Markdown documentation for the Arduino Lint CLI.
1717
package main
1818

1919
import (

‎etc/install.sh

Copy file name to clipboardExpand all lines: etc/install.sh
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
#
77
# Usage:
88
#
9-
# To install the latest version of arduino-lint:
9+
# To install the latest version of Arduino Lint:
1010
# ./install.sh
1111
#
12-
# To pin a specific release of arduino-lint:
12+
# To pin a specific release of Arduino Lint:
1313
# ./install.sh 0.9.0
1414
#
1515

‎internal/cli/cli.go

Copy file name to clipboardExpand all lines: internal/cli/cli.go
+4-4Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-lint.
1+
// This file is part of Arduino Lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-lint.
6+
// which covers the main part of Arduino Lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//
@@ -13,7 +13,7 @@
1313
// Arduino software without disclosing the source code of your own applications.
1414
// To purchase a commercial license, send an email to license@arduino.cc.
1515

16-
// Package cli defines the arduino-lint command line interface.
16+
// Package cli defines the Arduino Lint command line interface.
1717
package cli
1818

1919
import (
@@ -25,7 +25,7 @@ import (
2525
func Root() *cobra.Command {
2626
rootCommand := &cobra.Command{
2727
Short: "Linter for Arduino projects.",
28-
Long: "arduino-lint checks for specification compliance and other common problems with Arduino projects",
28+
Long: "Arduino Lint checks for specification compliance and other common problems with Arduino projects",
2929
DisableFlagsInUseLine: true,
3030
Use: "arduino-lint [FLAG]... [PROJECT_PATH]...\n\nLint project in PROJECT_PATH or current path if no PROJECT_PATH argument provided.",
3131
Run: command.ArduinoLint,

‎internal/command/command.go

Copy file name to clipboardExpand all lines: internal/command/command.go
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-lint.
1+
// This file is part of Arduino Lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-lint.
6+
// which covers the main part of Arduino Lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//

‎internal/configuration/configuration.go

Copy file name to clipboardExpand all lines: internal/configuration/configuration.go
+4-4Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-lint.
1+
// This file is part of Arduino Lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-lint.
6+
// which covers the main part of Arduino Lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//
@@ -13,7 +13,7 @@
1313
// Arduino software without disclosing the source code of your own applications.
1414
// To purchase a commercial license, send an email to license@arduino.cc.
1515

16-
// Package configuration handles the configuration of the arduino-lint tool.
16+
// Package configuration handles the configuration of the Arduino Lint tool.
1717
package configuration
1818

1919
import (
@@ -205,7 +205,7 @@ func Version() string {
205205

206206
var commit string
207207

208-
// Commit returns the HEAD commit of the arduino-lint repository when the application was built.
208+
// Commit returns the HEAD commit of the Arduino Lint repository when the application was built.
209209
func Commit() string {
210210
return commit
211211
}

‎internal/configuration/configuration_test.go

Copy file name to clipboardExpand all lines: internal/configuration/configuration_test.go
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-lint.
1+
// This file is part of Arduino Lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-lint.
6+
// which covers the main part of Arduino Lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//

‎internal/configuration/defaults.go

Copy file name to clipboardExpand all lines: internal/configuration/defaults.go
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-lint.
1+
// This file is part of Arduino Lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-lint.
6+
// which covers the main part of Arduino Lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.