feat: dfx new templates #3499

adamspofford-dfinity · 2024-01-12T01:33:50Z

Also closes #2771.

src/dfx-core/src/config/model/dfinity.rs

ericswanson-dfinity · 2024-01-12T22:59:42Z

src/dfx/assets/project_templates/react/src/__project_name___frontend/public/.ic-assets.json5

+        // redirect all requests from .raw.icp0.io to .icp0.io (this redirection is the default)
+        "allow_raw_access": false


dfx 0.14.4 changed this default to true, and made it so we no longer specify the default for this field in these new-project .ic-assets.json5 files. Is it intended to change that behavior here?

The others came from @krpeacock's templates, and then the empty one I was just making consistent with those. If we changed it away from this default for a reason I won't gainsay it.

Yes. The new templates should use the new default (and not specify the default in .ic_assets.json5)

These changes to defaults are the only reason I still have changes requested on this PR

CHANGELOG.md

krpeacock · 2024-01-16T18:11:54Z

I think it's a problem that these templates won't run correctly with dfx up to the latest release version. I think we should add a "build" script to the root package.json that's compatible with dfx <0.15.3

Co-authored-by: Severin Siffert <[email protected]>

adamspofford-dfinity · 2024-01-16T18:21:26Z

Is it? I don't picture a user generating a project with a newer version of dfx, then switching to an older one.

krpeacock · 2024-01-17T20:04:03Z

Is it? I don't picture a user generating a project with a newer version of dfx, then switching to an older one.

Someone might share their code, generated from a new version, and then someone could have trouble running it if the version isn't pinned or indicated. Probably an edge case though.

Still, having access to "test", "start", and "build" scripts is probably a nice thing to have, so that people don't have to cd or use the --workspaces flag for everything. (feedback from testing all the frontends manually)

…spofford/new-templates

letmejustputthishere · 2024-01-29T10:25:11Z

i know this is still WIP, but when attempting to create a new project, my frontend wasn't generated with the following output.

❯ sdk/target/debug/dfx new new_template
✔ Select a backend language: · Motoko
✔ Select a frontend framework: · Svelte
✔ Add extra features (space to select, enter to confirm) · Internet Identity, Frontend tests
Fetching manifest https://sdk.dfinity.org/manifest.json
  Version v0.16.0+rev30.f7b611f1 installed successfully.
Creating new project "new_template"...
CREATE       new_template/dfx.json (179B)...
CREATE       new_template/.gitignore (260B)...
CREATE       new_template/README.md (2.47KiB)...
CREATE       new_template/tsconfig.json (280B)...
CREATE       new_template/package.json (477B)...
CREATE       new_template/src/new_template_backend/main.mo (105B)...
WARN: Node could not be found. Skipping installing the frontend example code.
WARN: You can bypass this check by using the --frontend flag.
CREATE       new_template/src/new_template_frontend/assets/sample-asset.txt (24B)...
CREATE       new_template/src/new_template_frontend/assets/.ic-assets.json5 (5.37KiB)...
Creating git repository...

i can confirm that node indeed wasn't available in this shell, but if node is needed to install dfx we should add a prerequisites section here.

letmejustputthishere · 2024-01-29T10:26:35Z

PS: i think this is amazing, it would be even cooler if templates with II would integrate with the frontend code as well.

letmejustputthishere · 2024-01-29T10:28:32Z

src/dfx/src/commands/new.rs

+
+#[derive(ValueEnum, Debug, Copy, Clone, PartialEq, Eq)]
+enum FrontendType {
+    Svelte,


to be more accurate, can we use sveltekit instead of svelte here?

@krpeacock do you have an opinion on this?

@adamspofford-dfinity In the absence of an opinion from anyone with a better handle on the ecosystem, I think we should change this to SvelteKit (and the cli option to --type sveltekit), since there is a distinction between the two.

letmejustputthishere · 2024-01-29T10:29:42Z

support for e2e tests using pocket-ic would be amazing as well 🤩

krpeacock

From my perspective, this is ready to go out (once all the checks pass)

krpeacock · 2024-02-02T17:05:30Z

it would be even cooler if templates with II would integrate with the frontend code as well.

I do plan to do this, but it'll be a follow-up

ericswanson-dfinity · 2024-02-08T20:01:16Z

src/dfx/src/commands/new.rs

+
+#[derive(ValueEnum, Debug, Copy, Clone, PartialEq, Eq)]
+enum FrontendType {
+    Svelte,


@adamspofford-dfinity In the absence of an opinion from anyone with a better handle on the ecosystem, I think we should change this to SvelteKit (and the cli option to --type sveltekit), since there is a distinction between the two.

ericswanson-dfinity · 2024-02-08T21:47:08Z

e2e/tests-dfx/new.bash

-  assert_command dfx new e2e_no_frontend --no-frontend
-  assert_file_exists e2e_no_frontend/src/e2e_no_frontend_frontend/assets/sample-asset.txt
+@test "frontend templates apply successfully" {
+  for frontend in sveltekit vue react vanilla simple-assets none; do


This may be what is breaking

Suggested change

for frontend in sveltekit vue react vanilla simple-assets none; do

for frontend in svelte-kit vue react vanilla simple-assets none; do

No, I renamed it in the same commit.

adamspofford-dfinity added 12 commits January 11, 2024 11:23

Base templates

9634fbc

frontend tests

5cd718e

Update rust template

a81f1e3

Tests

72f8e7d

docs

ca62ab1

Merge branch 'master' into spofford/new-templates

6af6ff8

csp

899d891

Fix tests

71d31c9

Merge branch 'master' into spofford/new-templates

a64d1f7

.

610a97e

.

92933e0

.

4276b2e

adamspofford-dfinity marked this pull request as ready for review January 12, 2024 22:10

adamspofford-dfinity requested review from chenyan-dfinity and a team as code owners January 12, 2024 22:10

More descriptive changelog

60a541e

adamspofford-dfinity force-pushed the spofford/new-templates branch from c885e83 to 60a541e Compare January 12, 2024 22:14

Merge branch 'master' into spofford/new-templates

0865f40

ericswanson-dfinity requested changes Jan 12, 2024

View reviewed changes

sesi200 reviewed Jan 15, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

adamspofford-dfinity and others added 2 commits January 16, 2024 10:16

Update CHANGELOG.md

d138440

Co-authored-by: Severin Siffert <[email protected]>

Update dfx.json schema

222fabb

Merge branch 'master' into spofford/new-templates

ee12310

This comment was marked as resolved.

Sign in to view

krpeacock added 3 commits January 18, 2024 10:18

fix: removes App.css holdover from a different example

42498a7

Merge branch 'spofford/new-templates' of github.com:dfinity/sdk into …

65a8fb9

…spofford/new-templates

backwards compatibility & top-level package.json scripts

817c52e

krpeacock added 3 commits January 19, 2024 10:57

fix: dummy actor during svelte tests

6fb96cd

test works immediately without dfx generate

3e4c655

Merge branch 'master' into spofford/new-templates

f7b611f

letmejustputthishere reviewed Jan 29, 2024

View reviewed changes

krpeacock self-requested a review February 1, 2024 21:40

krpeacock approved these changes Feb 1, 2024

View reviewed changes

fix ci

6d541c5

adamspofford-dfinity and others added 2 commits February 8, 2024 08:38

Remove raw redirect setting

aa2a7a0

Merge branch 'master' into spofford/new-templates

abd9f09

ericswanson-dfinity requested changes Feb 8, 2024

View reviewed changes

Rename Svelte to SvelteKit

dbf4941

ericswanson-dfinity approved these changes Feb 8, 2024

View reviewed changes

adamspofford-dfinity and others added 3 commits February 8, 2024 12:59

.

995493b

revert declarations import path change?

3caebcf

Merge branch 'master' into spofford/new-templates

8c178f7

ericswanson-dfinity reviewed Feb 8, 2024

View reviewed changes

adamspofford-dfinity added the automerge-squash label Feb 8, 2024

adamspofford-dfinity and others added 2 commits February 8, 2024 15:13

please work

510faa4

Merge branch 'master' into spofford/new-templates

1021406

mergify bot merged commit bd13729 into master Feb 9, 2024
171 checks passed

mergify bot deleted the spofford/new-templates branch February 9, 2024 00:16

mergify bot removed the automerge-squash label Feb 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: dfx new templates #3499

feat: dfx new templates #3499

adamspofford-dfinity commented Jan 12, 2024

ericswanson-dfinity Jan 12, 2024

adamspofford-dfinity Jan 16, 2024 •

edited

Loading

ericswanson-dfinity Jan 17, 2024

ericswanson-dfinity Feb 7, 2024

krpeacock commented Jan 16, 2024

adamspofford-dfinity commented Jan 16, 2024

krpeacock commented Jan 17, 2024

This comment was marked as resolved.

letmejustputthishere commented Jan 29, 2024

letmejustputthishere commented Jan 29, 2024

letmejustputthishere Jan 29, 2024

ericswanson-dfinity Feb 7, 2024

ericswanson-dfinity Feb 8, 2024 •

edited

Loading

letmejustputthishere commented Jan 29, 2024

krpeacock left a comment •

edited

Loading

krpeacock commented Feb 2, 2024 •

edited

Loading

ericswanson-dfinity Feb 8, 2024 •

edited

Loading

ericswanson-dfinity Feb 8, 2024 •

edited

Loading

adamspofford-dfinity Feb 8, 2024

		// redirect all requests from .raw.icp0.io to .icp0.io (this redirection is the default)
		"allow_raw_access": false

	for frontend in sveltekit vue react vanilla simple-assets none; do
	for frontend in svelte-kit vue react vanilla simple-assets none; do

feat: dfx new templates #3499

feat: dfx new templates #3499

Conversation

adamspofford-dfinity commented Jan 12, 2024

ericswanson-dfinity Jan 12, 2024

Choose a reason for hiding this comment

adamspofford-dfinity Jan 16, 2024 • edited Loading

Choose a reason for hiding this comment

ericswanson-dfinity Jan 17, 2024

Choose a reason for hiding this comment

ericswanson-dfinity Feb 7, 2024

Choose a reason for hiding this comment

krpeacock commented Jan 16, 2024

adamspofford-dfinity commented Jan 16, 2024

krpeacock commented Jan 17, 2024

This comment was marked as resolved.

letmejustputthishere commented Jan 29, 2024

letmejustputthishere commented Jan 29, 2024

letmejustputthishere Jan 29, 2024

Choose a reason for hiding this comment

ericswanson-dfinity Feb 7, 2024

Choose a reason for hiding this comment

ericswanson-dfinity Feb 8, 2024 • edited Loading

Choose a reason for hiding this comment

letmejustputthishere commented Jan 29, 2024

krpeacock left a comment • edited Loading

Choose a reason for hiding this comment

krpeacock commented Feb 2, 2024 • edited Loading

ericswanson-dfinity Feb 8, 2024 • edited Loading

Choose a reason for hiding this comment

ericswanson-dfinity Feb 8, 2024 • edited Loading

Choose a reason for hiding this comment

adamspofford-dfinity Feb 8, 2024

Choose a reason for hiding this comment

adamspofford-dfinity Jan 16, 2024 •

edited

Loading

ericswanson-dfinity Feb 8, 2024 •

edited

Loading

krpeacock left a comment •

edited

Loading

krpeacock commented Feb 2, 2024 •

edited

Loading

ericswanson-dfinity Feb 8, 2024 •

edited

Loading

ericswanson-dfinity Feb 8, 2024 •

edited

Loading