Skip to content

Commit

Permalink
Removed real_name of the libraries.
Browse files Browse the repository at this point in the history
It has been removed from the gRPC API: arduino/arduino-cli#1890

This PR switches from `real_name` to `name` in the UI, as the `name` is
the canonical form provided by the CLI.

Closes arduino#1525

Signed-off-by: Akos Kitta <a.kitta@arduino.cc>
  • Loading branch information
Akos Kitta authored and kittaakos committed Oct 5, 2022
1 parent 0c20ae0 commit 61a11a0
Show file tree
Hide file tree
Showing 6 changed files with 5 additions and 47 deletions.
4 changes: 2 additions & 2 deletions arduino-ide-extension/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -159,9 +159,9 @@
"arduino": {
"cli": {
"version": {
"owner": "cmaglie",
"owner": "arduino",
"repo": "arduino-cli",
"commitish": "download_progress_refactor"
"commitish": "c8ff042"
}
},
"fwuploader": {
Expand Down
6 changes: 0 additions & 6 deletions arduino-ide-extension/src/common/protocol/library-service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -162,12 +162,6 @@ export enum LibraryLocation {
}

export interface LibraryPackage extends ArduinoComponent {
/**
* Same as [`Library#real_name`](https://arduino.github.io/arduino-cli/latest/rpc/commands/#library).
* Should be used for the UI, and `name` is used to uniquely identify a library. It does not have an ID.
*/
readonly label: string;

/**
* An array of string that should be included into the `ino` file if this library is used.
* For example, including `SD` will prepend `#include <SD.h>` to the `ino` file. While including `Bridge`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -765,9 +765,6 @@ export class Library extends jspb.Message {
getContainerPlatform(): string;
setContainerPlatform(value: string): Library;

getRealName(): string;
setRealName(value: string): Library;

getDotALinkage(): boolean;
setDotALinkage(value: boolean): Library;

Expand Down Expand Up @@ -836,7 +833,6 @@ export namespace Library {
sourceDir: string,
utilityDir: string,
containerPlatform: string,
realName: string,
dotALinkage: boolean,
precompiled: boolean,
ldFlags: string,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5447,7 +5447,6 @@ proto.cc.arduino.cli.commands.v1.Library.toObject = function(includeInstance, ms
sourceDir: jspb.Message.getFieldWithDefault(msg, 11, ""),
utilityDir: jspb.Message.getFieldWithDefault(msg, 12, ""),
containerPlatform: jspb.Message.getFieldWithDefault(msg, 14, ""),
realName: jspb.Message.getFieldWithDefault(msg, 16, ""),
dotALinkage: jspb.Message.getBooleanFieldWithDefault(msg, 17, false),
precompiled: jspb.Message.getBooleanFieldWithDefault(msg, 18, false),
ldFlags: jspb.Message.getFieldWithDefault(msg, 19, ""),
Expand Down Expand Up @@ -5548,10 +5547,6 @@ proto.cc.arduino.cli.commands.v1.Library.deserializeBinaryFromReader = function(
var value = /** @type {string} */ (reader.readString());
msg.setContainerPlatform(value);
break;
case 16:
var value = /** @type {string} */ (reader.readString());
msg.setRealName(value);
break;
case 17:
var value = /** @type {boolean} */ (reader.readBool());
msg.setDotALinkage(value);
Expand Down Expand Up @@ -5724,13 +5719,6 @@ proto.cc.arduino.cli.commands.v1.Library.serializeBinaryToWriter = function(mess
f
);
}
f = message.getRealName();
if (f.length > 0) {
writer.writeString(
16,
f
);
}
f = message.getDotALinkage();
if (f) {
writer.writeBool(
Expand Down Expand Up @@ -6084,24 +6072,6 @@ proto.cc.arduino.cli.commands.v1.Library.prototype.setContainerPlatform = functi
};


/**
* optional string real_name = 16;
* @return {string}
*/
proto.cc.arduino.cli.commands.v1.Library.prototype.getRealName = function() {
return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 16, ""));
};


/**
* @param {string} value
* @return {!proto.cc.arduino.cli.commands.v1.Library} returns this
*/
proto.cc.arduino.cli.commands.v1.Library.prototype.setRealName = function(value) {
return jspb.Message.setProto3StringField(this, 16, value);
};


/**
* optional bool dot_a_linkage = 17;
* @return {boolean}
Expand Down
4 changes: 2 additions & 2 deletions arduino-ide-extension/src/node/examples-service-impl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -124,11 +124,11 @@ export class ExamplesServiceImpl implements ExamplesService {
* location of the examples. Otherwise it creates the example container from the direct examples FS paths.
*/
private async tryGroupExamples({
label,
name,
exampleUris,
installDirUri,
}: LibraryPackage): Promise<SketchContainer> {
const container = SketchContainer.create(label);
const container = SketchContainer.create(name);
if (!installDirUri || !exampleUris.length) {
return container;
}
Expand Down
4 changes: 1 addition & 3 deletions arduino-ide-extension/src/node/library-service-impl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export class LibraryServiceImpl
if (installedLib.hasLibrary()) {
const lib = installedLib.getLibrary();
if (lib) {
installedLibsIdx.set(lib.getRealName(), installedLib);
installedLibsIdx.set(lib.getName(), installedLib);
}
}
}
Expand Down Expand Up @@ -210,7 +210,6 @@ export class LibraryServiceImpl
return toLibrary(
{
name: library.getName(),
label: library.getRealName(),
installedVersion,
installable: true,
description: library.getSentence(),
Expand Down Expand Up @@ -443,7 +442,6 @@ function toLibrary(
): LibraryPackage {
return {
name: '',
label: '',
exampleUris: [],
installable: false,
deprecated: false,
Expand Down

0 comments on commit 61a11a0

Please sign in to comment.