create-vault-cms 1.0.7 → 1.0.9

package/README.md

@@ -1,42 +1,37 @@
 # Vault CMS
 
-Use [Obsidian](https://obsidian.md) as a content management system for your [Astro](https://astro.build) website.
+The open-source headless content management system that turns [Obsidian](https://obsidian.md) into a publishing platform for your [Astro](https://astro.build) website.
 
 ![Vault CMS cover with Obsidian and Astro logos at the bottom.](https://github.com/user-attachments/assets/fb5d8368-71dd-4bf8-8851-36ada6d4f530)
 
+## Features 
+
+- **Auto-detection and automation**: Understands your content structure and lets you focus on writing.
+- **CMS-like homepage**: See your content in a visual grid and perform bulk actions.
+- **Preconfigured**: Optimized settings, hotkeys, and plugins for the Astro workflow.
+- **Headless and flexible**: Just Markdown files and a workspace ready to be customized by you.
+- **Compatability**: Works with almost any Astro theme.
+
 ## Quick Start
 
-The fastest way to install Vault CMS into your Astro project is via the CLI:
+The fastest way to install Vault CMS into your Astro project is via the CLI at your project root:
 
 ```bash
 pnpm create vault-cms
 ```
 
-*Follow the prompts to install into `src/content` or your desired directory.*
+*Follow the prompts to install into `src/content` or your desired sub-directory.*
 
-## Documentation
+### Manual Installation
 
-For full installation guides, plugin details, and customization options, read the [Vault CMS documentation](https://docs.vaultcms.org).
+If you prefer to install manually, you can download the latest version of Vault CMS and place it directly into your Astro project.
 
-## Features 
+1. **Download the source**: [Clone this repository](https://github.com/davidvkimball/vault-cms) or [download the ZIP archive](https://github.com/davidvkimball/vault-cms/archive/refs/heads/master.zip).
+2. **Locate your content directory**: In most Astro projects, this is `src/content`.
+3. **Move the files**: Copy the `.obsidian` and `_bases` folders (and `_GUIDE.md`) from the Vault CMS source into your content directory.
+4. **Open in Obsidian**: Open the content directory as a new vault in Obsidian.
 
-- Easy integration into Astro website projects
-- **Auto-detection** of your Astro theme and content structure
-- Preconfigured plugins, hotkeys and settings optimized for Astro workflows
-- CMS-like homepage using Obsidian Bases
-- Works with any Astro theme by automatically detecting content types and frontmatter properties
-- Optional instant-publish option via the Git plugin
-
-![Vault CMS Showcase.](https://github.com/user-attachments/assets/0d1ea89e-9d6b-40b1-944d-cfe6143e222e)
-
-## Video Guide
-
-📺 [Video Guide](https://youtu.be/dSm8aLPdVz0)
-
-> [!NOTE]
-> To see Vault CMS combined with an Astro site specifically designed with it in mind, check out my theme [Astro Modular](https://github.com/davidvkimball/astro-modular).
-
-## Presets
+### Presets
 
 If you are using a supported theme like **Starlight**, **Slate**, or **Chiri**, you can use a preconfigured preset:
 
@@ -45,3 +40,14 @@ pnpm create vault-cms -- --template starlight
 ```
 
 See all available presets at the [Presets Repo](https://github.com/davidvkimball/vault-cms-presets).
+
+## Deep Dive
+
+- **Documentation**: [docs.vaultcms.org](https://docs.vaultcms.org)
+- **Video Guide**: [Set Up Guide on YouTube](https://www.youtube.com/watch?v=3zeqJ5tqmaQ)
+- **Community**: [Join the Discord](https://discord.gg/gyrNHAwHK8)
+
+> [!NOTE]
+> To see Vault CMS combined with an Astro site specifically designed with it in mind, check out the [Astro Modular](https://github.com/davidvkimball/astro-modular) theme.
+
+![Vault CMS Showcase.](https://github.com/user-attachments/assets/0d1ea89e-9d6b-40b1-944d-cfe6143e222e)

package/_GUIDE.md

@@ -0,0 +1,26 @@
+# Welcome to Vault CMS
+
+## Run the setup wizard
+
+If you just installed Vault CMS, the most important step is running the wizard. It will detect your Astro theme and configure your content types automatically.
+
+> [!TIP]
+> **Command**: Press `Ctrl/Cmd + P` and search for **"Vault CMS: Open Wizard"** if you closed it.
+
+## The CMS home base
+
+We use a custom Obsidian bases view to give you a bird's-eye view of your content.
+
+> [!NOTE]
+> Click the **Home** icon in your tab bar or open the `_bases/Home.base` file to see your content in a grid view.
+
+## Key workflows
+
+- **Writing**: hust use `Ctrl/Cmd + N` to create a new file using your default content type and start writing.
+- **Publishing**: use the **Git: Push** command (or click the up arrow in the status bar) to send your changes live to your Astro site.
+
+### Need help?
+
+- **Documentation**: [docs.vaultcms.org](https://docs.vaultcms.org)
+- **Community**: [join the Discord](https://discord.gg/gyrNHAwHK8)
+- **Video Guide**: [set up guide on YouTube](https://www.youtube.com/watch?v=3zeqJ5tqmaQ)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-vault-cms",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "Installer for Vault CMS",
   "main": "src/cli.js",
   "bin": {
@@ -9,6 +9,7 @@
   "files": [
     "src",
     "README.md",
+    "_GUIDE.md",
     "LICENSE"
   ],
   "scripts": {
@@ -32,4 +33,4 @@
     "fs-extra": "^11.3.3",
     "inquirer": "^8.2.7"
   }
-}
+}

package/src/cli.js

@@ -24,7 +24,7 @@ program
       console.log('🚀 Initializing Vault CMS Installer...');
 
       const availableTemplates = await fetchTemplates();
-      
+
       let template = options.template;
       let targetPath = target;
 
@@ -67,11 +67,12 @@ program
       const targetDir = path.resolve(targetPath);
       const tempZip = path.join(targetDir, 'vault-cms-temp.zip');
       const extractDir = path.join(targetDir, '.vault-cms-temp-extract');
-      
+
       const repoName = template ? 'vault-cms-presets' : 'vault-cms';
       const zipUrl = `https://github.com/davidvkimball/${repoName}/archive/refs/heads/master.zip`;
 
       console.log(`\n🚀 Installing Vault CMS${template ? ` (template: ${template})` : ''}...`);
+      console.log(`  📍 Target directory: ${targetDir}`);
 
       await fs.ensureDir(targetDir);
 
@@ -82,7 +83,13 @@ program
       const zip = new AdmZip(tempZip);
       zip.extractAllTo(extractDir, true);
 
-      const folders = await fs.readdir(extractDir);
+      const items = await fs.readdir(extractDir);
+      const folders = items.filter(item => fs.statSync(path.join(extractDir, item)).isDirectory());
+
+      if (folders.length === 0) {
+        throw new Error('Could not find content in the downloaded archive.');
+      }
+
       const innerFolder = path.join(extractDir, folders[0]);
       const sourcePath = template ? path.join(innerFolder, template) : innerFolder;
 
@@ -90,11 +97,11 @@ program
         throw new Error(`Template "${template}" not found in presets repository.`);
       }
 
-      const toKeep = ['_bases', '.obsidian', 'README.md'];
+      const toKeep = ['_bases', '.obsidian', '_GUIDE.md'];
       for (const item of toKeep) {
         const src = path.join(sourcePath, item);
         const dest = path.join(targetDir, item);
-        
+
         if (await fs.pathExists(src)) {
           await fs.copy(src, dest, { overwrite: true });
           console.log(`  ✓ Added ${item}`);
@@ -105,21 +112,30 @@ program
       const projectRoot = await findProjectRoot(targetDir);
       const gitignorePath = path.join(projectRoot, '.gitignore');
       const ignores = '\n# Vault CMS / Obsidian\n.obsidian/workspace.json\n.obsidian/workspace-mobile.json\n.ref/\n';
-      
+
+      const isExternalRoot = projectRoot !== targetDir && !targetDir.startsWith(projectRoot);
+
       if (await fs.pathExists(gitignorePath)) {
         const content = await fs.readFile(gitignorePath, 'utf8');
         if (!content.includes('.obsidian/workspace.json')) {
           await fs.appendFile(gitignorePath, ignores);
           console.log(`  ✓ Updated .gitignore at ${path.relative(process.cwd(), gitignorePath)}`);
         }
-      } else {
+      } else if (!isExternalRoot) {
         await fs.writeFile(gitignorePath, ignores.trim() + '\n');
         console.log(`  ✓ Created .gitignore at ${path.relative(process.cwd(), gitignorePath)}`);
+      } else {
+        console.log(`  ⚠️  Skipped .gitignore (could not find a safe project root)`);
       }
 
       await fs.remove(tempZip);
       await fs.remove(extractDir);
 
+      if (projectRoot === targetDir) {
+        console.log('\n  ⚠️  Note: No Astro project or package.json found in parent directories.');
+        console.log('     Installation completed, but you may need to move these files into your content folder manually.');
+      }
+
       console.log('\n✨ Vault CMS is ready!');
       process.exit(0);
     } catch (err) {
@@ -129,14 +145,20 @@ program
   });
 
 async function findProjectRoot(startDir) {
-    let current = startDir;
-    while (current !== path.parse(current).root) {
-        const hasPkg = await fs.pathExists(path.join(current, 'package.json'));
-        const hasAstro = await fs.pathExists(path.join(current, 'astro.config.mjs')) || await fs.pathExists(path.join(current, 'astro.config.ts'));
-        if (hasPkg || hasAstro) return current;
-        current = path.dirname(current);
-    }
-    return startDir; // Fallback to target dir
+  let current = startDir;
+  // Look up to 6 levels up for a project root (Astro config, package.json, or .git)
+  let depth = 0;
+  while (current !== path.parse(current).root && depth < 6) {
+    const hasPkg = await fs.pathExists(path.join(current, 'package.json'));
+    const hasAstro = await fs.pathExists(path.join(current, 'astro.config.mjs')) || await fs.pathExists(path.join(current, 'astro.config.ts'));
+    const hasGit = await fs.pathExists(path.join(current, '.git'));
+
+    if (hasPkg || hasAstro || hasGit) return current;
+
+    current = path.dirname(current);
+    depth++;
+  }
+  return startDir; // Fallback to target dir
 }
 
 function downloadFile(url, dest) {
@@ -172,7 +194,7 @@ function fetchTemplates() {
             .map(item => item.name);
           resolve(dirs);
         } catch (e) {
-          resolve(['starlight', 'slate', 'chiri']); 
+          resolve(['starlight', 'slate', 'chiri']);
         }
       });
     }).on('error', () => resolve(['starlight', 'slate', 'chiri']));