Merge pull request #264 from ckb-devrel/impl-feedback

Impl feedback

Author: RetricSu

src/templates/config.ts

@@ -52,7 +52,7 @@ export const BASE_TEMPLATE_METADATA: TemplateMetadata = {
   requiredFiles: [
     'package.json.template',
     'jest.config.cjs.template',
-    '.gitignore',
+    'gitignore.template',
     'README.md.template',
     'deployment/scripts.json.template',
     'deployment/README.md.template',

src/templates/processor.ts

@@ -64,6 +64,11 @@ export class TemplateProcessor {
     const relativePath = path.relative(this.templateDir, filePath);
     const fileName = path.basename(filePath);
 
+    // Exclude template metadata files
+    if (fileName === '_template.config.json') {
+      return false;
+    }
+
     // Always include required files
     if (BASE_TEMPLATE_METADATA.requiredFiles.some((reqFile) => relativePath.includes(reqFile))) {
       return true;
@@ -111,15 +116,16 @@ export class TemplateProcessor {
     const basePackageJson = {
       name: context.projectName,
       version: '0.1.0',
-      description: 'CKB JavaScript VM project',
+      description: 'CKB JavaScript Smart Contract project',
       private: true,
       type: 'module',
       scripts: {
         build: 'node scripts/build-all.js',
         'build:contract': 'node scripts/build-contract.js',
-        test: 'jest',
+        test: 'node scripts/build-all.js && jest',
         'add-contract': 'node scripts/add-contract.js',
-        clean: 'rimraf contracts/*/dist',
+        deploy: 'node scripts/build-all.js && node scripts/deploy.js',
+        clean: 'rimraf dist',
         format: 'prettier --write .',
       },
       dependencies: TEMPLATE_CONFIG.dependencies,
@@ -159,6 +165,12 @@ export class TemplateProcessor {
       finalTargetPath = path.join(dir, '.env');
     }
 
+    // Handle gitignore.template -> .gitignore
+    if (fileName === 'gitignore') {
+      const dir = path.dirname(finalTargetPath);
+      finalTargetPath = path.join(dir, '.gitignore');
+    }
+
     // Ensure target directory exists
     const targetDir = path.dirname(finalTargetPath);
     fs.mkdirSync(targetDir, { recursive: true });

templates/v4/base-template/README.md.template

@@ -1,6 +1,6 @@
 # {{PROJECT_NAME}}
 
-A CKB JavaScript VM project for developing smart contracts on the CKB blockchain.
+A JavaScript project for developing smart contracts on the CKB blockchain.
 
 ## Overview
 
@@ -12,15 +12,17 @@ This project uses the CKB JavaScript VM (ckb-js-vm) to write smart contracts in
 {{PROJECT_NAME}}/
 ├── contracts/           # Smart contract source code
 │   └── hello-world/
-│       ├── src/
-│       │   └── index.{{LANGUAGE}} # Contract implementation
-│       └── dist/        # Compiled output (generated)
+│       └── src/
+│           └── index.{{LANGUAGE}} # Contract implementation
 ├── tests/              # Contract tests
 │   └── hello-world.test.{{LANGUAGE}}
 ├── scripts/            # Build and utility scripts
 │   ├── build-all.js
 │   ├── build-contract.js
 │   └── add-contract.js
+├── dist/               # Compiled output (generated)
+│   ├── hello-world.js  # Bundled JavaScript
+│   └── hello-world.bc  # Compiled bytecode
 ├── package.json
 {{#if_typescript}}├── tsconfig.json       # TypeScript configuration
 ├── tsconfig.base.json  # Base TypeScript settings
@@ -88,9 +90,9 @@ This will:
 
 ### Build Output
 
-Each contract generates two files in its `dist/` directory:
-- `{contract-name}.js` - Bundled JavaScript code
-- `{contract-name}.bc` - Compiled bytecode for CKB execution
+All contracts are built to the global `dist/` directory:
+- `dist/{contract-name}.js` - Bundled JavaScript code
+- `dist/{contract-name}.bc` - Compiled bytecode for CKB execution
 
 ### Testing
 
@@ -106,9 +108,53 @@ Tests use the `ckb-testtool` framework to simulate CKB blockchain execution. Eac
 - `build:contract <name>` - Build a specific contract
 - `test` - Run all tests
 - `add-contract <name>` - Add a new contract
+- `deploy` - Deploy contracts to CKB network
 - `clean` - Remove all build outputs
 - `format` - Format code with Prettier
 
+## Deployment
+
+Deploy your contracts to CKB networks using the built-in deploy script:
+
+### Basic Usage
+
+```bash
+# Deploy to devnet (default)
+{{PACKAGE_MANAGER}} run deploy
+
+# Deploy to testnet
+{{PACKAGE_MANAGER}} run deploy -- --network testnet
+
+# Deploy to mainnet
+{{PACKAGE_MANAGER}} run deploy -- --network mainnet
+```
+
+### Advanced Options
+
+```bash
+# Deploy with upgradable type ID
+{{PACKAGE_MANAGER}} run deploy -- --network testnet --type-id
+
+# Deploy with custom private key
+{{PACKAGE_MANAGER}} run deploy -- --network testnet --privkey 0x...
+
+# Combine multiple options
+{{PACKAGE_MANAGER}} run deploy -- --network testnet --type-id --privkey 0x...
+```
+
+### Available Options
+
+- `--network <network>` - Target network: `devnet`, `testnet`, or `mainnet` (default: `devnet`)
+- `--privkey <privkey>` - Private key for deployment (default: uses offckb's deployer account)
+- `--type-id` - Enable upgradable type ID for contract updates
+
+### Deployment Artifacts
+
+After successful deployment, artifacts are saved to the `deployment/` directory:
+- `deployment/scripts.json` - Contract script information
+- `deployment/<network>/<contract>/deployment.toml` - Deployment configuration
+- `deployment/<network>/<contract>/migrations/` - Migration history
+
 ## Dependencies
 
 ### Core Dependencies

templates/v4/base-template/.gitignore …ates/v4/base-template/gitignore.templatetemplates/v4/base-template/.gitignore renamed to templates/v4/base-template/gitignore.template templates/v4/base-template/.gitignore renamed to templates/v4/base-template/gitignore.template

@@ -3,7 +3,6 @@ node_modules/
 .pnpm-store/
 
 # Build outputs
-contracts/*/dist/
 dist/
 build/
 

templates/v4/base-template/jest.config.cjs.js.template

@@ -1,14 +1,14 @@
 /** @type {import('jest').Config} */
 module.exports = {
   testEnvironment: "node",
-  testPathIgnorePatterns: ["/node_modules/", "/dist/", "/contracts/*/dist/"],
+  testPathIgnorePatterns: ["/node_modules/", "/dist/"],
   moduleFileExtensions: ["js", "json"],
   testMatch: ["**/tests/**/*.test.js"],
   transformIgnorePatterns: [
     "node_modules/(?!(@ckb-ccc|ckb-testtool)/)"
   ],
   collectCoverageFrom: [
     "contracts/*/src/**/*.js",
-    "!contracts/*/dist/**"
+    "!dist/**"
   ]
 };

templates/v4/base-template/jest.config.cjs.ts.template

@@ -2,9 +2,9 @@
 module.exports = {
   preset: "ts-jest",
   testEnvironment: "node",
-  testPathIgnorePatterns: ["/node_modules/", "/dist/", "/contracts/*/dist/"],
+  testPathIgnorePatterns: ["/node_modules/", "/dist/"],
   collectCoverageFrom: [
     "contracts/*/src/**/*.ts",
-    "!contracts/*/dist/**"
+    "!dist/**"
   ]
 };