create-nextblock 0.2.24 → 0.2.26

package/bin/create-nextblock.js

@@ -177,18 +177,22 @@ async function runSetupWizard(projectDir, projectName) {
   const projectPath = resolve(projectDir);
   process.chdir(projectPath);
 
-  clack.intro('🚀 Welcome to the NextBlock setup wizard!');
-
+  clack.intro('🚀 Welcome to the NextBlock setup wizard!');
+
   const supabaseDir = resolve(projectPath, 'supabase');
   await fs.ensureDir(supabaseDir);
   await resetSupabaseProjectRef(projectPath);
 
+  clack.note(
+    'Supabase Prerequisites:\n\nBefore proceeding, ensure you have a Supabase project ready.\n\nSupabase Cloud: Create a project at https://supabase.com/dashboard\n\nVercel Storage: If created via Vercel > Storage > Create Database, check your .env.local snippet on Vercel for the required keys.',
+  );
+
   clack.note('Connecting to Supabase...');
   clack.note('I will now open your browser to log into Supabase.');
   await runSupabaseCli(['login'], { cwd: projectPath });
-
-  clack.note('Now, please select your NextBlock project when prompted.');
-  await runSupabaseCli(['link'], { cwd: projectPath });
+
+  clack.note('Now, please select your NextBlock project when prompted.');
+  await runSupabaseCli(['link'], { cwd: projectPath });
   if (process.stdin.isTTY) {
     try {
       process.stdin.setRawMode(false);
@@ -199,10 +203,10 @@ async function runSetupWizard(projectDir, projectName) {
     process.stdin.resume();
   }
 
-  let projectId = await readSupabaseProjectRef(projectPath);
-
-  if (!projectId) {
-    clack.note('I could not detect your Supabase project ref automatically.');
+  let projectId = await readSupabaseProjectRef(projectPath);
+
+  if (!projectId) {
+    clack.note('I could not detect your Supabase project ref automatically.');
     const manual = await clack.text({
       message:
         'Enter your Supabase project ref (from the Supabase dashboard URL or the link output, e.g., abcdefghijklmnopqrstu):',
@@ -212,8 +216,8 @@ async function runSetupWizard(projectDir, projectName) {
       handleWizardCancel('Setup cancelled.');
     }
     projectId = manual.trim();
-  }
-  await ensureSupabaseAssets(projectPath, { required: true });
+  }
+  await ensureSupabaseAssets(projectPath, { required: true });
 
   const siteUrlPrompt = await clack.text({
     message: 'What is the public URL of your site? (NEXT_PUBLIC_URL)',
@@ -226,24 +230,27 @@ async function runSetupWizard(projectDir, projectName) {
   const siteUrl = siteUrlPrompt.trim();
 
   clack.note('Please go to your Supabase project dashboard to get the following secrets.');
-  const supabaseKeys = await clack.group(
-    {
-      dbPassword: () =>
-        clack.password({
-          message: 'What is your Database Password? (Settings > Database > Connection Parameters)',
-          validate: (val) => (!val ? 'Password is required' : undefined),
-        }),
-      anonKey: () =>
-        clack.password({
-          message: 'What is your Project API Key (anon key)? (Settings > API > Project API Keys)',
-          validate: (val) => (!val ? 'Anon Key is required' : undefined),
-        }),
-      serviceKey: () =>
-        clack.password({
-          message: 'What is your Service Role Key (service_role key)? (Settings > API > Project API Keys)',
-          validate: (val) => (!val ? 'Service Role Key is required' : undefined),
-        }),
-    },
+  const supabaseKeys = await clack.group(
+    {
+      dbPassword: () =>
+        clack.password({
+          message:
+            'What is your Database Password? (Supabase: Database > Database Settings > Reset database password | Vercel: POSTGRES_PASSWORD)',
+          validate: (val) => (!val ? 'Password is required' : undefined),
+        }),
+      anonKey: () =>
+        clack.password({
+          message:
+            'What is your Project API Key (anon key)? (Supabase: Project Settings > API Keys > Project Legacy API Keys | Vercel: SUPABASE_ANON_KEY)',
+          validate: (val) => (!val ? 'Anon Key is required' : undefined),
+        }),
+      serviceKey: () =>
+        clack.password({
+          message:
+            'What is your Service Role Key (service_role key)? (Supabase: Project Settings > API Keys > Project Legacy API Keys | Vercel: SUPABASE_SERVICE_ROLE_KEY)',
+          validate: (val) => (!val ? 'Service Role Key is required' : undefined),
+        }),
+    },
     { onCancel: () => handleWizardCancel('Setup cancelled.') },
   );
 
@@ -304,7 +311,7 @@ async function runSetupWizard(projectDir, projectName) {
 
   clack.note('Setting up your database...');
   const dbPushSpinner = clack.spinner();
-  dbPushSpinner.start('Pushing database schema... (~10 minutes, please keep this terminal open)');
+  dbPushSpinner.start('Pushing database schema... (~10-15 minutes, please keep this terminal open)');
   try {
     process.env.POSTGRES_URL = postgresUrl;
     const migrationsDir = resolve(projectPath, 'supabase', 'migrations');
@@ -331,12 +338,15 @@ async function runSetupWizard(projectDir, projectName) {
     }
   }
 
-  const setupR2 = await clack.confirm({
-    message: 'Do you want to set up Cloudflare R2 for media storage now? (Optional)',
-  });
-  if (clack.isCancel(setupR2)) {
-    handleWizardCancel('Setup cancelled.');
-  }
+  clack.note(
+    'Optional Cloudflare R2 Setup:\nHave your Account ID, API token (Access + Secret), bucket name, and public bucket URL handy if you want media storage ready now.',
+  );
+  const setupR2 = await clack.confirm({
+    message: 'Do you want to set up Cloudflare R2 for media storage now? (Optional > populate .env keys)',
+  });
+  if (clack.isCancel(setupR2)) {
+    handleWizardCancel('Setup cancelled.');
+  }
 
   let r2Values = {
     publicBaseUrl: '',
@@ -350,33 +360,34 @@ async function runSetupWizard(projectDir, projectName) {
     clack.note('I will open your browser to the R2 dashboard.\nYou need to create a bucket and an R2 API Token.');
     await open('https://dash.cloudflare.com/?to=/:account/r2', { wait: false });
 
-    const r2Keys = await clack.group(
-      {
-        accountId: () =>
-          clack.text({
-            message: 'R2: Paste your Cloudflare Account ID:',
-            validate: (val) => (!val ? 'Account ID is required' : undefined),
-          }),
-        bucketName: () =>
+    const r2Keys = await clack.group(
+      {
+        accountId: () =>
+          clack.text({
+            message: 'R2: Paste your Cloudflare Account ID (Overview > Account Details - Bottom right):',
+            validate: (val) => (!val ? 'Account ID is required' : undefined),
+          }),
+        bucketName: () =>
           clack.text({
             message: 'R2: Paste your Bucket Name:',
             validate: (val) => (!val ? 'Bucket name is required' : undefined),
           }),
-        accessKey: () =>
-          clack.password({
-            message: 'R2: Paste your Access Key ID:',
-            validate: (val) => (!val ? 'Access Key ID is required' : undefined),
-          }),
+        accessKey: () =>
+          clack.password({
+            message: 'R2: Paste your Access Key ID (create API tokens):',
+            validate: (val) => (!val ? 'Access Key ID is required' : undefined),
+          }),
         secretKey: () =>
           clack.password({
             message: 'R2: Paste your Secret Access Key:',
             validate: (val) => (!val ? 'Secret Access Key is required' : undefined),
           }),
-        publicBaseUrl: () =>
-          clack.text({
-            message: 'R2: Public Base URL (e.g., https://pub-xxx.r2.dev/your-bucket):',
-            validate: (val) => (!val ? 'Public base URL is required' : undefined),
-          }),
+        publicBaseUrl: () =>
+          clack.text({
+            message:
+              'R2: Public Base URL (Bucket > Settings > Public Development URL-Enable: e.g., https://pub-xxx.r2.dev)',
+            validate: (val) => (!val ? 'Public base URL is required' : undefined),
+          }),
       },
       { onCancel: () => handleWizardCancel('Setup cancelled.') },
     );
@@ -406,7 +417,10 @@ async function runSetupWizard(projectDir, projectName) {
     clack.note('Cloudflare R2 placeholders added to .env. Configure them later when ready.');
   }
 
-  const setupSMTP = await clack.confirm({
+  clack.note(
+    'Optional SMTP Setup:\nProvide the host, port, credentials, and from details for your email provider (e.g., Resend, Postmark) to send transactional emails immediately.',
+  );
+  const setupSMTP = await clack.confirm({
     message: 'Do you want to set up an SMTP server for emails now? (Optional)',
   });
   if (clack.isCancel(setupSMTP)) {
@@ -713,8 +727,8 @@ SMTP_FROM_NAME=
   await fs.writeFile(destination, placeholder);
 }
 
-async function ensureSupabaseAssets(projectDir, options = {}) {
-  const { required = false } = options;
+async function ensureSupabaseAssets(projectDir, options = {}) {
+  const { required = false } = options;
   const destSupabaseDir = resolve(projectDir, 'supabase');
   await fs.ensureDir(destSupabaseDir);
 
@@ -731,14 +745,14 @@ async function ensureSupabaseAssets(projectDir, options = {}) {
     }
   }
 
-  let migrationsCopied = false;
-  let configCopied = false;
+  let migrationsCopied = false;
+  let configCopied = false;
 
   const sourceConfigPath = resolve(packageSupabaseDir, 'config.toml');
   const destinationConfigPath = resolve(destSupabaseDir, 'config.toml');
   if (await fs.pathExists(sourceConfigPath)) {
-    await fs.copy(sourceConfigPath, destinationConfigPath, { overwrite: true, errorOnExist: false });
-    configCopied = true;
+    await fs.copy(sourceConfigPath, destinationConfigPath, { overwrite: true, errorOnExist: false });
+    configCopied = true;
   }
 
   const sourceMigrations = resolve(packageSupabaseDir, 'migrations');
@@ -748,11 +762,11 @@ async function ensureSupabaseAssets(projectDir, options = {}) {
     migrationsCopied = true;
   }
 
-  if (required) {
-    if (!configCopied) {
-      throw new Error(
-        `Missing supabase/config.toml in the installed @nextblock-cms/db package (checked ${packageSupabaseDir}).`,
-      );
+  if (required) {
+    if (!configCopied) {
+      throw new Error(
+        `Missing supabase/config.toml in the installed @nextblock-cms/db package (checked ${packageSupabaseDir}).`,
+      );
     }
     if (!migrationsCopied) {
       throw new Error(
@@ -761,8 +775,8 @@ async function ensureSupabaseAssets(projectDir, options = {}) {
     }
   }
 
-  return { migrationsCopied, configCopied };
-}
+  return { migrationsCopied, configCopied };
+}
 
 async function resolvePackageSupabaseDir(projectDir) {
   const triedPaths = [];
@@ -821,26 +835,26 @@ async function resolvePackageSupabaseDir(projectDir) {
   return { dir: null, triedPaths };
 }
 
-async function readSupabaseProjectRef(projectDir) {
-  const projectRefPath = resolve(projectDir, 'supabase', '.temp', 'project-ref');
-  if (await fs.pathExists(projectRefPath)) {
-    const value = (await fs.readFile(projectRefPath, 'utf8')).trim();
-    if (/^[a-z0-9]{20,}$/i.test(value)) {
-      return value;
-    }
-  }
-
-  return null;
-}
-
-async function resetSupabaseProjectRef(projectDir) {
-  const tempDir = resolve(projectDir, 'supabase', '.temp');
-  await fs.ensureDir(tempDir);
-  const projectRefPath = resolve(tempDir, 'project-ref');
-  if (await fs.pathExists(projectRefPath)) {
-    await fs.remove(projectRefPath);
-  }
-}
+async function readSupabaseProjectRef(projectDir) {
+  const projectRefPath = resolve(projectDir, 'supabase', '.temp', 'project-ref');
+  if (await fs.pathExists(projectRefPath)) {
+    const value = (await fs.readFile(projectRefPath, 'utf8')).trim();
+    if (/^[a-z0-9]{20,}$/i.test(value)) {
+      return value;
+    }
+  }
+
+  return null;
+}
+
+async function resetSupabaseProjectRef(projectDir) {
+  const tempDir = resolve(projectDir, 'supabase', '.temp');
+  await fs.ensureDir(tempDir);
+  const projectRefPath = resolve(tempDir, 'project-ref');
+  if (await fs.pathExists(projectRefPath)) {
+    await fs.remove(projectRefPath);
+  }
+}
 
 async function ensureClientComponents(projectDir) {
   const relativePaths = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-nextblock",
-  "version": "0.2.24",
+  "version": "0.2.26",
   "description": "",
   "main": "index.js",
   "bin": {

package/scripts/sync-template.js

@@ -36,16 +36,16 @@ const UI_PROXY_MODULES = [
   'ui',
 ];
 
-const IGNORED_SEGMENTS = new Set([
-  'node_modules',
-  '.git',
-  '.next',
-  'dist',
-  'tmp',
-  'coverage',
-  'backup',
-  'backups',
-]);
+const IGNORED_SEGMENTS = new Set([
+  'node_modules',
+  '.git',
+  '.next',
+  'dist',
+  'tmp',
+  'coverage',
+  'backup',
+  'backups',
+]);
 
 async function ensureTemplateSync() {
   const sourceExists = await fs.pathExists(SOURCE_DIR);
@@ -79,9 +79,10 @@ async function ensureTemplateSync() {
     },
   });
 
-  await ensureEnvExample();
-  await ensureGlobalStyles();
-  await ensureClientTranslations();
+  await ensureEnvExample();
+  await ensureTemplateGitignore();
+  await ensureGlobalStyles();
+  await ensureClientTranslations();
   await sanitizeBlockEditorImports();
   await sanitizeUiImports();
   await ensureUiProxies();
@@ -91,7 +92,7 @@ async function ensureTemplateSync() {
   console.log(chalk.green('Template sync complete.'));
 }
 
-async function ensureEnvExample() {
+async function ensureEnvExample() {
   const envTargets = [
     resolve(REPO_ROOT, '.env.example'),
     resolve(REPO_ROOT, '.env.exemple'),
@@ -117,8 +118,42 @@ NEXT_PUBLIC_URL=http://localhost:3000
 `;
 
   await fs.writeFile(destination, placeholder);
-}
-
+}
+
+async function ensureTemplateGitignore() {
+  const destination = resolve(TARGET_DIR, '.gitignore');
+  const content = `.DS_Store
+node_modules
+dist
+.next
+out
+build
+coverage
+*.log
+logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+.env
+.env.*
+.env.local
+.env.development.local
+.env.production.local
+.env.test.local
+
+.vscode
+.idea
+.swp
+*.sw?
+
+supabase/.temp
+supabase/.branches
+`;
+  await fs.outputFile(destination, content);
+}
+
 async function ensureGlobalStyles() {
   const destination = resolve(TARGET_DIR, 'app/globals.css');
 

package/templates/nextblock-template/.env.example

@@ -1,24 +0,0 @@
-NEXT_PUBLIC_URL=
-# Vercel / Supabase
-SUPABASE_PROJECT_ID=
-POSTGRES_URL=
-NEXT_PUBLIC_SUPABASE_URL=
-NEXT_PUBLIC_SUPABASE_ANON_KEY=
-SUPABASE_SERVICE_ROLE_KEY=
-
-# Cloudflare
-NEXT_PUBLIC_R2_BASE_URL=
-R2_ACCESS_KEY_ID=
-R2_SECRET_ACCESS_KEY=
-R2_BUCKET_NAME=
-R2_ACCOUNT_ID=
-
-REVALIDATE_SECRET_TOKEN=
-
-# Email SMTP Configuration
-SMTP_HOST=
-SMTP_PORT=
-SMTP_USER=
-SMTP_PASS=
-SMTP_FROM_EMAIL=
-SMTP_FROM_NAME=