Skip to content

Commit 2f05593

Browse files
adamspofford-dfinityrikonor
adamspofford-dfinity
authored and
rikonor
committed
feat: Change placeholder format to use underscores (#3900)
1 parent 3273096 commit 2f05593

File tree

32 files changed

+73
-75
lines changed

32 files changed

+73
-75
lines changed

‎src/dfx/assets/project_templates/any_js/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "{project_name}",
2+
"name": "__project_name__",
33
"type": "module",
44
"scripts": {
55
"start": "npm start --workspaces --if-present",

‎src/dfx/assets/project_templates/azle/dfx.json-patch

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
[
22
{
3-
"path": "/canisters/{backend_name}",
3+
"path": "/canisters/__backend_name__",
44
"op": "add",
55
"value": {
66
"type": "custom",
7-
"main": "src/{backend_name}/src/index.ts",
8-
"candid": "src/{backend_name}/{backend_name}.did",
9-
"build": "npx azle {backend_name}",
10-
"wasm": ".azle/{backend_name}/{backend_name}.wasm",
7+
"main": "src/__backend_name__/src/index.ts",
8+
"candid": "src/__backend_name__/__backend_name__.did",
9+
"build": "npx azle __backend_name__",
10+
"wasm": ".azle/__backend_name__/__backend_name__.wasm",
1111
"gzip": true,
1212
"tech_stack": {
1313
"language": {

‎src/dfx/assets/project_templates/azle/package.json-patch

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
{
33
"op": "add",
44
"path": "/workspaces/-",
5-
"value": "src/{backend_name}"
5+
"value": "src/__backend_name__"
66
}
77
]

‎src/dfx/assets/project_templates/azle/src/__backend_name__/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "{backend_name}",
2+
"name": "__backend_name__",
33
"version": "0.0.0",
44
"private": true,
55
"type": "module",

‎src/dfx/assets/project_templates/base/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# `{project_name}`
1+
# `__project_name__`
22

3-
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.
3+
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.
44

55
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.
66

7-
To learn more before you start working with `{project_name}`, see the following documentation available online:
7+
To learn more before you start working with `__project_name__`, see the following documentation available online:
88

99
- [Quick Start](https://internetcomputer.org/docs/current/developer-docs/setup/deploy-locally)
1010
- [SDK Developer Tools](https://internetcomputer.org/docs/current/developer-docs/setup/install)
1111

1212
If you want to start working on your project right away, you might want to try the following commands:
1313

1414
```bash
15-
cd {project_name}/
15+
cd __project_name__/
1616
dfx help
1717
dfx canister --help
1818
```

‎src/dfx/assets/project_templates/kybra/dfx.json-patch

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
[
22
{
3-
"path": "/canisters/{backend_name}",
3+
"path": "/canisters/__backend_name__",
44
"op": "add",
55
"value": {
66
"type": "custom",
7-
"build": "python -m kybra {backend_name} src/{backend_name}/src/main.py src/{backend_name}/{backend_name}.did",
8-
"post_install": ".kybra/{backend_name}/post_install.sh",
9-
"candid": "src/{backend_name}/{backend_name}.did",
10-
"wasm": ".kybra/{backend_name}/{backend_name}.wasm",
7+
"build": "python -m kybra __backend_name__ src/__backend_name__/src/main.py src/__backend_name__/__backend_name__.did",
8+
"post_install": ".kybra/__backend_name__/post_install.sh",
9+
"candid": "src/__backend_name__/__backend_name__.did",
10+
"wasm": ".kybra/__backend_name__/__backend_name__.wasm",
1111
"gzip": true,
1212
"tech_stack": {
1313
"language": {

‎src/dfx/assets/project_templates/motoko/dfx.json-patch

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[
22
{
33
"op": "add",
4-
"path": "/canisters/{backend_name}",
4+
"path": "/canisters/__backend_name__",
55
"value": {
66
"type": "motoko",
7-
"main": "src/{backend_name}/main.mo"
7+
"main": "src/__backend_name__/main.mo"
88
}
99
}
1010
]

‎src/dfx/assets/project_templates/react/dfx.json-patch

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
[
22
{
33
"op": "add",
4-
"path": "/canisters/{frontend_name}",
4+
"path": "/canisters/__frontend_name__",
55
"value": {
66
"type": "assets",
77
"source": [
8-
"src/{frontend_name}/dist"
8+
"src/__frontend_name__/dist"
99
],
1010
"dependencies": [
11-
"{backend_name}"
11+
"__backend_name__"
1212
],
13-
"workspace": "{frontend_name}"
13+
"workspace": "__frontend_name__"
1414
}
1515
}
1616
]

‎src/dfx/assets/project_templates/react/package.json-patch

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
{
33
"op": "add",
44
"path": "/workspaces/-",
5-
"value": "src/{frontend_name}"
5+
"value": "src/__frontend_name__"
66
}
77
]

‎src/dfx/assets/project_templates/react/src/__frontend_name__/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
2-
"name": "{frontend_name}",
2+
"name": "__frontend_name__",
33
"private": true,
44
"version": "0.0.0",
55
"type": "module",
66
"scripts": {
7-
"setup": "npm i && dfx canister create {backend_name} && dfx generate {backend_name} && dfx deploy",
7+
"setup": "npm i && dfx canister create __backend_name__ && dfx generate __backend_name__ && dfx deploy",
88
"start": "vite --port 3000",
99
"prebuild": "dfx generate",
1010
"build": "tsc && vite build",

‎src/dfx/assets/project_templates/react/src/__frontend_name__/src/App.jsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
import { useState } from 'react';
2-
import { {backend_name_ident} } from 'declarations/{backend_name}';
2+
import { __backend_name_ident__ } from 'declarations/__backend_name__';
33

44
function App() {
55
const [greeting, setGreeting] = useState('');
66

77
function handleSubmit(event) {
88
event.preventDefault();
99
const name = event.target.elements.name.value;
10-
{backend_name_ident}.greet(name).then((greeting) => {
10+
__backend_name_ident__.greet(name).then((greeting) => {
1111
setGreeting(greeting);
1212
});
1313
return false;

‎src/dfx/assets/project_templates/react_tests/src/__frontend_name__/vite.config.js.patch

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
--- a/src/{frontend_name}/vite.config.js
2-
+++ b/src/{frontend_name}/vite.config.js
1+
--- a/src/__frontend_name__/vite.config.js
2+
+++ b/src/__frontend_name__/vite.config.js
33
@@ -1,1 +1,2 @@
44
+/// <reference types="vitest" />
55
import { fileURLToPath, URL } from 'url';

‎src/dfx/assets/project_templates/rust/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[workspace]
22
members = [
3-
"src/{backend_name}"
3+
"src/__backend_name__"
44
]
55
resolver = "2"

‎src/dfx/assets/project_templates/rust/dfx.json-patch

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[
22
{
33
"op": "add",
4-
"path": "/canisters/{backend_name}",
4+
"path": "/canisters/__backend_name__",
55
"value": {
66
"type": "rust",
7-
"package": "{backend_name}",
8-
"candid": "src/{backend_name}/{backend_name}.did"
7+
"package": "__backend_name__",
8+
"candid": "src/__backend_name__/__backend_name__.did"
99
}
1010
}
1111
]

‎src/dfx/assets/project_templates/rust/src/__backend_name__/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[package]
2-
name = "{backend_name}"
2+
name = "__backend_name__"
33
version = "0.1.0"
44
edition = "2021"
55

‎src/dfx/assets/project_templates/simple_assets/dfx.json-patch

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
[
22
{
33
"op": "add",
4-
"path": "/canisters/{frontend_name}",
4+
"path": "/canisters/__frontend_name__",
55
"value": {
66
"type": "assets",
77
"source": [
8-
"src/{frontend_name}/assets"
8+
"src/__frontend_name__/assets"
99
],
1010
"dependencies": [
11-
"{backend_name}"
11+
"__backend_name__"
1212
]
1313
}
1414
}

‎src/dfx/assets/project_templates/svelte/dfx.json-patch

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
[
22
{
33
"op": "add",
4-
"path": "/canisters/{frontend_name}",
4+
"path": "/canisters/__frontend_name__",
55
"value": {
66
"type": "assets",
77
"source": [
8-
"src/{frontend_name}/dist"
8+
"src/__frontend_name__/dist"
99
],
1010
"dependencies": [
11-
"{backend_name}"
11+
"__backend_name__"
1212
],
13-
"workspace": "{frontend_name}"
13+
"workspace": "__frontend_name__"
1414
}
1515
},
1616
{
1717
"op": "add",
18-
"path": "/canisters/{backend_name}/declarations",
18+
"path": "/canisters/__backend_name__/declarations",
1919
"value": {
2020
"node_compatibility": true
2121
}

‎src/dfx/assets/project_templates/svelte/package.json-patch

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
{
33
"op": "add",
44
"path": "/workspaces/-",
5-
"value": "src/{frontend_name}"
5+
"value": "src/__frontend_name__"
66
}
77
]

‎src/dfx/assets/project_templates/svelte/src/__frontend_name__/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
2-
"name": "{frontend_name}",
2+
"name": "__frontend_name__",
33
"private": true,
44
"version": "0.0.0",
55
"type": "module",
66
"scripts": {
7-
"setup": "npm i && dfx canister create {backend_name} && dfx generate {backend_name} && dfx deploy",
7+
"setup": "npm i && dfx canister create __backend_name__ && dfx generate __backend_name__ && dfx deploy",
88
"start": "vite --port 3000",
99
"prebuild": "dfx generate",
1010
"build": "tsc && vite build",

‎src/dfx/assets/project_templates/svelte/src/__frontend_name__/src/lib/canisters.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { createActor, canisterId } from 'declarations/{backend_name}';
1+
import { createActor, canisterId } from 'declarations/__backend_name__';
22
import { building } from '$app/environment';
33

44
function dummyActor() {

‎src/dfx/assets/project_templates/svelte_tests/src/__frontend_name__/vite.config.js.patch

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
--- a/src/{frontend_name}/vite.config.js
2-
+++ b/src/{frontend_name}/vite.config.js
1+
--- a/src/__frontend_name__/vite.config.js
2+
+++ b/src/__frontend_name__/vite.config.js
33
@@ -1,1 +1,2 @@
44
+/// <reference types="vitest" />
55
import { fileURLToPath, URL } from 'url';

‎src/dfx/assets/project_templates/vanilla_js/dfx.json-patch

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
[
22
{
33
"op": "add",
4-
"path": "/canisters/{frontend_name}",
4+
"path": "/canisters/__frontend_name__",
55
"value": {
66
"type": "assets",
77
"source": [
8-
"src/{frontend_name}/dist"
8+
"src/__frontend_name__/dist"
99
],
1010
"dependencies": [
11-
"{backend_name}"
11+
"__backend_name__"
1212
],
13-
"workspace": "{frontend_name}"
13+
"workspace": "__frontend_name__"
1414
}
1515
}
1616
]

‎src/dfx/assets/project_templates/vanilla_js/package.json-patch

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
{
33
"op": "add",
44
"path": "/workspaces/-",
5-
"value": "src/{frontend_name}"
5+
"value": "src/__frontend_name__"
66
}
77
]

‎src/dfx/assets/project_templates/vanilla_js/src/__frontend_name__/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
2-
"name": "{frontend_name}",
2+
"name": "__frontend_name__",
33
"private": true,
44
"version": "0.0.0",
55
"type": "module",
66
"scripts": {
7-
"setup": "npm i && dfx canister create {backend_name} && dfx generate {backend_name} && dfx deploy",
7+
"setup": "npm i && dfx canister create __backend_name__ && dfx generate __backend_name__ && dfx deploy",
88
"start": "vite --port 3000",
99
"prebuild": "dfx generate",
1010
"build": "tsc && vite build",

‎src/dfx/assets/project_templates/vanilla_js/src/__frontend_name__/src/App.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { html, render } from 'lit-html';
2-
import { {backend_name_ident} } from 'declarations/{backend_name}';
2+
import { __backend_name_ident__ } from 'declarations/__backend_name__';
33
import logo from './logo2.svg';
44

55
class App {
@@ -12,7 +12,7 @@ class App {
1212
#handleSubmit = async (e) => {
1313
e.preventDefault();
1414
const name = document.getElementById('name').value;
15-
this.greeting = await {backend_name_ident}.greet(name);
15+
this.greeting = await __backend_name_ident__.greet(name);
1616
this.#render();
1717
};
1818

‎src/dfx/assets/project_templates/vanilla_js_tests/src/__frontend_name__/vite.config.js.patch

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
--- a/src/{frontend_name}/vite.config.js
2-
+++ b/src/{frontend_name}/vite.config.js
1+
--- a/src/__frontend_name__/vite.config.js
2+
+++ b/src/__frontend_name__/vite.config.js
33
@@ -1,1 +1,2 @@
44
+/// <reference types="vitest" />
55
import { defineConfig } from 'vite';

‎src/dfx/assets/project_templates/vue/dfx.json-patch

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
[
22
{
33
"op": "add",
4-
"path": "/canisters/{frontend_name}",
4+
"path": "/canisters/__frontend_name__",
55
"value": {
66
"type": "assets",
77
"dependencies": [
8-
"{backend_name}"
8+
"__backend_name__"
99
],
1010
"source": [
11-
"src/{frontend_name}/dist"
11+
"src/__frontend_name__/dist"
1212
],
13-
"workspace": "{frontend_name}"
13+
"workspace": "__frontend_name__"
1414
}
1515
}
1616
]

‎src/dfx/assets/project_templates/vue/package.json-patch

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
{
33
"op": "add",
44
"path": "/workspaces/-",
5-
"value": "src/{frontend_name}"
5+
"value": "src/__frontend_name__"
66
}
77
]

‎src/dfx/assets/project_templates/vue/src/__frontend_name__/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
2-
"name": "{frontend_name}",
2+
"name": "__frontend_name__",
33
"private": true,
44
"version": "0.0.0",
55
"type": "module",
66
"scripts": {
7-
"setup": "npm i && dfx canister create {backend_name} && dfx generate {backend_name} && dfx deploy",
7+
"setup": "npm i && dfx canister create __backend_name__ && dfx generate __backend_name__ && dfx deploy",
88
"start": "vite --port 3000",
99
"prebuild": "dfx generate",
1010
"build": "tsc && vite build",

‎src/dfx/assets/project_templates/vue/src/__frontend_name__/src/App.vue

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<script setup>
22
import { ref } from 'vue';
3-
import { {backend_name_ident} } from 'declarations/{backend_name}/index';
3+
import { __backend_name_ident__ } from 'declarations/__backend_name__/index';
44
let greeting = ref('');
55
66
async function handleSubmit(e) {
77
e.preventDefault();
88
const target = e.target;
99
const name = target.querySelector('#name').value;
10-
await {backend_name_ident}.greet(name).then((response) => {
10+
await __backend_name_ident__.greet(name).then((response) => {
1111
greeting.value = response;
1212
});
1313
}

0 commit comments

Comments
 (0)