feat: rename, deletion, and validation support #1833

kittaakos · 2023-01-25T15:00:43Z

Motivation

Support for sketch folder and code file name validation. Cached cloud sketches use the Create Editor's validation. The rest uses the spec.
Support for renaming and deleting local and cloud sketches.
Renamed remote to cloud sketch in the UI.

Change description

Other information

Closes #1599
Closes #1825
Closes #649
Closes #1847
Closes #1882
Ref #1826 (partially fixes)

Reviewer checklist

PR addresses a single concern.
The PR has no duplicates (please search among the Pull Requests before creating one)
PR title and description are properly filled.
Docs have been added / updated (for bug fixes / features)

kittaakos · 2023-02-01T09:57:53Z

There is another bug with the server. When IDE2 tries to rename a non-existing sketch via the POST /create/v3/files/mv endpoint, IDE2 expects an HTTP 404 (Not found), but the server fails with HTTP 500. IDE2 has no chance to handle it.

kittaakos · 2023-02-01T11:14:11Z

~~bug~~ ✅ 38e0806 + b5be42a

must-set-focus-in-editor-after-rename.mp4

Upstream: eclipse-theia/theia#12139

kittaakos · 2023-02-01T11:19:30Z

~~When deleting the sketch, the window closes, but the sketch is not cleaned up from the filesystem. (On Windows)~~

Update: hacked in 743c9bf

arduino-ide-extension/src/node/sketches-service-impl.ts

kittaakos · 2023-02-01T19:04:04Z

~~when IDE2 prompts a save as to repair the sketch folder name, it should propose a valid name.~~

e4d12be

arduino-ide-extension/src/common/protocol/sketches-service.ts

per1234 · 2023-02-08T07:36:19Z

arduino-ide-extension/src/browser/contributions/cloud-contribution.ts

+export function sketchNotFound(input: string): string {
+  return nls.localize(
+    'arduino/cloudSketch/notFound',
+    "Could not pull the cloud sketch '{0}'. It does not exist.",


Should "cloud" be capitalized?

I'm not a fan of the recent trend I've observed of sometimes capitalizing "sketch" in sentences, since that is not a proper noun, but if "cloud" is short for the "Arduino Cloud" service (as opposed to being a reference to the general concept of "the cloud"), then this is a proper noun and so should be capitalized.

Should "cloud" be capitalized?

I will leave this decision to you. Whichever you think is the best.

the recent trend I've observed of sometimes capitalizing "sketch" in sentences

I found the following translations from this PR where the "sketch" is capitalized in a sentence. (I hope I did not leave out anything):

These have not changed in this PR or recently:

arduino-ide/arduino-ide-extension/src/browser/widgets/cloud-sketchbook/cloud-sketchbook-tree.ts

Line 107 in 9a3b107

'Pulling this Sketch from the Cloud will overwrite its local version. Are you sure you want to continue?'

arduino-ide/arduino-ide-extension/src/browser/dialogs/cloud-share-sketch-dialog.tsx

Line 66 in 9a3b107

'Choose visibility of your Sketch:'

arduino-ide/arduino-ide-extension/src/browser/dialogs/cloud-share-sketch-dialog.tsx

Line 75 in 9a3b107

'Private. Only you can view the Sketch.'

arduino-ide/arduino-ide-extension/src/browser/dialogs/cloud-share-sketch-dialog.tsx

Line 86 in 9a3b107

'Public. Anyone with the link can view the Sketch.'

arduino-ide/arduino-ide-extension/src/browser/widgets/cloud-sketchbook/cloud-sketchbook-tree.ts

Line 70 in 9a3b107

'This is a Public Sketch. Before pushing, make sure any sensitive information is defined in arduino_secrets.h files. You can make a Sketch private from the Share panel.'

arduino-ide/arduino-ide-extension/src/browser/dialogs/firmware-uploader/firmware-uploader-component.tsx

Line 187 in 9a3b107

'Installation will overwrite the Sketch on the board.'

These have not changed, and the sentence starts with "sketch":

arduino-ide/arduino-ide-extension/src/browser/contributions/debug.ts

Line 215 in 9a3b107

"Sketch '{0}' must be verified before starting a debug session. Please verify the sketch and start debugging again. Do you want to verify the sketch now?",

These are command or menu labels, so capitalized "sketch" is expected:

arduino-ide/arduino-ide-extension/src/browser/contributions/new-sketch.ts

Line 24 in 9a3b107

label: nls.localize('arduino/sketch/new', 'New Sketch'),

arduino-ide/arduino-ide-extension/src/browser/widgets/cloud-sketchbook/cloud-sketchbook-composite-widget.tsx

Line 59 in 9a3b107

'New Cloud Sketch'

arduino-ide/arduino-ide-extension/src/browser/contributions/open-sketch-external.ts

Line 25 in 9a3b107

label: nls.localize('arduino/sketch/showFolder', 'Show Sketch Folder'),

arduino-ide/arduino-ide-extension/src/browser/widgets/sketchbook/sketchbook-commands.ts

Line 15 in 9a3b107

label: 'Open Sketch in New Window',

arduino-ide/arduino-ide-extension/src/browser/arduino-frontend-contribution.tsx

Line 161 in 9a3b107

nls.localize('arduino/menu/sketch', 'Sketch')

arduino-ide/arduino-ide-extension/src/browser/contributions/open-sketch.ts

Line 93 in 9a3b107

name: nls.localize('arduino/sketch/sketch', 'Sketch'),

arduino-ide/arduino-ide-extension/src/browser/contributions/archive-sketch.ts

Line 25 in 9a3b107

label: nls.localize('arduino/sketch/archiveSketch', 'Archive Sketch'),

arduino-ide/arduino-ide-extension/src/browser/widgets/cloud-sketchbook/cloud-sketchbook-contributions.ts

Line 78 in 9a3b107

label: 'Pull Sketch',

arduino-ide/arduino-ide-extension/src/browser/widgets/cloud-sketchbook/cloud-sketchbook-contributions.ts

Line 87 in 9a3b107

label: 'Push Sketch',

arduino-ide/arduino-ide-extension/src/browser/contributions/new-cloud-sketch.ts

Line 55 in 9a3b107

label: nls.localize('arduino/cloudSketch/new', 'New Cloud Sketch'),

arduino-ide/arduino-ide-extension/src/browser/widgets/sketchbook/sketchbook-composite-widget.tsx

Line 84 in 9a3b107

label={nls.localize('arduino/sketchbook/newSketch', 'New Sketch')}

arduino-ide/arduino-ide-extension/src/browser/widgets/cloud-sketchbook/cloud-sketchbook-contributions.ts

Line 217 in 9a3b107

title: nls.localize('arduino/cloud/shareSketch', 'Share Sketch'),

These are new and were requested in the design doc:

arduino-ide/arduino-ide-extension/src/browser/contributions/rename-cloud-sketch.ts

Line 85 in 9a3b107

'New name of the Cloud Sketch'

arduino-ide/arduino-ide-extension/src/browser/contributions/new-cloud-sketch.ts

Line 100 in 9a3b107

'Name of the new Cloud Sketch'

Let me know what to do. Thanks!

I will leave this decision to you. Whichever you think is the best.

I surveyed the Arduino Cloud-related content on arduino.cc and found that "Cloud" is capitalized in contexts equivalent to "Cloud sketch". So I think it should be capitalized.

the sentence starts with "sketch":

These are command or menu labels, so capitalized "sketch" is expected:

Yes, in cases where the work occurs at the start of a sentence or contexts where the standard for capitalization style is "title case", there is no question that "Sketch" is correct.

These are new and were requested in the design doc:

Then I guess I would have to request the input of the designers.

@91volt @gmarchiarduino please provide clear rules for when "sketch" should and should not be capitalized. As I've said several times in the past, it would be very helpful to have this sort of thing documented in a style guide.

This part is something I cannot control, so I moved it to its dedicated task: #1884.

arduino-ide-extension/src/browser/theia/workspace/workspace-commands.ts

per1234

UPDATE: Fixed by fef3b6a
Cloud sketch can be created with Windows-incompatible trailing .

Windows does not support folder names ending in `.`:
https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file#:~:text=Do%20not%20end%20a%20file%20or%20directory%20name%20with%20a%20space%20or%20a%20period

Do not end a file or directory name with a space or a period. Although the underlying file system may support such names, the Windows shell and user interface does not.

When creating/renaming local sketches, Arduino IDE automatically removes a trailing . if the user adds one, but this is not done when creating/renaming Cloud sketches.

To reproduce

Start the IDE build from this PR on a Windows machine.

Select File > New Cloud Sketch from the Arduino IDE menus.

Type EndsWithDot. in the sketch name field.

Click the "OK" button.
🐛 Multiple errors notifications and a spurious sketch name mismatch dialog appear:

Click the "OK" button on the dialog.
🐛 The sketch fails to open.

Open the EndsWithDot. sketch from the Cloud sketchbook.
🐛 The sketch fails to open.

Arduino IDE version

bf6c814 (tester build for 9687fc6)

Operating system

Windows

Operating system version

11

arduino-ide-extension/src/common/protocol/sketches-service.ts

kittaakos · 2023-02-09T09:44:50Z

Great review!

Arduino IDE automatically removes a trailing . if the user adds one

I was surprised because there is no such logic in IDE2. It turned out, the OS is cutting this, not IDE2. Please take a look at the attached screencast. Electron's native file dialog does it on save:

os_trims_the_dot.mp4

When using the CLI:

c:\Users\kittaakos\Desktop\sketchbooks>arduino-cli.exe version
arduino-cli.exe  Version: 0.30.0 Commit: 83700ca2 Date: 2023-02-08T14:48:15Z

c:\Users\kittaakos\Desktop\sketchbooks>arduino-cli.exe sketch new endswithdot.
Sketch created in: c:\Users\kittaakos\Desktop\sketchbooks\endswithdot

Doing with mkdir from CMD.EXE:

c:\Users\kittaakos\Desktop\sketchbooks\test>mkdir test.

c:\Users\kittaakos\Desktop\sketchbooks\test>dir
 Volume in drive C has no label.
 Volume Serial Number is 04F3-13CC

 Directory of c:\Users\kittaakos\Desktop\sketchbooks\test

02/09/2023  10:16 AM    <DIR>          .
02/09/2023  10:16 AM    <DIR>          ..
02/09/2023  10:16 AM    <DIR>          test
               0 File(s)              0 bytes
               3 Dir(s)  215,877,074,944 bytes free

arduino-ide-extension/src/browser/contributions/save-as-sketch.ts

Closes #1599 Closes #1825 Closes #649 Closes #1847 Closes #1882 Co-authored-by: Akos Kitta <a.kitta@arduino.cc> Co-authored-by: per1234 <accounts@perglass.com> Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

per1234

Very excellent work. Thanks Akos!

kittaakos mentioned this pull request Jan 27, 2023

fix: enforce valid sketch folder name on Save as #1821

Closed

4 tasks

kittaakos changed the base branch from #1599 to main January 27, 2023 09:23

per1234 added type: enhancement Proposed improvement topic: code Related to content of the project itself labels Jan 27, 2023

kittaakos force-pushed the #1825 branch from a19b864 to 84e9ea3 Compare January 31, 2023 12:29

kittaakos changed the title ~~fix: local sketch deletion + rename~~ feat: rename, deletion, and validation support Jan 31, 2023

kittaakos mentioned this pull request Feb 1, 2023

Enable rename and delete options for Cloud Sketch and/or any of its files #1825

Closed

3 tasks

kittaakos force-pushed the #1825 branch 3 times, most recently from 8804332 to 31cc604 Compare February 1, 2023 10:25

kittaakos added the type: imperfection Perceived defect in any part of project label Feb 1, 2023

kittaakos commented Feb 1, 2023

View reviewed changes

arduino-ide-extension/src/node/sketches-service-impl.ts Outdated Show resolved Hide resolved

kittaakos force-pushed the #1825 branch 6 times, most recently from 5b7a045 to 0e6c19f Compare February 3, 2023 14:06

kittaakos marked this pull request as ready for review February 3, 2023 14:06

kittaakos requested review from per1234 and AlbyIanna February 6, 2023 12:49

per1234 requested changes Feb 8, 2023

View reviewed changes

kittaakos force-pushed the #1825 branch from 0e6c19f to 9a3b107 Compare February 8, 2023 08:35

kittaakos mentioned this pull request Feb 8, 2023

feat: icon for cloud sketch in File > Open Recent #1868

Draft

4 tasks

per1234 requested changes Feb 9, 2023

View reviewed changes

arduino-ide-extension/src/common/protocol/sketches-service.ts Outdated Show resolved Hide resolved

This was referenced Feb 10, 2023

Require cross-platform compatibility of sketch names in specification arduino/arduino-cli#2069

Closed

Sketch deleted when location inside sketch folder selected as rename target #1882

Closed

kittaakos force-pushed the #1825 branch from b9e9ae9 to bec6e92 Compare February 13, 2023 08:38

per1234 requested changes Feb 13, 2023

View reviewed changes

feat: rename, deletion, and validation support

adf3dcf

Closes #1599 Closes #1825 Closes #649 Closes #1847 Closes #1882 Co-authored-by: Akos Kitta <a.kitta@arduino.cc> Co-authored-by: per1234 <accounts@perglass.com> Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

kittaakos force-pushed the #1825 branch from 048f452 to adf3dcf Compare February 13, 2023 15:49

per1234 approved these changes Feb 13, 2023

View reviewed changes

kittaakos self-assigned this Feb 15, 2023

kittaakos merged commit d68bc4a into main Feb 15, 2023

kittaakos deleted the #1825 branch February 15, 2023 13:09

per1234 added the topic: cloud Related to Arduino Cloud and cloud sketches label Apr 13, 2023

kittaakos mentioned this pull request May 10, 2023

Disallow rename/delete for non workspace resources #274

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: rename, deletion, and validation support #1833

feat: rename, deletion, and validation support #1833

kittaakos commented Jan 25, 2023 •

edited

Loading

kittaakos commented Feb 1, 2023

kittaakos commented Feb 1, 2023 •

edited

Loading

kittaakos commented Feb 1, 2023 •

edited

Loading

kittaakos commented Feb 1, 2023 •

edited

Loading

per1234 Feb 8, 2023

kittaakos Feb 8, 2023

per1234 Feb 9, 2023

kittaakos Feb 13, 2023

per1234 left a comment •

edited

Loading

kittaakos commented Feb 9, 2023

per1234 left a comment

feat: rename, deletion, and validation support #1833

feat: rename, deletion, and validation support #1833

Conversation

kittaakos commented Jan 25, 2023 • edited Loading

Motivation

Change description

Other information

Reviewer checklist

kittaakos commented Feb 1, 2023

kittaakos commented Feb 1, 2023 • edited Loading

kittaakos commented Feb 1, 2023 • edited Loading

kittaakos commented Feb 1, 2023 • edited Loading

per1234 Feb 8, 2023

Choose a reason for hiding this comment

kittaakos Feb 8, 2023

Choose a reason for hiding this comment

per1234 Feb 9, 2023

Choose a reason for hiding this comment

kittaakos Feb 13, 2023

Choose a reason for hiding this comment

per1234 left a comment • edited Loading

Choose a reason for hiding this comment

To reproduce

Arduino IDE version

Operating system

Operating system version

kittaakos commented Feb 9, 2023

per1234 left a comment

Choose a reason for hiding this comment

kittaakos commented Jan 25, 2023 •

edited

Loading

kittaakos commented Feb 1, 2023 •

edited

Loading

kittaakos commented Feb 1, 2023 •

edited

Loading

kittaakos commented Feb 1, 2023 •

edited

Loading

per1234 left a comment •

edited

Loading