Skip to content

Commit

Permalink
feat: support v prefix in CLI GH release name
Browse files Browse the repository at this point in the history
From Arduino CLI `>=0.35.0-rc.1`, the `v` prefix is expected in the
GitHub release name.

Ref: arduino/arduino-cli#2374
Signed-off-by: dankeboy36 <[email protected]>
  • Loading branch information
dankeboy36 committed Oct 22, 2023
1 parent 072d71c commit c2bcfe2
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 5 deletions.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ardunno-cli-gen",
"version": "0.1.5",
"version": "0.1.6",
"description": "Generates nice-grpc API for the Arduino CLI",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
Expand Down
12 changes: 12 additions & 0 deletions src/__tests__/generate.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,18 @@ describe('generate', () => {
assert.equal(parseSemver('v0.29.1'), '0.29.1'));
it("should parse valid semver '>=0.29.0' as a semver [arduino/arduino-cli#1931]", () =>
assert.equal(parseSemver('0.29.0'), '0.29.0'));
describe("should trim the 'v' prefix in semver if '<v0.35.0-rc.1' [arduino/arduino-cli#2374]", () => {
[
['v0.34.2', '0.34.2'],
['v0.35.0-rc.0', '0.35.0-rc.0'],
['v0.35.0-rc.1', 'v0.35.0-rc.1'],
['v0.35.0', 'v0.35.0'],
['v0.35.1', 'v0.35.1'],
].forEach(([toParse, expected]) =>
it(`from '${toParse}' to ${expected}`, () =>
assert.equal(parseSemver(toParse), expected))
);
});
it("should parse to GitHub ref when version is not greater than '0.28.0'", () =>
assert.deepEqual(parseSemver('0.28.0'), {
owner: 'arduino',
Expand Down
19 changes: 17 additions & 2 deletions src/generate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,15 @@ export function parseSemver(src: string): string | GitHub | undefined {
return undefined;
}
const semver = new SemVer(src, true);
const version = semver.version;
let version = semver.version;
if (hasSemverPrefix(version)) {
log(
'parsed semver %s is >=v0.35.0-rc.1. using raw version %s',
version,
semver.raw
);
version = semver.raw;
}
if (canDownloadProtos(semver)) {
log('parsed semver %s is >=0.29.0', version);
return version;
Expand All @@ -333,12 +341,19 @@ export function parseSemver(src: string): string | GitHub | undefined {
}

/**
* The `.proto` files were not part of the Arduino CLI release before version 0.29.0 ([`arduino/arduino-cli#1931`](https://github.com/arduino/arduino-cli/pull/1931)).
* The `.proto` files were not part of the Arduino CLI release before version `0.29.0` ([`arduino/arduino-cli#1931`](https://github.com/arduino/arduino-cli/pull/1931)).
*/
function canDownloadProtos(semver: SemVer | string): boolean {
return gte(semver, new SemVer('0.29.0'));
}

/**
* The Arduino CLI GitHub release has the `'v'` prefix from version `>=v0.35.0-rc.1` ([`arduino/arduino-cli#2374`](https://github.com/arduino/arduino-cli/pull/2374)).
*/
function hasSemverPrefix(semver: SemVer | string): boolean {
return gte(semver, new SemVer('0.35.0-rc.1'));
}

// Taken from https://github.com/microsoft/TypeScript/issues/32098#issuecomment-1212501932
type RegExpGroups<T extends string[]> =
| (RegExpMatchArray & {
Expand Down

0 comments on commit c2bcfe2

Please sign in to comment.