From 8ca8b47a054674de59075404a141dd56786a5827 Mon Sep 17 00:00:00 2001 From: Adam Spofford Date: Tue, 3 Sep 2024 09:30:18 -0700 Subject: [PATCH] Change placeholder format to use underscores --- src/dfx/assets/project_templates/any_js/package.json | 2 +- src/dfx/assets/project_templates/azle/dfx.json-patch | 10 +++++----- .../assets/project_templates/azle/package.json-patch | 2 +- .../azle/src/__backend_name__/package.json | 2 +- src/dfx/assets/project_templates/base/README.md | 8 ++++---- src/dfx/assets/project_templates/kybra/dfx.json-patch | 10 +++++----- src/dfx/assets/project_templates/motoko/dfx.json-patch | 4 ++-- src/dfx/assets/project_templates/react/dfx.json-patch | 8 ++++---- .../assets/project_templates/react/package.json-patch | 2 +- .../react/src/__frontend_name__/package.json | 4 ++-- .../react/src/__frontend_name__/src/App.jsx | 4 ++-- .../src/__frontend_name__/vite.config.js.patch | 4 ++-- src/dfx/assets/project_templates/rust/Cargo.toml | 2 +- src/dfx/assets/project_templates/rust/dfx.json-patch | 6 +++--- .../rust/src/__backend_name__/Cargo.toml | 2 +- .../project_templates/simple_assets/dfx.json-patch | 6 +++--- src/dfx/assets/project_templates/svelte/dfx.json-patch | 10 +++++----- .../assets/project_templates/svelte/package.json-patch | 2 +- .../svelte/src/__frontend_name__/package.json | 4 ++-- .../svelte/src/__frontend_name__/src/lib/canisters.js | 2 +- .../src/__frontend_name__/vite.config.js.patch | 4 ++-- .../assets/project_templates/vanilla_js/dfx.json-patch | 8 ++++---- .../project_templates/vanilla_js/package.json-patch | 2 +- .../vanilla_js/src/__frontend_name__/package.json | 4 ++-- .../vanilla_js/src/__frontend_name__/src/App.js | 4 ++-- .../src/__frontend_name__/vite.config.js.patch | 4 ++-- src/dfx/assets/project_templates/vue/dfx.json-patch | 8 ++++---- .../assets/project_templates/vue/package.json-patch | 2 +- .../vue/src/__frontend_name__/package.json | 4 ++-- .../vue/src/__frontend_name__/src/App.vue | 4 ++-- .../src/__frontend_name__/vite.config.js.patch | 4 ++-- src/dfx/src/commands/new.rs | 6 ++---- 32 files changed, 73 insertions(+), 75 deletions(-) diff --git a/src/dfx/assets/project_templates/any_js/package.json b/src/dfx/assets/project_templates/any_js/package.json index ec3206c127..0581b309e2 100644 --- a/src/dfx/assets/project_templates/any_js/package.json +++ b/src/dfx/assets/project_templates/any_js/package.json @@ -1,5 +1,5 @@ { - "name": "{project_name}", + "name": "__project_name__", "type": "module", "scripts": { "start": "npm start --workspaces --if-present", diff --git a/src/dfx/assets/project_templates/azle/dfx.json-patch b/src/dfx/assets/project_templates/azle/dfx.json-patch index 942569e630..5965afc59f 100644 --- a/src/dfx/assets/project_templates/azle/dfx.json-patch +++ b/src/dfx/assets/project_templates/azle/dfx.json-patch @@ -1,13 +1,13 @@ [ { - "path": "/canisters/{backend_name}", + "path": "/canisters/__backend_name__", "op": "add", "value": { "type": "custom", - "main": "src/{backend_name}/src/index.ts", - "candid": "src/{backend_name}/{backend_name}.did", - "build": "npx azle {backend_name}", - "wasm": ".azle/{backend_name}/{backend_name}.wasm", + "main": "src/__backend_name__/src/index.ts", + "candid": "src/__backend_name__/__backend_name__.did", + "build": "npx azle __backend_name__", + "wasm": ".azle/__backend_name__/__backend_name__.wasm", "gzip": true, "tech_stack": { "language": { diff --git a/src/dfx/assets/project_templates/azle/package.json-patch b/src/dfx/assets/project_templates/azle/package.json-patch index 45bcb8b0a1..75f389f805 100644 --- a/src/dfx/assets/project_templates/azle/package.json-patch +++ b/src/dfx/assets/project_templates/azle/package.json-patch @@ -2,6 +2,6 @@ { "op": "add", "path": "/workspaces/-", - "value": "src/{backend_name}" + "value": "src/__backend_name__" } ] \ No newline at end of file diff --git a/src/dfx/assets/project_templates/azle/src/__backend_name__/package.json b/src/dfx/assets/project_templates/azle/src/__backend_name__/package.json index db75ae80c2..63bbb83d7f 100644 --- a/src/dfx/assets/project_templates/azle/src/__backend_name__/package.json +++ b/src/dfx/assets/project_templates/azle/src/__backend_name__/package.json @@ -1,5 +1,5 @@ { - "name": "{backend_name}", + "name": "__backend_name__", "version": "0.0.0", "private": true, "type": "module", diff --git a/src/dfx/assets/project_templates/base/README.md b/src/dfx/assets/project_templates/base/README.md index 25d1ec65ca..b9d408867f 100644 --- a/src/dfx/assets/project_templates/base/README.md +++ b/src/dfx/assets/project_templates/base/README.md @@ -1,10 +1,10 @@ -# `{project_name}` +# `__project_name__` -Welcome to your new `{project_name}` project and to the Internet Computer development community. By default, creating a new project adds this README and some template files to your project directory. You can edit these template files to customize your project and to include your own code to speed up the development cycle. +Welcome to your new `__project_name__` project and to the Internet Computer development community. By default, creating a new project adds this README and some template files to your project directory. You can edit these template files to customize your project and to include your own code to speed up the development cycle. To get started, you might want to explore the project directory structure and the default configuration file. Working with this project in your development environment will not affect any production deployment or identity tokens. -To learn more before you start working with `{project_name}`, see the following documentation available online: +To learn more before you start working with `__project_name__`, see the following documentation available online: - [Quick Start](https://internetcomputer.org/docs/current/developer-docs/setup/deploy-locally) - [SDK Developer Tools](https://internetcomputer.org/docs/current/developer-docs/setup/install) @@ -12,7 +12,7 @@ To learn more before you start working with `{project_name}`, see the following If you want to start working on your project right away, you might want to try the following commands: ```bash -cd {project_name}/ +cd __project_name__/ dfx help dfx canister --help ``` diff --git a/src/dfx/assets/project_templates/kybra/dfx.json-patch b/src/dfx/assets/project_templates/kybra/dfx.json-patch index a1ee33218f..01aa134084 100644 --- a/src/dfx/assets/project_templates/kybra/dfx.json-patch +++ b/src/dfx/assets/project_templates/kybra/dfx.json-patch @@ -1,13 +1,13 @@ [ { - "path": "/canisters/{backend_name}", + "path": "/canisters/__backend_name__", "op": "add", "value": { "type": "custom", - "build": "python -m kybra {backend_name} src/{backend_name}/src/main.py src/{backend_name}/{backend_name}.did", - "post_install": ".kybra/{backend_name}/post_install.sh", - "candid": "src/{backend_name}/{backend_name}.did", - "wasm": ".kybra/{backend_name}/{backend_name}.wasm", + "build": "python -m kybra __backend_name__ src/__backend_name__/src/main.py src/__backend_name__/__backend_name__.did", + "post_install": ".kybra/__backend_name__/post_install.sh", + "candid": "src/__backend_name__/__backend_name__.did", + "wasm": ".kybra/__backend_name__/__backend_name__.wasm", "gzip": true, "tech_stack": { "language": { diff --git a/src/dfx/assets/project_templates/motoko/dfx.json-patch b/src/dfx/assets/project_templates/motoko/dfx.json-patch index 6633e3224e..504e6e7332 100644 --- a/src/dfx/assets/project_templates/motoko/dfx.json-patch +++ b/src/dfx/assets/project_templates/motoko/dfx.json-patch @@ -1,10 +1,10 @@ [ { "op": "add", - "path": "/canisters/{backend_name}", + "path": "/canisters/__backend_name__", "value": { "type": "motoko", - "main": "src/{backend_name}/main.mo" + "main": "src/__backend_name__/main.mo" } } ] diff --git a/src/dfx/assets/project_templates/react/dfx.json-patch b/src/dfx/assets/project_templates/react/dfx.json-patch index ddc2485946..2e0c21e183 100644 --- a/src/dfx/assets/project_templates/react/dfx.json-patch +++ b/src/dfx/assets/project_templates/react/dfx.json-patch @@ -1,16 +1,16 @@ [ { "op": "add", - "path": "/canisters/{frontend_name}", + "path": "/canisters/__frontend_name__", "value": { "type": "assets", "source": [ - "src/{frontend_name}/dist" + "src/__frontend_name__/dist" ], "dependencies": [ - "{backend_name}" + "__backend_name__" ], - "workspace": "{frontend_name}" + "workspace": "__frontend_name__" } } ] diff --git a/src/dfx/assets/project_templates/react/package.json-patch b/src/dfx/assets/project_templates/react/package.json-patch index f81ecf2e6f..de288bbd0a 100644 --- a/src/dfx/assets/project_templates/react/package.json-patch +++ b/src/dfx/assets/project_templates/react/package.json-patch @@ -2,6 +2,6 @@ { "op": "add", "path": "/workspaces/-", - "value": "src/{frontend_name}" + "value": "src/__frontend_name__" } ] diff --git a/src/dfx/assets/project_templates/react/src/__frontend_name__/package.json b/src/dfx/assets/project_templates/react/src/__frontend_name__/package.json index 3526f1aedc..04d9cd02c5 100644 --- a/src/dfx/assets/project_templates/react/src/__frontend_name__/package.json +++ b/src/dfx/assets/project_templates/react/src/__frontend_name__/package.json @@ -1,10 +1,10 @@ { - "name": "{frontend_name}", + "name": "__frontend_name__", "private": true, "version": "0.0.0", "type": "module", "scripts": { - "setup": "npm i && dfx canister create {backend_name} && dfx generate {backend_name} && dfx deploy", + "setup": "npm i && dfx canister create __backend_name__ && dfx generate __backend_name__ && dfx deploy", "start": "vite --port 3000", "prebuild": "dfx generate", "build": "tsc && vite build", diff --git a/src/dfx/assets/project_templates/react/src/__frontend_name__/src/App.jsx b/src/dfx/assets/project_templates/react/src/__frontend_name__/src/App.jsx index 479de11aab..844e6b7e1a 100644 --- a/src/dfx/assets/project_templates/react/src/__frontend_name__/src/App.jsx +++ b/src/dfx/assets/project_templates/react/src/__frontend_name__/src/App.jsx @@ -1,5 +1,5 @@ import { useState } from 'react'; -import { {backend_name_ident} } from 'declarations/{backend_name}'; +import { __backend_name_ident__ } from 'declarations/__backend_name__'; function App() { const [greeting, setGreeting] = useState(''); @@ -7,7 +7,7 @@ function App() { function handleSubmit(event) { event.preventDefault(); const name = event.target.elements.name.value; - {backend_name_ident}.greet(name).then((greeting) => { + __backend_name_ident__.greet(name).then((greeting) => { setGreeting(greeting); }); return false; diff --git a/src/dfx/assets/project_templates/react_tests/src/__frontend_name__/vite.config.js.patch b/src/dfx/assets/project_templates/react_tests/src/__frontend_name__/vite.config.js.patch index 17892e18b0..d8d55951d1 100644 --- a/src/dfx/assets/project_templates/react_tests/src/__frontend_name__/vite.config.js.patch +++ b/src/dfx/assets/project_templates/react_tests/src/__frontend_name__/vite.config.js.patch @@ -1,5 +1,5 @@ ---- a/src/{frontend_name}/vite.config.js -+++ b/src/{frontend_name}/vite.config.js +--- a/src/__frontend_name__/vite.config.js ++++ b/src/__frontend_name__/vite.config.js @@ -1,1 +1,2 @@ +/// import { fileURLToPath, URL } from 'url'; diff --git a/src/dfx/assets/project_templates/rust/Cargo.toml b/src/dfx/assets/project_templates/rust/Cargo.toml index 32ee3888f9..3a59c96461 100644 --- a/src/dfx/assets/project_templates/rust/Cargo.toml +++ b/src/dfx/assets/project_templates/rust/Cargo.toml @@ -1,5 +1,5 @@ [workspace] members = [ - "src/{backend_name}" + "src/__backend_name__" ] resolver = "2" diff --git a/src/dfx/assets/project_templates/rust/dfx.json-patch b/src/dfx/assets/project_templates/rust/dfx.json-patch index 9319ef0366..9291c38146 100644 --- a/src/dfx/assets/project_templates/rust/dfx.json-patch +++ b/src/dfx/assets/project_templates/rust/dfx.json-patch @@ -1,11 +1,11 @@ [ { "op": "add", - "path": "/canisters/{backend_name}", + "path": "/canisters/__backend_name__", "value": { "type": "rust", - "package": "{backend_name}", - "candid": "src/{backend_name}/{backend_name}.did" + "package": "__backend_name__", + "candid": "src/__backend_name__/__backend_name__.did" } } ] diff --git a/src/dfx/assets/project_templates/rust/src/__backend_name__/Cargo.toml b/src/dfx/assets/project_templates/rust/src/__backend_name__/Cargo.toml index 4109ec3436..413f5fa468 100644 --- a/src/dfx/assets/project_templates/rust/src/__backend_name__/Cargo.toml +++ b/src/dfx/assets/project_templates/rust/src/__backend_name__/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "{backend_name}" +name = "__backend_name__" version = "0.1.0" edition = "2021" diff --git a/src/dfx/assets/project_templates/simple_assets/dfx.json-patch b/src/dfx/assets/project_templates/simple_assets/dfx.json-patch index 14332c8894..3b757e0413 100644 --- a/src/dfx/assets/project_templates/simple_assets/dfx.json-patch +++ b/src/dfx/assets/project_templates/simple_assets/dfx.json-patch @@ -1,14 +1,14 @@ [ { "op": "add", - "path": "/canisters/{frontend_name}", + "path": "/canisters/__frontend_name__", "value": { "type": "assets", "source": [ - "src/{frontend_name}/assets" + "src/__frontend_name__/assets" ], "dependencies": [ - "{backend_name}" + "__backend_name__" ] } } diff --git a/src/dfx/assets/project_templates/svelte/dfx.json-patch b/src/dfx/assets/project_templates/svelte/dfx.json-patch index dfb157fcb6..bf11fafc3b 100644 --- a/src/dfx/assets/project_templates/svelte/dfx.json-patch +++ b/src/dfx/assets/project_templates/svelte/dfx.json-patch @@ -1,21 +1,21 @@ [ { "op": "add", - "path": "/canisters/{frontend_name}", + "path": "/canisters/__frontend_name__", "value": { "type": "assets", "source": [ - "src/{frontend_name}/dist" + "src/__frontend_name__/dist" ], "dependencies": [ - "{backend_name}" + "__backend_name__" ], - "workspace": "{frontend_name}" + "workspace": "__frontend_name__" } }, { "op": "add", - "path": "/canisters/{backend_name}/declarations", + "path": "/canisters/__backend_name__/declarations", "value": { "node_compatibility": true } diff --git a/src/dfx/assets/project_templates/svelte/package.json-patch b/src/dfx/assets/project_templates/svelte/package.json-patch index f81ecf2e6f..de288bbd0a 100644 --- a/src/dfx/assets/project_templates/svelte/package.json-patch +++ b/src/dfx/assets/project_templates/svelte/package.json-patch @@ -2,6 +2,6 @@ { "op": "add", "path": "/workspaces/-", - "value": "src/{frontend_name}" + "value": "src/__frontend_name__" } ] diff --git a/src/dfx/assets/project_templates/svelte/src/__frontend_name__/package.json b/src/dfx/assets/project_templates/svelte/src/__frontend_name__/package.json index 985dc5b324..7f3ba5b4d3 100644 --- a/src/dfx/assets/project_templates/svelte/src/__frontend_name__/package.json +++ b/src/dfx/assets/project_templates/svelte/src/__frontend_name__/package.json @@ -1,10 +1,10 @@ { - "name": "{frontend_name}", + "name": "__frontend_name__", "private": true, "version": "0.0.0", "type": "module", "scripts": { - "setup": "npm i && dfx canister create {backend_name} && dfx generate {backend_name} && dfx deploy", + "setup": "npm i && dfx canister create __backend_name__ && dfx generate __backend_name__ && dfx deploy", "start": "vite --port 3000", "prebuild": "dfx generate", "build": "tsc && vite build", diff --git a/src/dfx/assets/project_templates/svelte/src/__frontend_name__/src/lib/canisters.js b/src/dfx/assets/project_templates/svelte/src/__frontend_name__/src/lib/canisters.js index ffba8687e3..8763701a2b 100644 --- a/src/dfx/assets/project_templates/svelte/src/__frontend_name__/src/lib/canisters.js +++ b/src/dfx/assets/project_templates/svelte/src/__frontend_name__/src/lib/canisters.js @@ -1,4 +1,4 @@ -import { createActor, canisterId } from 'declarations/{backend_name}'; +import { createActor, canisterId } from 'declarations/__backend_name__'; import { building } from '$app/environment'; function dummyActor() { diff --git a/src/dfx/assets/project_templates/svelte_tests/src/__frontend_name__/vite.config.js.patch b/src/dfx/assets/project_templates/svelte_tests/src/__frontend_name__/vite.config.js.patch index 17892e18b0..d8d55951d1 100644 --- a/src/dfx/assets/project_templates/svelte_tests/src/__frontend_name__/vite.config.js.patch +++ b/src/dfx/assets/project_templates/svelte_tests/src/__frontend_name__/vite.config.js.patch @@ -1,5 +1,5 @@ ---- a/src/{frontend_name}/vite.config.js -+++ b/src/{frontend_name}/vite.config.js +--- a/src/__frontend_name__/vite.config.js ++++ b/src/__frontend_name__/vite.config.js @@ -1,1 +1,2 @@ +/// import { fileURLToPath, URL } from 'url'; diff --git a/src/dfx/assets/project_templates/vanilla_js/dfx.json-patch b/src/dfx/assets/project_templates/vanilla_js/dfx.json-patch index ddc2485946..2e0c21e183 100644 --- a/src/dfx/assets/project_templates/vanilla_js/dfx.json-patch +++ b/src/dfx/assets/project_templates/vanilla_js/dfx.json-patch @@ -1,16 +1,16 @@ [ { "op": "add", - "path": "/canisters/{frontend_name}", + "path": "/canisters/__frontend_name__", "value": { "type": "assets", "source": [ - "src/{frontend_name}/dist" + "src/__frontend_name__/dist" ], "dependencies": [ - "{backend_name}" + "__backend_name__" ], - "workspace": "{frontend_name}" + "workspace": "__frontend_name__" } } ] diff --git a/src/dfx/assets/project_templates/vanilla_js/package.json-patch b/src/dfx/assets/project_templates/vanilla_js/package.json-patch index f81ecf2e6f..de288bbd0a 100644 --- a/src/dfx/assets/project_templates/vanilla_js/package.json-patch +++ b/src/dfx/assets/project_templates/vanilla_js/package.json-patch @@ -2,6 +2,6 @@ { "op": "add", "path": "/workspaces/-", - "value": "src/{frontend_name}" + "value": "src/__frontend_name__" } ] diff --git a/src/dfx/assets/project_templates/vanilla_js/src/__frontend_name__/package.json b/src/dfx/assets/project_templates/vanilla_js/src/__frontend_name__/package.json index cbe8931f2a..35395f23d3 100644 --- a/src/dfx/assets/project_templates/vanilla_js/src/__frontend_name__/package.json +++ b/src/dfx/assets/project_templates/vanilla_js/src/__frontend_name__/package.json @@ -1,10 +1,10 @@ { - "name": "{frontend_name}", + "name": "__frontend_name__", "private": true, "version": "0.0.0", "type": "module", "scripts": { - "setup": "npm i && dfx canister create {backend_name} && dfx generate {backend_name} && dfx deploy", + "setup": "npm i && dfx canister create __backend_name__ && dfx generate __backend_name__ && dfx deploy", "start": "vite --port 3000", "prebuild": "dfx generate", "build": "tsc && vite build", diff --git a/src/dfx/assets/project_templates/vanilla_js/src/__frontend_name__/src/App.js b/src/dfx/assets/project_templates/vanilla_js/src/__frontend_name__/src/App.js index 6d0d075a45..4839411ce4 100644 --- a/src/dfx/assets/project_templates/vanilla_js/src/__frontend_name__/src/App.js +++ b/src/dfx/assets/project_templates/vanilla_js/src/__frontend_name__/src/App.js @@ -1,5 +1,5 @@ import { html, render } from 'lit-html'; -import { {backend_name_ident} } from 'declarations/{backend_name}'; +import { __backend_name_ident__ } from 'declarations/__backend_name__'; import logo from './logo2.svg'; class App { @@ -12,7 +12,7 @@ class App { #handleSubmit = async (e) => { e.preventDefault(); const name = document.getElementById('name').value; - this.greeting = await {backend_name_ident}.greet(name); + this.greeting = await __backend_name_ident__.greet(name); this.#render(); }; diff --git a/src/dfx/assets/project_templates/vanilla_js_tests/src/__frontend_name__/vite.config.js.patch b/src/dfx/assets/project_templates/vanilla_js_tests/src/__frontend_name__/vite.config.js.patch index 2e56df4cf8..60a9e7fd86 100644 --- a/src/dfx/assets/project_templates/vanilla_js_tests/src/__frontend_name__/vite.config.js.patch +++ b/src/dfx/assets/project_templates/vanilla_js_tests/src/__frontend_name__/vite.config.js.patch @@ -1,5 +1,5 @@ ---- a/src/{frontend_name}/vite.config.js -+++ b/src/{frontend_name}/vite.config.js +--- a/src/__frontend_name__/vite.config.js ++++ b/src/__frontend_name__/vite.config.js @@ -1,1 +1,2 @@ +/// import { defineConfig } from 'vite'; diff --git a/src/dfx/assets/project_templates/vue/dfx.json-patch b/src/dfx/assets/project_templates/vue/dfx.json-patch index ebb5395e65..8a63b1ef93 100644 --- a/src/dfx/assets/project_templates/vue/dfx.json-patch +++ b/src/dfx/assets/project_templates/vue/dfx.json-patch @@ -1,16 +1,16 @@ [ { "op": "add", - "path": "/canisters/{frontend_name}", + "path": "/canisters/__frontend_name__", "value": { "type": "assets", "dependencies": [ - "{backend_name}" + "__backend_name__" ], "source": [ - "src/{frontend_name}/dist" + "src/__frontend_name__/dist" ], - "workspace": "{frontend_name}" + "workspace": "__frontend_name__" } } ] diff --git a/src/dfx/assets/project_templates/vue/package.json-patch b/src/dfx/assets/project_templates/vue/package.json-patch index f81ecf2e6f..de288bbd0a 100644 --- a/src/dfx/assets/project_templates/vue/package.json-patch +++ b/src/dfx/assets/project_templates/vue/package.json-patch @@ -2,6 +2,6 @@ { "op": "add", "path": "/workspaces/-", - "value": "src/{frontend_name}" + "value": "src/__frontend_name__" } ] diff --git a/src/dfx/assets/project_templates/vue/src/__frontend_name__/package.json b/src/dfx/assets/project_templates/vue/src/__frontend_name__/package.json index 83be2f7a5c..daa41481a1 100644 --- a/src/dfx/assets/project_templates/vue/src/__frontend_name__/package.json +++ b/src/dfx/assets/project_templates/vue/src/__frontend_name__/package.json @@ -1,10 +1,10 @@ { - "name": "{frontend_name}", + "name": "__frontend_name__", "private": true, "version": "0.0.0", "type": "module", "scripts": { - "setup": "npm i && dfx canister create {backend_name} && dfx generate {backend_name} && dfx deploy", + "setup": "npm i && dfx canister create __backend_name__ && dfx generate __backend_name__ && dfx deploy", "start": "vite --port 3000", "prebuild": "dfx generate", "build": "tsc && vite build", diff --git a/src/dfx/assets/project_templates/vue/src/__frontend_name__/src/App.vue b/src/dfx/assets/project_templates/vue/src/__frontend_name__/src/App.vue index be88d73752..8f9f08a883 100644 --- a/src/dfx/assets/project_templates/vue/src/__frontend_name__/src/App.vue +++ b/src/dfx/assets/project_templates/vue/src/__frontend_name__/src/App.vue @@ -1,13 +1,13 @@