Unverified Commit 5c5c176a authored by Cristian Maglie's avatar Cristian Maglie Committed by GitHub

[skip-changelog] Force the use of the latest prettier in `general:format-prettier` task (#2626)

* Set the version of prettier to use in task general:format-prettier

* Updated docs
parent b16ae70a
...@@ -327,8 +327,8 @@ changes in the generated code. ...@@ -327,8 +327,8 @@ changes in the generated code.
### Additional settings ### Additional settings
If you need to push a commit that's only shipping documentation changes or example files, thus a complete no-op for the If you need to push a commit that's only shipping documentation changes or example files, thus a complete no-op for the
test suite, please start the commit message with the string **[skip ci]** to skip the build and give that slot to test suite, please start the commit message with the string **[skip ci]** to skip the build and give that slot to someone
someone else who does need it. else who does need it.
If your PR doesn't need to be included in the changelog, please start the commit message and PR title with the string If your PR doesn't need to be included in the changelog, please start the commit message and PR title with the string
**[skip changelog]** **[skip changelog]**
......
...@@ -4,8 +4,8 @@ The Arduino CLI is an open source Command Line Application written in [Golang] t ...@@ -4,8 +4,8 @@ The Arduino CLI is an open source Command Line Application written in [Golang] t
compile, verify and upload sketches to Arduino boards and that’s capable of managing all the software and tools needed compile, verify and upload sketches to Arduino boards and that’s capable of managing all the software and tools needed
in the process. But don’t get fooled by its name: Arduino CLI can do much more than the average console application, as in the process. But don’t get fooled by its name: Arduino CLI can do much more than the average console application, as
shown by [Arduino IDE 2.x][arduino ide 2.x] and [Arduino Cloud], which rely on it for similar purposes but each one in a shown by [Arduino IDE 2.x][arduino ide 2.x] and [Arduino Cloud], which rely on it for similar purposes but each one in a
completely different way from the other. In this article we introduce the three pillars of the Arduino CLI, explaining completely different way from the other. In this article we introduce the three pillars of the Arduino CLI, explaining how
how we designed the software so that it can be effectively leveraged under different scenarios. we designed the software so that it can be effectively leveraged under different scenarios.
## The first pillar: command line interface ## The first pillar: command line interface
...@@ -132,18 +132,17 @@ $ arduino-cli lib search FlashStorage --format json | jq .libraries[0].latest ...@@ -132,18 +132,17 @@ $ arduino-cli lib search FlashStorage --format json | jq .libraries[0].latest
``` ```
Even if not related to software design, one last feature that’s worth mentioning is the availability of a one-line Even if not related to software design, one last feature that’s worth mentioning is the availability of a one-line
[installation script] that can be used to make the latest version of the Arduino CLI available on most systems with an [installation script] that can be used to make the latest version of the Arduino CLI available on most systems with an HTTP
HTTP client like curl or wget and a shell like bash. client like curl or wget and a shell like bash.
For more information on Arduino CLI's command line interface, see the [command reference]. For more information on Arduino CLI's command line interface, see the [command reference].
## The second pillar: gRPC interface ## The second pillar: gRPC interface
[gRPC] is a high performance [RPC] framework that can efficiently connect client and server applications. The Arduino [gRPC] is a high performance [RPC] framework that can efficiently connect client and server applications. The Arduino
CLI can act as a gRPC server (we call it [daemon mode]), exposing a set of procedures that implement the very same set CLI can act as a gRPC server (we call it [daemon mode]), exposing a set of procedures that implement the very same set of
of features of the command line interface and waiting for clients to connect and use them. To give an idea, the features of the command line interface and waiting for clients to connect and use them. To give an idea, the following is
following is some [Golang] code capable of retrieving the version number of a remote running Arduino CLI server some [Golang] code capable of retrieving the version number of a remote running Arduino CLI server instance:
instance:
```go ```go
// This file is part of arduino-cli. // This file is part of arduino-cli.
...@@ -211,8 +210,8 @@ a common Golang API, based on the gRPC protobuf definitions: a set of functions ...@@ -211,8 +210,8 @@ a common Golang API, based on the gRPC protobuf definitions: a set of functions
offered by the Arduino CLI, so that when we provide a fix or a new feature, they are automatically available to both the offered by the Arduino CLI, so that when we provide a fix or a new feature, they are automatically available to both the
command line and gRPC interfaces. The source modules implementing this API are implemented through the `commands` command line and gRPC interfaces. The source modules implementing this API are implemented through the `commands`
package, and it can be imported in other Golang programs to embed a full-fledged Arduino CLI. For example, this is how package, and it can be imported in other Golang programs to embed a full-fledged Arduino CLI. For example, this is how
some backend services powering [Arduino Cloud] can compile sketches and manage libraries. Just to give you a taste of some backend services powering [Arduino Cloud] can compile sketches and manage libraries. Just to give you a taste of what
what it means to embed the Arduino CLI, here is how to search for a core using the API: it means to embed the Arduino CLI, here is how to search for a core using the API:
```go ```go
// This file is part of arduino-cli. // This file is part of arduino-cli.
...@@ -297,7 +296,8 @@ use and provide support for. ...@@ -297,7 +296,8 @@ use and provide support for.
You can start playing with the Arduino CLI right away. The code is open source and [the repo][arduino cli repository] You can start playing with the Arduino CLI right away. The code is open source and [the repo][arduino cli repository]
contains [example code showing how to implement a gRPC client][grpc client example]. If you’re curious about how we contains [example code showing how to implement a gRPC client][grpc client example]. If you’re curious about how we
designed the low level API, have a look at the [commands package] and don’t hesitate to leave feedback on the [issue designed the low level API, have a look at the [commands package] and don’t hesitate to leave feedback on the [issue
tracker] if you’ve got a use case that doesn’t fit one of the three pillars. tracker]
if you’ve got a use case that doesn’t fit one of the three pillars.
[golang]: https://go.dev/ [golang]: https://go.dev/
[arduino ide 2.x]: https://github.com/arduino/arduino-ide [arduino ide 2.x]: https://github.com/arduino/arduino-ide
......
...@@ -6,7 +6,8 @@ ...@@ -6,7 +6,8 @@
"": { "": {
"devDependencies": { "devDependencies": {
"markdown-link-check": "3.10.3", "markdown-link-check": "3.10.3",
"markdownlint-cli": "^0.33.0" "markdownlint-cli": "^0.33.0",
"prettier": "^3.3.1"
} }
}, },
"node_modules/ansi-styles": { "node_modules/ansi-styles": {
...@@ -664,6 +665,21 @@ ...@@ -664,6 +665,21 @@
"url": "https://github.com/inikulin/parse5?sponsor=1" "url": "https://github.com/inikulin/parse5?sponsor=1"
} }
}, },
"node_modules/prettier": {
"version": "3.3.1",
"resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.1.tgz",
"integrity": "sha512-7CAwy5dRsxs8PHXT3twixW9/OEll8MLE0VRPCJyl7CkS6VHGPSlsVaWTiASPTyGyYRyApxlaWTzwUxVNrhcwDg==",
"dev": true,
"bin": {
"prettier": "bin/prettier.cjs"
},
"engines": {
"node": ">=14"
},
"funding": {
"url": "https://github.com/prettier/prettier?sponsor=1"
}
},
"node_modules/progress": { "node_modules/progress": {
"version": "2.0.3", "version": "2.0.3",
"resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz",
...@@ -1243,6 +1259,12 @@ ...@@ -1243,6 +1259,12 @@
"parse5": "^7.0.0" "parse5": "^7.0.0"
} }
}, },
"prettier": {
"version": "3.3.1",
"resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.1.tgz",
"integrity": "sha512-7CAwy5dRsxs8PHXT3twixW9/OEll8MLE0VRPCJyl7CkS6VHGPSlsVaWTiASPTyGyYRyApxlaWTzwUxVNrhcwDg==",
"dev": true
},
"progress": { "progress": {
"version": "2.0.3", "version": "2.0.3",
"resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz",
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment