@tuwaio/create-cosmos-playground 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## [0.0.2](https://github.com/TuwaIO/cosmos-playground/compare/create-cosmos-playground-v0.0.1...create-cosmos-playground-v0.0.2) (2025-09-19)
+
+
+### Bug Fixes
+
+* npx @tuwaio/create-cosmos-playground ([20173ab](https://github.com/TuwaIO/cosmos-playground/commit/20173ab7685085febec85646b700f85afae2b5a8))

package/CONTRIBUTING.md

@@ -0,0 +1,4 @@
+# Contribution Guidelines
+
+This project follows the central TUWA contribution guidelines. Please read them here:
+[TUWA Contribution Guidelines](https://github.com/TuwaIO/workflows/blob/main/CONTRIBUTING.md)

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 FOP Tkach Oleksandr
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,76 @@
+# @tuwaio/create-cosmos-playground
+
+A CLI tool to scaffold new Cosmos Playground examples quickly and easily. This tool helps you start new projects based on predefined templates hosted on GitHub.
+
+---
+
+## Features
+
+- **Intuitive prompts:** Easily select from available project templates and name your new project.
+- **Automated setup:** The tool automatically downloads the selected template from the GitHub repository.
+- **Dependency installation:** Dependencies are automatically installed using `pnpm` after scaffolding.
+- **Multiple templates:** Supports a variety of templates for different web3 frameworks and chains.
+
+---
+
+## Requirements
+
+- **Node.js** v14+ installed on your machine.
+- An internet connection for downloading templates and dependencies.
+
+---
+
+## Usage
+
+To use the tool, simply run the `npx` command:
+
+```bash
+npx @tuwaio/create-cosmos-playground
+```
+
+The CLI will guide you through the process:
+
+It will prompt you to select a project template.
+
+You will be asked to enter a name for your new project.
+
+It will automatically download the chosen template and install its dependencies.
+
+Example
+Here is a typical workflow:
+```bash
+# Execute the CLI tool
+npx @tuwaio/create-cosmos-playground
+
+# Example prompts and output:
+# ✨ Creating a new Cosmos Playground project...
+# ✔ Which template would you like to use? › nextjs-connectkit
+# ✔ What is the name of your new project? (e.g., my-new-app) … my-new-app
+
+# ⬇️ Downloading template "nextjs-connectkit" from GitHub...
+# 🎉 Your new project "my-new-app" has been created!
+# 📦 Installing dependencies with pnpm...
+# ... (pnpm install output) ...
+
+# Done! Now run:
+# cd my-new-app
+# pnpm dev
+```
+
+---
+
+## 🤝 Contributing & Support
+
+Contributions are welcome! Please read our main **[Contribution Guidelines](https://github.com/TuwaIO/workflows/blob/main/CONTRIBUTING.md)**.
+
+If you find this library useful, please consider supporting its development. Every contribution helps!
+
+[**➡️ View Support Options**](https://github.com/TuwaIO/workflows/blob/main/Donation.md)
+
+---
+
+Built with ❤️ from **TUWA**.
+
+## License
+
+[Apache License 2.0](./LICENSE)

package/dist/index.js

@@ -0,0 +1,73 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const execa_1 = require("execa");
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const prompts_1 = __importDefault(require("prompts"));
+const REPO_URL = 'TuwaIO/cosmos-playground/examples';
+async function main() {
+    console.log('✨ Creating a new Cosmos Playground project...');
+    const availableTemplates = [
+        'nextjs-connectkit',
+        'nextjs-dynamic',
+        'nextjs-reown',
+        'nextjs-rainbowkit',
+        'nextjs-solana',
+        'nextjs-web3auth',
+        'vite-rainbowkit',
+    ];
+    const templateResponse = await (0, prompts_1.default)({
+        type: 'select',
+        name: 'template',
+        message: 'Which template would you like to use?',
+        choices: availableTemplates.map((template) => ({ title: template, value: template })),
+        initial: 0,
+    });
+    const { template } = templateResponse;
+    if (!template) {
+        console.log('Aborting...');
+        return;
+    }
+    const projectNameResponse = await (0, prompts_1.default)({
+        type: 'text',
+        name: 'projectName',
+        message: `What is the name of your new project? (e.g., my-new-app)`,
+        validate: (name) => (name.length > 0 ? true : `Project name cannot be empty.`),
+    });
+    const { projectName } = projectNameResponse;
+    const projectPath = path_1.default.join(process.cwd(), projectName);
+    if (fs_extra_1.default.existsSync(projectPath)) {
+        const overwriteResponse = await (0, prompts_1.default)({
+            type: 'confirm',
+            name: 'overwrite',
+            message: `Directory "${projectName}" already exists. Overwrite?`,
+            initial: false,
+        });
+        if (!overwriteResponse.overwrite) {
+            console.log('Aborting...');
+            return;
+        }
+        await fs_extra_1.default.remove(projectPath);
+    }
+    try {
+        console.log(`\n⬇️ Downloading template "${template}" from GitHub...`);
+        // Use npx to invoke degit locally
+        const degitSource = `${REPO_URL}/${template}`;
+        await (0, execa_1.execa)('npx', ['degit', degitSource, projectPath], { stdio: 'inherit' });
+        console.log(`\n🎉 Your new project "${projectName}" has been created!`);
+        console.log(`\n📦 Installing dependencies with pnpm...`);
+        await (0, execa_1.execa)('pnpm', ['install'], { cwd: projectPath, stdio: 'inherit' });
+        console.log(`\nDone! Next steps:`);
+        console.log(`cd ${projectName}`);
+        console.log(`pnpm dev`);
+    }
+    catch (error) {
+        console.error(`\n❌ An error occurred: ${error}`);
+        process.exit(1);
+    }
+}
+main().catch(console.error);

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@tuwaio/create-cosmos-playground",
+  "version": "0.0.2",
+  "description": "A CLI tool to scaffold new Cosmos Playground examples.",
+  "keywords": [
+    "cli",
+    "scaffolding",
+    "web3",
+    "cosmos",
+    "playground",
+    "web3 transactions tracking"
+  ],
+  "author": "Oleksandr Tkach",
+  "license": "Apache-2.0",
+  "bin": {
+    "create-cosmos-playground": "dist/index.js"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/prompts": "^2.4.9",
+    "@types/node": "^20.14.12",
+    "typescript": "~5.9.2"
+  },
+  "dependencies": {
+    "prompts": "^2.4.2",
+    "fs-extra": "^11.2.0",
+    "degit": "^2.8.4",
+    "execa": "^9.3.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "dev": "tsc --watch",
+    "build": "tsc"
+  }
+}

package/src/index.ts

@@ -0,0 +1,84 @@
+#!/usr/bin/env node
+
+import { execa } from 'execa';
+import fs from 'fs-extra';
+import path from 'path';
+import prompts from 'prompts';
+
+const REPO_URL = 'TuwaIO/cosmos-playground/examples';
+
+async function main() {
+  console.log('✨ Creating a new Cosmos Playground project...');
+
+  const availableTemplates = [
+    'nextjs-connectkit',
+    'nextjs-dynamic',
+    'nextjs-reown',
+    'nextjs-rainbowkit',
+    'nextjs-solana',
+    'nextjs-web3auth',
+    'vite-rainbowkit',
+  ];
+
+  const templateResponse = await prompts({
+    type: 'select',
+    name: 'template',
+    message: 'Which template would you like to use?',
+    choices: availableTemplates.map((template) => ({ title: template, value: template })),
+    initial: 0,
+  });
+
+  const { template } = templateResponse;
+
+  if (!template) {
+    console.log('Aborting...');
+    return;
+  }
+
+  const projectNameResponse = await prompts({
+    type: 'text',
+    name: 'projectName',
+    message: `What is the name of your new project? (e.g., my-new-app)`,
+    validate: (name) => (name.length > 0 ? true : `Project name cannot be empty.`),
+  });
+
+  const { projectName } = projectNameResponse;
+  const projectPath = path.join(process.cwd(), projectName);
+
+  if (fs.existsSync(projectPath)) {
+    const overwriteResponse = await prompts({
+      type: 'confirm',
+      name: 'overwrite',
+      message: `Directory "${projectName}" already exists. Overwrite?`,
+      initial: false,
+    });
+
+    if (!overwriteResponse.overwrite) {
+      console.log('Aborting...');
+      return;
+    }
+
+    await fs.remove(projectPath);
+  }
+
+  try {
+    console.log(`\n⬇️ Downloading template "${template}" from GitHub...`);
+
+    // Use npx to invoke degit locally
+    const degitSource = `${REPO_URL}/${template}`;
+    await execa('npx', ['degit', degitSource, projectPath], { stdio: 'inherit' });
+
+    console.log(`\n🎉 Your new project "${projectName}" has been created!`);
+    console.log(`\n📦 Installing dependencies with pnpm...`);
+    await execa('pnpm', ['install'], { cwd: projectPath, stdio: 'inherit' });
+
+    console.log(`\nDone! Next steps:`);
+    console.log(`cd ${projectName}`);
+    console.log(`pnpm dev`);
+  } catch (error) {
+    console.error(`\n❌ An error occurred: ${error}`);
+    process.exit(1);
+  }
+}
+
+main().catch(console.error);

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "module": "commonjs",
+    "moduleResolution": "node"
+  },
+  "include": ["src/**/*.ts"]
+}