create-ton 0.0.11 → 0.2.0

package/CHANGELOG.md

@@ -5,6 +5,35 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - 2023-03-27
+
+### Added
+
+- Added the ability to pass project name as a command line argument
+
+### Changed
+
+- Dependencies of newly created projects are now installed using the package manager that is used to invoke create-ton
+- Updated template dependencies' versions: blueprint to 0.6.1, sandbox to 0.7.0
+
+## [0.1.0] - 2023-03-21
+
+### Added
+
+- Added support for [TACT](https://github.com/tact-lang/tact), including TACT smart contract templates
+- Added `.prettierignore` to template to ignore generated TACT files
+
+### Changed
+
+- Updated template dependencies, including blueprint to 0.6.0, sandbox to 0.6.1, test-utils to 0.2.0
+- Edited template's `README.md`
+- Changed template's `.gitignore` to contain a newline at the end
+- Updated dependencies
+
+### Removed
+
+- Removed dubious `LICENSE` file from template
+
 ## [0.0.11] - 2023-03-02
 
 ### Changed

package/dist/cli.js

@@ -11,10 +11,13 @@ const inquirer_1 = __importDefault(require("inquirer"));
 const chalk_1 = __importDefault(require("chalk"));
 const PACKAGE_JSON = 'package.json';
 async function main() {
-    const name = (await inquirer_1.default.prompt({
-        name: 'name',
-        message: 'Project name',
-    })).name.trim();
+    console.log();
+    const name = process.argv.length > 2
+        ? process.argv[2]
+        : (await inquirer_1.default.prompt({
+            name: 'name',
+            message: 'Project name',
+        })).name.trim();
     if (name.length === 0)
         throw new Error('Cannot initialize a project with an empty name');
     const contractName = (await inquirer_1.default.prompt({
@@ -32,12 +35,20 @@ async function main() {
             type: 'list',
             choices: [
                 {
-                    name: 'An empty contract',
-                    value: 'empty',
+                    name: 'An empty contract (FunC)',
+                    value: 'func-empty',
                 },
                 {
-                    name: 'A simple counter contract',
-                    value: 'counter',
+                    name: 'A simple counter contract (FunC)',
+                    value: 'func-counter',
+                },
+                {
+                    name: 'An empty contract (TACT)',
+                    value: 'tact-empty',
+                },
+                {
+                    name: 'A simple counter contract (TACT)',
+                    value: 'tact-counter',
                 },
             ],
         },
@@ -53,16 +64,37 @@ async function main() {
     }
     await fs_extra_1.default.writeFile(path_1.default.join(name, '.gitignore'), `node_modules
 temp
-build`);
+build
+`);
     await fs_extra_1.default.writeFile(path_1.default.join(name, PACKAGE_JSON), (await fs_extra_1.default.readFile(path_1.default.join(basePath, PACKAGE_JSON))).toString().replace('{{name}}', name));
     console.log(`[2/${steps}] Installing dependencies...\n`);
     const execOpts = {
         stdio: 'inherit',
         cwd: name,
     };
-    (0, child_process_1.execSync)('npm i', execOpts);
+    const pkgManager = (process.env.npm_config_user_agent ?? 'npm/').split(' ')[0].split('/')[0];
+    switch (pkgManager) {
+        case 'yarn':
+            (0, child_process_1.execSync)('yarn', execOpts);
+            break;
+        case 'pnpm':
+            (0, child_process_1.execSync)('pnpm install', execOpts);
+            break;
+        default:
+            (0, child_process_1.execSync)('npm install', execOpts);
+            break;
+    }
     console.log(`\n[3/${steps}] Creating your first contract...`);
-    (0, child_process_1.execSync)(`npx blueprint create ${contractName} --type ${variant}`, execOpts);
+    let execCommand = 'npm';
+    switch (pkgManager) {
+        case 'yarn':
+            execCommand = 'yarn';
+            break;
+        case 'pnpm':
+            execCommand = 'pnpm';
+            break;
+    }
+    (0, child_process_1.execSync)(`${execCommand} exec blueprint -- create ${contractName} --type ${variant}`, execOpts);
     try {
         (0, child_process_1.execSync)('git init', execOpts);
     }

package/dist/template/.prettierignore

@@ -0,0 +1 @@
+build

package/dist/template/README.md

@@ -1,9 +1,7 @@
-# TON project template (RFC)
+# TON project
 
 Starter template for a new TON project - FunC contracts, unit tests, compilation and deployment scripts.
 
-> This repo is a work in progress and is subject to change
-
 ## Layout
 
 -   `contracts` - contains the source code of all the smart contracts of the project and their dependencies.
@@ -11,18 +9,13 @@ Starter template for a new TON project - FunC contracts, unit tests, compilation
 -   `tests` - tests for the contracts. Would typically use the wrappers.
 -   `scripts` - contains scripts used by the project, mainly the deployment scripts.   
 
-We ask the community to provide any comments on this layout, the wanted/required changes, or even suggestions for entirely different project structures and/or tool concepts.
-
-PRs are welcome!
-
 ## Repo contents / tech stack
 1. Compiling FunC - [https://github.com/ton-community/func-js](https://github.com/ton-community/func-js)
-2. Testing TON smart contracts - [https://github.com/ton-community/sandbox/](https://github.com/ton-community/sandbox/)
-3. Deployment of contracts is supported with [TON Connect 2](https://github.com/ton-connect/), [Tonhub wallet](https://tonhub.com/) or via a direct `ton://` deeplink
+2. Testing TON smart contracts - [https://github.com/ton-community/sandbox](https://github.com/ton-community/sandbox)
+3. Deployment of contracts is supported with [TON Connect 2](https://github.com/ton-connect/), [Tonhub wallet](https://tonhub.com/), using mnemonics, or via a direct `ton://` deeplink
 
 ## How to use
-* Clone this repo
-* Run `yarn install`
+* Run `npm create ton@latest`
 
 ### Building a contract
 1. Interactively
@@ -41,6 +34,7 @@ PRs are welcome!
       1. With a TON Connect compatible wallet
       2. A `ton://` deep link / QR code
       3. Tonhub wallet
+      4. Mnemonic
    5. Deploy the contract
 2. Non-interactively
    1. Run `yarn blueprint run <CONTRACT> --<NETWORK> --<DEPLOY_METHOD>`

package/dist/template/package.json

@@ -6,18 +6,18 @@
         "test": "jest"
     },
     "devDependencies": {
-        "@ton-community/blueprint": "^0.4.1",
-        "@ton-community/sandbox": "^0.5.1",
-        "@ton-community/test-utils": "^0.0.2",
-        "@types/jest": "^29.2.6",
-        "@types/node": "^18.11.18",
-        "jest": "^29.3.1",
-        "prettier": "^2.8.3",
+        "@ton-community/blueprint": "^0.6.1",
+        "@ton-community/sandbox": "^0.7.0",
+        "@ton-community/test-utils": "^0.2.0",
+        "@types/jest": "^29.5.0",
+        "@types/node": "^18.15.5",
+        "jest": "^29.5.0",
+        "prettier": "^2.8.6",
         "ton": "^13.4.1",
         "ton-core": "^0.48.0",
         "ton-crypto": "^3.2.0",
         "ts-jest": "^29.0.5",
         "ts-node": "^10.9.1",
-        "typescript": "^4.9.4"
+        "typescript": "^4.9.5"
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "create-ton",
-    "version": "0.0.11",
+    "version": "0.2.0",
     "license": "MIT",
     "description": "Tool to quickly create TON projects",
     "author": "TonTech",
@@ -19,14 +19,14 @@
     },
     "devDependencies": {
         "@types/fs-extra": "^11.0.1",
-        "@types/inquirer": "^8.2.5",
-        "@types/node": "^18.11.18",
-        "prettier": "^2.8.3",
+        "@types/inquirer": "^8.2.6",
+        "@types/node": "^18.15.5",
+        "prettier": "^2.8.6",
         "typescript": "^4.9.5"
     },
     "dependencies": {
         "chalk": "^4.1.0",
-        "fs-extra": "^11.1.0",
+        "fs-extra": "^11.1.1",
         "inquirer": "^8.2.5"
     }
 }

package/dist/template/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Tontech
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.