@clidey/dory 0.29.0 → 0.31.0

package/CODE_OF_CONDUCT.md

@@ -1,128 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-support@clidey.com.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -1,91 +0,0 @@
-# Contributing
-
-When contributing to this repository, please first discuss the change you wish to make via issue,
-email, or any other method with the owners of this repository before making a change. 
-
-Please note we have a code of conduct, please follow it in all your interactions with the project.
-
-## Pull Request Process
-
-1. Please do not include any build artifacts unless absolutely necessary.
-2. Update the README.md with details of changes to the interface, this includes new environment 
-   variables, exposed ports, useful file locations and container parameters.
-3. You're free to choose what you want to work on - there will always be existing issues and we welcome all feature requests.
-4. If you choose to work on an issue, please check on the thread if there has been any activity - if someone's working on something, check with them and see if they'd like help, or if they're still working on it.
-5. If you choose to add a new feature, please open an issue with a title that starts with [FR] and we can have a quick discussion to see viability!
-6. When you're ready, open a pull request, add a detailed description of what you've done, and we'll be in touch! Do not hesitate to update it if you find you missed/wanted to add something.
-
-## Code of Conduct
-
-### Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-### Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-### Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-### Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-### Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at support@clidey.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-### Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org  
-[version]: http://contributor-covenant.org/version/1/4/

package/SECURITY.md

@@ -1,11 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-Currently the latest version of Dory is supported. We advise you to upgrade whenever possible to receive the latest security updates.
-
-## Reporting a Vulnerability
-
-Please use the repo's Report A Vulnerability option to report.
-
-The team will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix, and may ask for additional information or guidance.

package/bin/dory.ts

@@ -1,433 +0,0 @@
-#!/usr/bin/env node
-
-import { execSync } from 'child_process';
-import { existsSync, rmSync, mkdirSync, cpSync, readFileSync, readdirSync } from 'fs';
-import { resolve, dirname } from 'path';
-import { fileURLToPath } from 'url';
-import { createServer } from 'http';
-import sirv from 'sirv';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-// Get the root directory of the Dory package
-const getDoryRoot = (): string => {
-  // In development: bin/dory.ts -> root is parent
-  // In production: bin/dist/dory.js -> root is parent of parent
-  const isDevelopment = __dirname.endsWith('bin');
-  return isDevelopment ? resolve(__dirname, '..') : resolve(__dirname, '..', '..');
-};
-
-// Get the user's current working directory
-const getUserRoot = (): string => process.cwd();
-
-interface DoryConfig {
-  name?: string;
-  description?: string;
-  navigation?: unknown;
-  [key: string]: unknown;
-}
-
-const validateDoryConfig = (config: DoryConfig): void => {
-  if (!config || typeof config !== 'object') {
-    throw new Error('Configuration must be a valid object');
-  }
-  // Add more validation as needed
-};
-
-const commands = {
-  build: () => {
-    console.log('🐟 Dory is ready to build your docs!');
-
-    const userRoot = getUserRoot();
-    const doryRoot = getDoryRoot();
-    const doryConfigPath = resolve(userRoot, 'dory.json');
-    const tempDocsDir = resolve(doryRoot, 'docs');
-    const docsBackupDir = resolve(doryRoot, '.docs-backup');
-    const doryDistDir = resolve(doryRoot, 'dist');
-    const userDistDir = resolve(userRoot, 'dist');
-
-    // Step 1: Validate prerequisites before making any changes
-    console.log('🔍 Validating project structure...');
-
-    if (!existsSync(doryConfigPath)) {
-      console.error('❌ dory.json not found in current directory');
-      console.error(`   Looking for: ${doryConfigPath}`);
-      console.error('   Create a dory.json file to configure your documentation site');
-      process.exit(1);
-    }
-
-    // Read and validate dory.json
-    let config: DoryConfig;
-    try {
-      const configContent = readFileSync(doryConfigPath, 'utf8');
-      config = JSON.parse(configContent) as DoryConfig;
-      validateDoryConfig(config);
-      console.log(`📋 Building: ${config.name || 'Documentation'}`);
-    } catch (error) {
-      console.error('❌ Failed to parse dory.json:');
-      if (error instanceof Error) {
-        console.error(`   ${error.message}`);
-      }
-      process.exit(1);
-    }
-
-    // Check if pnpm is available
-    try {
-      execSync('pnpm --version', { stdio: 'ignore' });
-    } catch {
-      console.error('❌ pnpm is not installed');
-      console.error('   Install it with: npm install -g pnpm');
-      process.exit(1);
-    }
-
-    // Step 2: Backup existing docs directory if it exists
-    console.log('🧹 Preparing workspace...');
-    const docsExistedBefore = existsSync(tempDocsDir);
-
-    if (docsExistedBefore) {
-      console.log('💾 Backing up existing docs directory...');
-      if (existsSync(docsBackupDir)) {
-        rmSync(docsBackupDir, { recursive: true, force: true });
-      }
-      cpSync(tempDocsDir, docsBackupDir, { recursive: true, force: true });
-      rmSync(tempDocsDir, { recursive: true, force: true });
-    }
-
-    try {
-      // Step 3: Copy user files to temp docs directory
-      mkdirSync(tempDocsDir, { recursive: true });
-
-      console.log('📁 Gathering project files...');
-
-      // Define files/dirs to exclude
-      const excludeItems = new Set([
-        'node_modules',
-        'dist',
-        '.git',
-        '.github',
-        'docs',
-        '.DS_Store',
-        '.env',
-        '.env.local',
-        'pnpm-lock.yaml',
-        'package-lock.json',
-        'yarn.lock'
-      ]);
-
-      const items = readdirSync(userRoot);
-      let copiedCount = 0;
-
-      for (const item of items) {
-        if (excludeItems.has(item)) {
-          continue;
-        }
-
-        const srcPath = resolve(userRoot, item);
-        const destPath = resolve(tempDocsDir, item);
-
-        try {
-          cpSync(srcPath, destPath, { recursive: true, force: true });
-          copiedCount++;
-        } catch (error) {
-          console.warn(`⚠️  Could not copy ${item}: ${error instanceof Error ? error.message : 'unknown error'}`);
-        }
-      }
-
-      console.log(`✅ Copied ${copiedCount} items`);
-
-      // Verify critical files exist
-      const doryJsonPath = resolve(tempDocsDir, 'dory.json');
-      if (!existsSync(doryJsonPath)) {
-        console.error('❌ dory.json was not copied to docs directory');
-        console.error(`   Expected: ${doryJsonPath}`);
-        console.error('   This file is required for the build');
-        process.exit(1);
-      }
-
-      // Step 4: Run the build
-      console.log('⚡ Building documentation...');
-
-      try {
-        execSync('pnpm run build', {
-          stdio: 'inherit',
-          cwd: doryRoot,
-          env: { ...process.env }
-        });
-      } catch (error) {
-        console.error('❌ Build failed');
-        console.error('   Check the error messages above for details');
-        throw error;
-      }
-
-      // Step 5: Verify build output
-      console.log('🔍 Verifying build output...');
-
-      if (!existsSync(doryDistDir)) {
-        console.error('❌ Build completed but dist folder was not created');
-        console.error(`   Expected: ${doryDistDir}`);
-        process.exit(1);
-      }
-
-      const indexHtml = resolve(doryDistDir, 'index.html');
-      if (!existsSync(indexHtml)) {
-        console.error('❌ Build incomplete: index.html not found');
-        console.error('   The build may have failed silently');
-        process.exit(1);
-      }
-
-      // Check if dist has content
-      const distFiles = readdirSync(doryDistDir);
-      if (distFiles.length === 0) {
-        console.error('❌ Build completed but dist folder is empty');
-        process.exit(1);
-      }
-
-      console.log('🎉 Build completed successfully!');
-
-      // Step 6: Copy dist to user's directory
-      console.log('📦 Copying build output...');
-
-      // Only copy if they're different directories
-      if (doryDistDir !== userDistDir) {
-        if (existsSync(userDistDir)) {
-          rmSync(userDistDir, { recursive: true, force: true });
-        }
-        cpSync(doryDistDir, userDistDir, { recursive: true, force: true });
-      }
-
-      console.log('✨ Documentation ready in dist/');
-
-    } finally {
-      // Step 7: Always clean up temp directories and restore backup
-      console.log('🧹 Cleaning up...');
-
-      try {
-        // Remove the temporary docs directory
-        if (existsSync(tempDocsDir)) {
-          rmSync(tempDocsDir, { recursive: true, force: true });
-        }
-
-        // Restore the original docs directory if it existed before
-        if (docsExistedBefore && existsSync(docsBackupDir)) {
-          console.log('📦 Restoring original docs directory...');
-          cpSync(docsBackupDir, tempDocsDir, { recursive: true, force: true });
-          rmSync(docsBackupDir, { recursive: true, force: true });
-        }
-
-        // Only clean up doryDistDir if it's different from userDistDir
-        // (in production they're different, in dev they might be the same)
-        if (doryDistDir !== userDistDir && existsSync(doryDistDir)) {
-          rmSync(doryDistDir, { recursive: true, force: true });
-        }
-      } catch (error) {
-        console.warn('⚠️  Could not clean up temp directories');
-        // Try to restore backup even if cleanup failed
-        if (docsExistedBefore && existsSync(docsBackupDir)) {
-          console.log('🔄 Attempting to restore backup...');
-          try {
-            if (existsSync(tempDocsDir)) {
-              rmSync(tempDocsDir, { recursive: true, force: true });
-            }
-            cpSync(docsBackupDir, tempDocsDir, { recursive: true, force: true });
-            rmSync(docsBackupDir, { recursive: true, force: true });
-          } catch (restoreError) {
-            console.error('❌ Failed to restore docs backup!');
-            console.error(`   Backup location: ${docsBackupDir}`);
-            console.error('   You may need to manually restore your docs directory');
-          }
-        }
-      }
-
-      console.log('✅ Done!');
-    }
-  },
-
-  preview: () => {
-    console.log('👀 Starting docs preview...');
-
-    const userRoot = getUserRoot();
-    const distDir = resolve(userRoot, 'dist');
-    let port = parseInt(process.env.PORT || '3000', 10);
-
-    // Validate dist folder exists
-    if (!existsSync(distDir)) {
-      console.error('❌ dist folder not found');
-      console.error(`   Looking for: ${distDir}`);
-      console.error('   Run "dory build" first to generate the documentation');
-      process.exit(1);
-    }
-
-    // Check if dist has content
-    const distFiles = readdirSync(distDir);
-    if (distFiles.length === 0) {
-      console.error('❌ dist folder is empty');
-      console.error('   Run "dory build" to generate documentation');
-      process.exit(1);
-    }
-
-    const serve = sirv(distDir, {
-      dev: false,
-      single: true,
-      etag: true,
-      gzip: true,
-      brotli: true,
-    });
-
-    const server = createServer((req, res) => {
-      serve(req, res);
-    });
-
-    const tryPort = (currentPort: number): void => {
-      server.listen(currentPort)
-        .on('listening', () => {
-          console.log(`🚀 Documentation live at http://localhost:${currentPort}`);
-          console.log('   Press Ctrl+C to stop the server');
-        })
-        .on('error', (err: NodeJS.ErrnoException) => {
-          if (err.code === 'EADDRINUSE') {
-            console.log(`⚠️  Port ${currentPort} in use, trying ${currentPort + 1}...`);
-            tryPort(currentPort + 1);
-          } else {
-            console.error('❌ Failed to start server:', err.message);
-            process.exit(1);
-          }
-        });
-    };
-
-    tryPort(port);
-  },
-
-  'verify:content': async () => {
-    const args = process.argv.slice(3);
-    let content = '';
-    let fileName = '';
-
-    // Parse arguments
-    for (let i = 0; i < args.length; i++) {
-      if (args[i] === '--content' && i + 1 < args.length) {
-        content = args[i + 1];
-        break;
-      } else if (args[i] === '--file' && i + 1 < args.length) {
-        const filePath = resolve(getUserRoot(), args[i + 1]);
-        if (!existsSync(filePath)) {
-          console.error(`❌ File not found: ${filePath}`);
-          process.exit(1);
-        }
-        content = readFileSync(filePath, 'utf8');
-        fileName = filePath;
-        break;
-      }
-    }
-
-    if (!content) {
-      console.error('❌ --content or --file argument is required');
-      console.log('Usage:');
-      console.log('  dory verify:content --content "<mdx-content>"');
-      console.log('  dory verify:content --file <path-to-mdx-file>');
-      process.exit(1);
-    }
-
-    try {
-      const doryRoot = getDoryRoot();
-      const processorPath = resolve(doryRoot, 'src', 'mdx', 'processor.ts');
-
-      if (!existsSync(processorPath)) {
-        console.error('❌ MDX processor not found');
-        console.error('   This feature requires Dory source files');
-        process.exit(1);
-      }
-
-      // Use the shared MDX processor that matches the main build exactly
-      const { verifyMdxContent } = await import(processorPath);
-      const result = await verifyMdxContent(content, fileName);
-
-      if (!result.valid) {
-        throw result.error;
-      }
-
-      // Silent success - no output means no errors
-
-    } catch (error) {
-      console.error('❌ MDX compilation failed:');
-      if (error instanceof Error) {
-        console.error(`   ${error.message}`);
-
-        // Provide more detailed error information if available
-        const errorWithPosition = error as Error & { line?: number; column?: number; source?: string };
-        if (errorWithPosition.line !== undefined && errorWithPosition.column !== undefined) {
-          console.error(`   at line ${errorWithPosition.line}, column ${errorWithPosition.column}`);
-        }
-        if (errorWithPosition.source) {
-          console.error('   Source:', errorWithPosition.source);
-        }
-      }
-
-      process.exit(1);
-    }
-  },
-
-  help: () => {
-    console.log(`
-🐟 Dory CLI - Documentation Builder
-
-Usage:
-  dory <command> [options]
-
-Commands:
-  build            Build your documentation site
-                   Requirements: dory.json in current directory
-                   Output: dist/ folder with static site
-
-  preview          Preview built documentation
-                   Requirements: dist/ folder (run build first)
-                   Starts local server on port 3000
-
-  verify:content   Verify MDX content compilation
-                   Options: --content "<mdx>" or --file <path>
-                   Silent on success, shows errors on failure
-
-  help             Show this help message
-
-Examples:
-  dory build
-  dory preview
-  dory verify:content --content "# Hello World"
-  dory verify:content --file docs/intro.mdx
-
-For more information, visit: https://github.com/clidey/dory
-`);
-  }
-};
-
-type CommandName = keyof typeof commands;
-
-// Parse command line arguments
-const command = process.argv[2];
-
-async function runCommand(): Promise<void> {
-  if (!command || command === 'help' || command === '--help' || command === '-h') {
-    commands.help();
-    return;
-  }
-
-  if (command in commands) {
-    await commands[command as CommandName]();
-  } else {
-    console.error(`❌ Unknown command: ${command}`);
-    console.log('   Run "dory help" for available commands');
-    process.exit(1);
-  }
-}
-
-runCommand().catch((error: unknown) => {
-  console.error('❌ Command failed');
-  if (error instanceof Error) {
-    console.error(`   ${error.message}`);
-    if (error.stack && process.env.DEBUG) {
-      console.error('\nStack trace:');
-      console.error(error.stack);
-    }
-  }
-  process.exit(1);
-});