create-vault-cms 1.0.6 → 1.0.8

package/README.md

@@ -1,91 +1,47 @@
-# Vault CMS
-
-Use [Obsidian](https://obsidian.md) as a content management system 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)
-
-## Video Guide
-
-📺 [Video Guide](https://youtu.be/dSm8aLPdVz0)
-
-## Features 
-
-- 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)
-
-> [!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).
-
-## Installation Guide
-
-The fastest way to install Vault CMS into your Astro project is via the CLI:
-
-### Standard Installation
-Run this in your Astro project root:
-
-```bash
-# Using pnpm (recommended)
-pnpm create vault-cms
-
-# Using npm
-npm create vault-cms
-
-# Using yarn
-yarn create vault-cms
-```
-
-When prompted for the location, the default is `src/content`.
-
-### Using a Preset Template
-If you are using a supported theme like **Starlight**, **Slate**, or **Chiri**, you can use a preconfigured preset from the [Presets](https://github.com/davidvkimball/vault-cms-presets) repository:
-
-```bash
-# Using pnpm
-pnpm create vault-cms -- --template starlight
-
-# Using npm
-npm create vault-cms -- --template starlight
-
-# Using yarn
-yarn create vault-cms --template starlight
-```
-*(Replace `starlight` with `slate` or `chiri` as needed).*
-
----
-
-This will automatically:
-1. Copy the necessary `_bases` and `.obsidian` configuration folders.
-2. Setup a `README.md` for your vault.
-3. Update your `.gitignore` with the recommended Obsidian excludes.
-
-### Manual Installation
-
-If you prefer to install manually:
-1. Download the [latest release ZIP](https://github.com/davidvkimball/vault-cms/archive/refs/heads/master.zip).
-2. Copy the `_bases` and `.obsidian` folders into your Astro project (e.g., in `src/content`).
-3. Open Obsidian and select "Open folder as vault", then select the folder containing the `.obsidian` directory.
-
-## How Auto-Detection Works
-
-Vault CMS automatically detects and configures itself based on your Astro project:
-
-- **Project Detection**: Automatically finds your Astro project by locating `astro.config.mjs`, `astro.config.ts`, or other Astro config files.
-- **Content Type Detection**: Scans your content folders (like `posts`, `pages`, `docs`, etc.) and automatically identifies them as content types.
-- **Frontmatter Analysis**: Analyzes existing content files to detect frontmatter properties (title, date, description, etc.) and configures the plugin accordingly.
-
-When you first open the vault, a setup wizard will guide you through the configuration process.
-
-### Recommended .gitignore
-
-If you are not using the CLI, add the following to your Astro project's `.gitignore` file:
-```
-# Obsidian
-.obsidian/workspace.json
-.obsidian/workspace-mobile.json
-```
+# Vault CMS
+
+Use [Obsidian](https://obsidian.md) as a content management system 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)
+
+## Quick Start
+
+The fastest way to install Vault CMS into your Astro project is via the CLI:
+
+```bash
+pnpm create vault-cms
+```
+
+*Follow the prompts to install into `src/content` or your desired directory.*
+
+## Documentation
+
+For full installation guides, plugin details, and customization options, read the [Vault CMS documentation](https://docs.vaultcms.org).
+
+## Features 
+
+- 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
+
+If you are using a supported theme like **Starlight**, **Slate**, or **Chiri**, you can use a preconfigured preset:
+
+```bash
+pnpm create vault-cms -- --template starlight
+```
+
+See all available presets at the [Presets Repo](https://github.com/davidvkimball/vault-cms-presets).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-vault-cms",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Installer for Vault CMS",
   "main": "src/cli.js",
   "bin": {
@@ -32,4 +32,4 @@
     "fs-extra": "^11.3.3",
     "inquirer": "^8.2.7"
   }
-}
+}

package/src/cli.js

@@ -1,173 +1,204 @@
-#!/usr/bin/env node
-
-const { Command } = require('commander');
-const fs = require('fs-extra');
-const path = require('path');
-const https = require('https');
-const AdmZip = require('adm-zip');
-const inquirer = require('inquirer');
-
-const pkg = require('../package.json');
-
-const program = new Command();
-
-program
-  .name('create-vault-cms')
-  .description('Official installer for Vault CMS')
-  .version(pkg.version);
-
-program
-  .argument('[target]', 'target directory')
-  .option('-t, --template <name>', 'template to use (from vault-cms-presets)')
-  .action(async (target, options) => {
-    try {
-      console.log('🚀 Initializing Vault CMS Installer...');
-
-      // 1. Fetch available templates dynamically
-      const availableTemplates = await fetchTemplates();
-      
-      let template = options.template;
-      let targetPath = target;
-
-      // Smart detection for misplaced arguments
-      if (targetPath && availableTemplates.includes(targetPath.toLowerCase()) && !template) {
-        template = targetPath.toLowerCase();
-        targetPath = null;
-      }
-
-      // 2. If no template flag, ask if they want one
-      if (!template) {
-        const { useTemplate } = await inquirer.prompt([{
-          type: 'confirm',
-          name: 'useTemplate',
-          message: 'Would you like to use a preset template (e.g. Starlight, Slate)?',
-          default: false
-        }]);
-
-        if (useTemplate) {
-          const { selectedTemplate } = await inquirer.prompt([{
-            type: 'list',
-            name: 'selectedTemplate',
-            message: 'Select a template:',
-            choices: availableTemplates
-          }]);
-          template = selectedTemplate;
-        }
-      }
-
-      // 3. Prompt for path if not provided
-      if (!targetPath) {
-        const answers = await inquirer.prompt([
-          {
-            type: 'input',
-            name: 'path',
-            message: 'Where should we install Vault CMS?',
-            default: 'src/content',
-          }
-        ]);
-        targetPath = answers.path;
-      }
-
-      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})` : ''}...`);
-
-      await fs.ensureDir(targetDir);
-
-      console.log('  📦 Downloading archive...');
-      await downloadFile(zipUrl, tempZip);
-
-      console.log('  📂 Extracting files...');
-      const zip = new AdmZip(tempZip);
-      zip.extractAllTo(extractDir, true);
-
-      const folders = await fs.readdir(extractDir);
-      const innerFolder = path.join(extractDir, folders[0]);
-      const sourcePath = template ? path.join(innerFolder, template) : innerFolder;
-
-      if (!(await fs.pathExists(sourcePath))) {
-        throw new Error(`Template "${template}" not found in presets repository.`);
-      }
-
-      const toKeep = ['_bases', '.obsidian', 'README.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}`);
-        }
-      }
-
-      const gitignorePath = path.join(targetDir, '.gitignore');
-      const ignores = '\n# Vault CMS / Obsidian\n.obsidian/workspace.json\n.obsidian/workspace-mobile.json\n.ref/\n';
-      
-      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');
-        }
-      } else {
-        await fs.writeFile(gitignorePath, ignores.trim() + '\n');
-        console.log('  ✓ Created .gitignore');
-      }
-
-      await fs.remove(tempZip);
-      await fs.remove(extractDir);
-
-      console.log('\n✨ Vault CMS is ready!');
-      process.exit(0);
-    } catch (err) {
-      console.error('\n❌ Installation failed:', err.message);
-      process.exit(1);
-    }
-  });
-
-function downloadFile(url, dest) {
-  return new Promise((resolve, reject) => {
-    https.get(url, { headers: { 'User-Agent': 'vault-cms-installer' } }, (res) => {
-      if (res.statusCode === 301 || res.statusCode === 302) {
-        return downloadFile(res.headers.location, dest).then(resolve).catch(reject);
-      }
-      if (res.statusCode !== 200) {
-        return reject(new Error(`Failed to download: ${res.statusCode}`));
-      }
-      const file = fs.createWriteStream(dest);
-      res.pipe(file);
-      file.on('finish', () => {
-        file.close();
-        resolve();
-      });
-    }).on('error', reject);
-  });
-}
-
-function fetchTemplates() {
-  return new Promise((resolve) => {
-    const url = 'https://api.github.com/repos/davidvkimball/vault-cms-presets/contents';
-    https.get(url, { headers: { 'User-Agent': 'vault-cms-installer' } }, (res) => {
-      let data = '';
-      res.on('data', (chunk) => data += chunk);
-      res.on('end', () => {
-        try {
-          const contents = JSON.parse(data);
-          const dirs = contents
-            .filter(item => item.type === 'dir' && !item.name.startsWith('.'))
-            .map(item => item.name);
-          resolve(dirs);
-        } catch (e) {
-          resolve(['starlight', 'slate', 'chiri']); // Fallback
-        }
-      });
-    }).on('error', () => resolve(['starlight', 'slate', 'chiri']));
-  });
-}
-
-program.parse();
+#!/usr/bin/env node
+
+const { Command } = require('commander');
+const fs = require('fs-extra');
+const path = require('path');
+const https = require('https');
+const AdmZip = require('adm-zip');
+const inquirer = require('inquirer');
+
+const pkg = require('../package.json');
+
+const program = new Command();
+
+program
+  .name('create-vault-cms')
+  .description('Official installer for Vault CMS')
+  .version(pkg.version);
+
+program
+  .argument('[target]', 'target directory')
+  .option('-t, --template <name>', 'template to use (from vault-cms-presets)')
+  .action(async (target, options) => {
+    try {
+      console.log('🚀 Initializing Vault CMS Installer...');
+
+      const availableTemplates = await fetchTemplates();
+
+      let template = options.template;
+      let targetPath = target;
+
+      if (targetPath && availableTemplates.includes(targetPath.toLowerCase()) && !template) {
+        template = targetPath.toLowerCase();
+        targetPath = null;
+      }
+
+      if (!template) {
+        const { useTemplate } = await inquirer.prompt([{
+          type: 'confirm',
+          name: 'useTemplate',
+          message: 'Would you like to use a preset template (e.g. Starlight, Slate)?',
+          default: false
+        }]);
+
+        if (useTemplate) {
+          const { selectedTemplate } = await inquirer.prompt([{
+            type: 'list',
+            name: 'selectedTemplate',
+            message: 'Select a template:',
+            choices: availableTemplates
+          }]);
+          template = selectedTemplate;
+        }
+      }
+
+      if (!targetPath) {
+        const answers = await inquirer.prompt([
+          {
+            type: 'input',
+            name: 'path',
+            message: 'Where should we install Vault CMS?',
+            default: 'src/content',
+          }
+        ]);
+        targetPath = answers.path;
+      }
+
+      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);
+
+      console.log('  📦 Downloading archive...');
+      await downloadFile(zipUrl, tempZip);
+
+      console.log('  📂 Extracting files...');
+      const zip = new AdmZip(tempZip);
+      zip.extractAllTo(extractDir, true);
+
+      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;
+
+      if (!(await fs.pathExists(sourcePath))) {
+        throw new Error(`Template "${template}" not found in presets repository.`);
+      }
+
+      const toKeep = ['_bases', '.obsidian', 'README.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}`);
+        }
+      }
+
+      // Smart .gitignore logic: Look for project root
+      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 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) {
+      console.error('\n❌ Installation failed:', err.message);
+      process.exit(1);
+    }
+  });
+
+async function findProjectRoot(startDir) {
+  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) {
+  return new Promise((resolve, reject) => {
+    https.get(url, { headers: { 'User-Agent': 'vault-cms-installer' } }, (res) => {
+      if (res.statusCode === 301 || res.statusCode === 302) {
+        return downloadFile(res.headers.location, dest).then(resolve).catch(reject);
+      }
+      if (res.statusCode !== 200) {
+        return reject(new Error(`Failed to download: ${res.statusCode}`));
+      }
+      const file = fs.createWriteStream(dest);
+      res.pipe(file);
+      file.on('finish', () => {
+        file.close();
+        resolve();
+      });
+    }).on('error', reject);
+  });
+}
+
+function fetchTemplates() {
+  return new Promise((resolve) => {
+    const url = 'https://api.github.com/repos/davidvkimball/vault-cms-presets/contents';
+    https.get(url, { headers: { 'User-Agent': 'vault-cms-installer' } }, (res) => {
+      let data = '';
+      res.on('data', (chunk) => data += chunk);
+      res.on('end', () => {
+        try {
+          const contents = JSON.parse(data);
+          const dirs = contents
+            .filter(item => item.type === 'dir' && !item.name.startsWith('.'))
+            .map(item => item.name);
+          resolve(dirs);
+        } catch (e) {
+          resolve(['starlight', 'slate', 'chiri']);
+        }
+      });
+    }).on('error', () => resolve(['starlight', 'slate', 'chiri']));
+  });
+}
+
+program.parse();