Skip to content

Commit 1640a42

Browse files
authored
fix: patch for missing google proto files in CLI release asset (#9)
* fix: patch for missing `google` proto files in CLI (arduino/arduino-cli#2755) * chore: replace `protoc` with `@pingghost/protoc` (arduino/arduino-ide#2457) * chore(ci): build on Node.js 20.x * fix(doc): refresh docs, update protoc version * chore: update formatter + fix example command --------- Signed-off-by: dankeboy36 <dankeboy36@gmail.com>
1 parent 979f92b commit 1640a42

File tree

11 files changed

+426
-220
lines changed

11 files changed

+426
-220
lines changed

.github/workflows/ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
fail-fast: false
1616
matrix:
1717
os: [windows-latest, ubuntu-latest, macos-latest]
18-
node: [16.x, 18.x]
18+
node: [20.x]
1919
runs-on: ${{ matrix.os }}
2020
steps:
2121
- uses: actions/checkout@v3

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ arduino-cli
33
.DS_Store
44
*.ts.bak
55
dist
6+
gen-output

.prettierrc.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,6 @@
1717
"tabWidth": 2
1818
}
1919
}
20-
]
20+
],
21+
"plugins": ["prettier-plugin-packagejson"]
2122
}

.vscode/settings.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
"typescript.tsc.autoDetect": "off",
33
"typescript.tsdk": "./node_modules/typescript/lib",
44
"editor.codeActionsOnSave": {
5-
"source.fixAll.eslint": true
5+
"source.fixAll.eslint": "explicit"
66
}
77
}

.vscode/tasks.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
},
3636
{
3737
"id": "source",
38-
"default": "0.33.0-rc1",
38+
"default": "v1.1.0",
3939
"type": "promptString",
4040
"description": "The source to genegare from. It can be an Arduino CLI version (as a semver), a GitHub commitish, or a filesystem path with the proto file"
4141
}

README.md

+5-9
Original file line numberDiff line numberDiff line change
@@ -100,11 +100,11 @@ npm run test
100100

101101
### Notes
102102

103-
- The underlying `protoc` version is `3.20.3`. It comes from the [`protoc`](https://www.npmjs.com/package/protoc) dependency. `protoc` is not required on the `$PATH`
103+
- The underlying `protoc` version is `3.19.1`. It comes from the [`@pingghost/protoc`](https://www.npmjs.com/package/@pingghost/protoc) dependency. `protoc` is not required on the `$PATH`
104104

105105
```sh
106-
npx protoc --version
107-
libprotoc 3.20.3
106+
npx @pingghost/protoc --version
107+
libprotoc 3.19.1
108108
```
109109

110110
- Use [`debug`](https://www.npmjs.com/package/debug) to log additional details
@@ -120,17 +120,13 @@ npm run test
120120

121121
- Run the generator from the sources (or use the predefined `generate` VS Code task):
122122
- `npm run compile`
123-
- `node dist/cli.js generate 0.32.2 --out ./gen-output
123+
- `node dist/cli.js generate v1.1.0 --out ./gen-output`
124124

125125
## License
126126

127127
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
128128

129-
### ⚠️ Disclaimer
130-
131-
The Arduino CLI, including the proto files, has a [GPL-3.0 license](https://github.com/arduino/arduino-cli/blob/master/LICENSE.txt). `ardunno-cli-gen` does not use any code from the CLI but relies on the proto files. There is an ongoing [conversation](https://github.com/arduino/arduino-cli/issues/1957) with Arduino to relicense the proto files with a more permissive license, such as MIT. Please [open a new issue](https://github.com/dankeboy36/ardunno-cli-gen/issues/new) if you have any concerns regarding the licensing of this project. Thank you!
132-
133-
I made `ardunno-cli-gen` with pure ❤️
129+
I made [`ardunno-cli-gen`](https://github.com/dankeboy36/ardunno-cli-gen) with pure ❤️
134130

135131
## Acknowledgments
136132

0 commit comments

Comments
 (0)