The PR has no duplicates (please search among thePull Requests
before creating one)
The PR follows
our contributing guidelines
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)
UPGRADING.md has been updated with a migration guide (for breaking changes)
configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

Implements feature request in#2239, although instead of implementing a single "blueprint" file, allows for an entire template directory.

What is the current behavior?

Runningarduino-cli sketch new MySketch will create aMySketch/MySketch.ino file.

What is the new behavior?

Ifdirectories.template is not set, the behavior is the same as before.

If it is set, runningarduino-cli sketch new MySketch will copy thedirectories.template directory to create theMySketch directory.

Does this PR introduce a breaking change, and istitled accordingly?

This isn't a breaking change.

Other Information

Tests/docs haven't been written. Putting this up as a draft to get initial feedback before putting in more effort. One question how to handle settingsketchMainFilePath. Should we rename some file in the template directory toMySketch.ino? Or just pick a .ino from the directory (ideally there's only one) and return that from the RPC call?

per1234 added type: enhancement

Proposed improvement

topic: codeRelated to content of the project itself labels

Oct 8, 2023

cmaglie reviewed

Oct 17, 2023

View reviewed changes

Copy link

Member

cmaglie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

One question how to handle setting sketchMainFilePath. Should we rename some file in the template directory to MySketch.ino? Or just pick a .ino from the directory (ideally there's only one) and return that from the RPC call?

mmmhh... It's a bit more convoluted than expected, we should consider these factors:

A sketch may be composed of many files
Themain sketch file is the .ino file that is named exactly as the containing folder
We should copy the entire "template" sketch folder into the new user-requested sketch folder
In the new folder we must rename the template-main-sketch file to match the new folder name.

So let's recap with an example:

Suppose we configure the sketch template to point to/path/to/sketch/template, that has the following content:

/path/to/sketch/template/another_file.ino/path/to/sketch/template/template.ino      <--- MAIN FILE/path/to/sketch/template/passwords.h

if we runarduino-cli sketch new mysketchbook/newsketch, the expected result is:

./mysketchbook/newsketch/another_file.ino./mysketchbook/newsketch/newsketch.ino      <--- MAIN FILE./mysketchbook/newsketch/passwords.h

The most notable part here is thattemplate.ino has been renamednewsketch.ino because it's the main file.

commands/sketch/new.go OutdatedShow resolvedHide resolved

gsingh93 commented

Oct 19, 2023

View reviewed changes

configuration/defaults.goShow resolvedHide resolved

gsingh93 added4 commits

October 19, 2023 11:06

Add directories.template config option

79f2e13

Create sketch from template if template directory is set

78a742a

Change directories.template to sketch.template

ff796f3

Rename main template ino file

de7c948

gsingh93 force-pushed thetemplate branch from1cd159d tode7c948Compare

October 19, 2023 11:07

Copy link

Author

gsingh93 commentedOct 19, 2023

@cmaglie thanks for the feedback! I've addressed your comments and rebased. If the template directory is/path/to/template, it's now required that/path/to/template.ino exists, and it will be renamed to the actual main sketch file.

If this general approach looks correct to you, I'll start working on the tests/docs when I get some time.

Copy link

Member

cmaglie commentedOct 23, 2023

Looks good, thanks, go on!

umbynos linked an issue

Nov 14, 2023

that may beclosed by this pull request

Allow customizing the new sketch template#2239

Open

3 tasks

Copy link

Contributor

umbynos commentedJan 23, 2024

Hello@gsingh93 did you had time to continue? 😄

umbynos added the status: waiting for informationMore information must be provided before work can proceed label

Jan 23, 2024

Copy link

Author

gsingh93 commentedJan 27, 2024

Sorry, I haven't had time to work on this in a while. Someone else can pick it up from here, or it could be closed for now and I'll reopen if I ever come back to it. Either way is fine.