create-nube-app 0.0.2 → 0.0.4

package/README.md

@@ -0,0 +1,85 @@
+# create-nube-app <a href="https://npmjs.com/package/create-nube-app"><img src="https://img.shields.io/npm/v/create-nube-app" alt="npm package"></a>
+
+**CLI to quickly create NubeSDK applications.**
+
+## About
+
+`create-nube-app` is a command-line tool that allows you to create new NubeSDK applications with an optimized initial configuration. This tool automates the project setup process, including:
+
+- Recommended directory structure
+- TypeScript configuration
+- Bundler configuration (tsup)
+- Required dependencies
+- Basic code examples
+
+## Installation
+
+With NPM:
+
+```sh
+npm create nube-app
+```
+
+With Yarn:
+
+```sh
+yarn create nube-app
+```
+With PNPM:
+
+```sh
+pnpm create nube-app
+```
+
+## Usage
+
+After running the command, you'll be guided through an interactive process that allows you to:
+
+1. What is the project's name?
+2. Select a template:
+
+### Usage Example
+
+```
+$ npm create nube-app
+What is the project's name?
+Select a template:
+    Minimal
+❯   Minimal with UI
+    Minimal with UI in JSX
+```
+
+## Project Structure
+
+After creation, your project will have the following structure:
+
+```
+my-nube-app/
+├── src/
+│   └── main.ts
+├── package.json
+├── tsconfig.json
+├── tsup.config.js
+└── biome.json
+```
+
+## Available Scripts
+
+The created project includes the following scripts:
+
+- `npm run build` → Builds the project using tsup
+
+## Official Documentation
+
+For more details about NubeSDK and how to build apps, check out our **official documentation**:
+
+[**NubeSDK Documentation**](https://dev.tiendanube.com/docs/applications/nube-sdk/overview)
+
+## Support
+
+- **Questions?** Use [GitHub Issues](https://github.com/TiendaNube/nube-sdk/issues).
+- **Found a bug?** Open an issue with a reproducible example.
+
+---
+
+© [Tiendanube / Nuvemshop](https://www.tiendanube.com), 2025. All rights reserved.

package/dist/index.js

@@ -0,0 +1,68 @@
+#!/usr/bin/env node
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import * as prompts from "@clack/prompts";
+import fs from "fs-extra";
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+function toSlug(text) {
+  return text.toLowerCase().replace(/\s+/g, "-");
+}
+function pkgFromUserAgent(userAgent) {
+  if (!userAgent) return void 0;
+  const pkgSpec = userAgent.split(" ")[0];
+  const pkgSpecArr = pkgSpec.split("/");
+  return {
+    name: pkgSpecArr[0],
+    version: pkgSpecArr[1]
+  };
+}
+function isEmpty(path2) {
+  const files = fs.readdirSync(path2);
+  return files.length === 0 || files.length === 1 && files[0] === ".git";
+}
+async function main() {
+  const defaultValue = "my-nube-app";
+  const pkgInfo = pkgFromUserAgent(process.env.npm_config_user_agent);
+  const cancel = (message = "Operation cancelled") => prompts.cancel(message);
+  const projectName = await prompts.text({
+    message: "What is the project's name?",
+    defaultValue,
+    placeholder: defaultValue
+  });
+  if (prompts.isCancel(projectName)) return cancel();
+  const templateName = await prompts.select({
+    message: "Select a template:",
+    options: [
+      { label: "Minimal", value: "minimal" },
+      { label: "Minimal with UI", value: "minimal-ui" },
+      { label: "Minimal with UI in JSX", value: "minimal-ui-jsx" }
+    ]
+  });
+  if (prompts.isCancel(templateName)) return cancel();
+  const dest = path.resolve(process.cwd(), toSlug(projectName));
+  const src = path.join(__dirname, `../templates/${templateName}`);
+  if (fs.existsSync(dest) && !isEmpty(dest)) {
+    cancel(`Template directory "${projectName}" is not empty.`);
+    return;
+  }
+  await fs.copy(src, dest);
+  const pkgManager = pkgInfo ? pkgInfo.name : "npm";
+  let doneMessage = "";
+  doneMessage += "Done. Now run:\n";
+  doneMessage += `
+  cd ${projectName}`;
+  switch (pkgManager) {
+    case "yarn":
+      doneMessage += "\n  yarn";
+      doneMessage += "\n  yarn build";
+      break;
+    default:
+      doneMessage += `
+  ${pkgManager} install`;
+      doneMessage += `
+  ${pkgManager} run build`;
+      break;
+  }
+  prompts.outro(doneMessage);
+}
+main();

package/package.json

@@ -2,26 +2,34 @@
     "name": "create-nube-app",
     "description": "Create Nube App",
     "author": "Tiendanube / Nuvemshop",
-	"license": "MIT",
-    "version": "0.0.2",
+    "license": "MIT",
+    "version": "0.0.4",
     "bin": {
-        "create-nube-app": "index.js"
+        "create-nube-app": "dist/index.js"
     },
     "scripts": {
         "build": "tsup",
         "check": "biome check src/*",
-		"check:fix": "biome check --write src/*"
+        "check:fix": "biome check --write src/*"
     },
     "type": "module",
-    "devDependencies": {
+    "dependencies": {
         "@clack/prompts": "^0.10.0",
+        "fs-extra": "^11.1.1"
+    },
+    "devDependencies": {
+        "@biomejs/biome": "1.8.3",
         "@types/fs-extra": "^11.0.4",
         "@types/node": "^22.13.11",
         "@types/prompts": "^2.4.9",
-        "fs-extra": "^11.1.1",
-        "prompts": "^2.4.2",
         "tsup": "^8.4.0",
-        "typescript": "^5.6.2",
-        "@biomejs/biome": "1.8.3"
-    }
+        "typescript": "^5.6.2"
+    },
+    "files": [
+        "./dist",
+        "README.md",
+        "CHANGELOG.md",
+        "LICENSE",
+        "./templates"
+    ]
 }

package/biome.json

@@ -1,12 +0,0 @@
-{
-	"$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
-	"organizeImports": {
-		"enabled": true
-	},
-	"linter": {
-		"enabled": true,
-		"rules": {
-			"recommended": true
-		}
-	}
-}

package/index.js

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-
-import './dist/index.js';

package/src/index.ts

@@ -1,81 +0,0 @@
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-import * as prompts from "@clack/prompts";
-import fs from "fs-extra";
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
-function toSlug(text: string): string {
-	return text.toLowerCase().replace(/\s+/g, "-");
-}
-
-interface PkgInfo {
-	name: string;
-	version: string;
-}
-
-function pkgFromUserAgent(userAgent: string | undefined): PkgInfo | undefined {
-	if (!userAgent) return undefined;
-	const pkgSpec = userAgent.split(" ")[0];
-	const pkgSpecArr = pkgSpec.split("/");
-	return {
-		name: pkgSpecArr[0],
-		version: pkgSpecArr[1],
-	};
-}
-
-function isEmpty(path: string) {
-	const files = fs.readdirSync(path);
-	return files.length === 0 || (files.length === 1 && files[0] === ".git");
-}
-
-async function main(): Promise<void> {
-	const defaultValue = "my-nube-app";
-	const pkgInfo = pkgFromUserAgent(process.env.npm_config_user_agent);
-	const cancel = (message = "Operation cancelled") => prompts.cancel(message);
-
-	const projectName = await prompts.text({
-		message: "What is the project's name?",
-		defaultValue,
-		placeholder: defaultValue,
-	});
-	if (prompts.isCancel(projectName)) return cancel();
-
-	const templateName = await prompts.select({
-		message: "Select a template:",
-		options: [
-			{ label: "minimal", value: "minimal" },
-			{ label: "minimal-ui", value: "minimal-ui" },
-			{ label: "minimal-ui-jsx", value: "minimal-ui-jsx" },
-		],
-	});
-	if (prompts.isCancel(templateName)) return cancel();
-
-	const dest = path.resolve(process.cwd(), toSlug(projectName as string));
-	const src = path.join(__dirname, `../templates/${templateName as string}`);
-
-	if (fs.existsSync(dest) && !isEmpty(dest)) {
-		cancel(`Template directory "${projectName}" is not empty.`);
-		return;
-	}
-
-	await fs.copy(src, dest);
-
-	const pkgManager = pkgInfo ? pkgInfo.name : "npm";
-	let doneMessage = "";
-	doneMessage += "Done. Now run:\n";
-	doneMessage += `\n  cd ${projectName as string}`;
-	switch (pkgManager) {
-		case "yarn":
-			doneMessage += "\n  yarn";
-			doneMessage += "\n  yarn build";
-			break;
-		default:
-			doneMessage += `\n  ${pkgManager} install`;
-			doneMessage += `\n  ${pkgManager} run build`;
-			break;
-	}
-	prompts.outro(doneMessage);
-}
-
-main();

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-    "compilerOptions": {
-        "target": "ES2020",
-        "module": "ESNext",
-        "moduleResolution": "node",
-        "esModuleInterop": true,
-        "forceConsistentCasingInFileNames": true,
-        "strict": true,
-        "skipLibCheck": true,
-        "types": [
-            "node"
-        ]
-    }
-}

package/tsup.config.js

@@ -1,13 +0,0 @@
-// tsup.config.js
-import { defineConfig } from 'tsup';
-
-export default defineConfig({
-  entry: ['src/index.ts'], // ponto de entrada do seu projeto
-  format: ['esm'],  // formatos de saída
-  bundle: false,           // não agrupa os módulos em um único arquivo
-  minify: false,           // desabilita a minificação
-  sourcemap: false,         // gera sourcemaps para facilitar o debug
-  clean: true,             // limpa a pasta de saída antes de cada build
-  target: 'node16',        // define o alvo (ajuste conforme sua versão do Node)
-  dts: false,               // gera arquivos de definição TypeScript (.d.ts)
-});