@girardmedia/bootspring 1.2.0 → 2.0.3

package/generators/templates/content.template.js

@@ -0,0 +1,819 @@
+/**
+ * Content Template Generator
+ *
+ * Generates content files for blogs, documentation, release notes, etc.
+ * Supports multiple content types and output formats.
+ *
+ * @package bootspring
+ * @module generators/templates/content
+ */
+
+const CONTENT_TYPES = {
+  'blog-post': {
+    name: 'Blog Post',
+    extension: '.md',
+    directory: 'content/blog'
+  },
+  'release-notes': {
+    name: 'Release Notes',
+    extension: '.md',
+    directory: 'content/releases'
+  },
+  'documentation': {
+    name: 'Documentation Page',
+    extension: '.mdx',
+    directory: 'content/docs'
+  },
+  'changelog': {
+    name: 'Changelog Entry',
+    extension: '.md',
+    directory: '.'
+  },
+  'readme': {
+    name: 'README',
+    extension: '.md',
+    directory: '.'
+  },
+  'landing-page': {
+    name: 'Landing Page Copy',
+    extension: '.md',
+    directory: 'content/marketing'
+  },
+  'email-template': {
+    name: 'Email Template',
+    extension: '.html',
+    directory: 'templates/email'
+  },
+  'social-post': {
+    name: 'Social Media Post',
+    extension: '.md',
+    directory: 'content/social'
+  },
+  'api-doc': {
+    name: 'API Documentation',
+    extension: '.mdx',
+    directory: 'content/docs/api'
+  },
+  'tutorial': {
+    name: 'Tutorial',
+    extension: '.mdx',
+    directory: 'content/docs/tutorials'
+  }
+};
+
+/**
+ * Generate blog post template
+ */
+function generateBlogPost(options = {}) {
+  const {
+    title = 'Untitled Post',
+    description = '',
+    author = 'Team',
+    tags = [],
+    date = new Date().toISOString().split('T')[0]
+  } = options;
+
+  return `---
+title: "${title}"
+description: "${description}"
+date: "${date}"
+author: "${author}"
+tags: [${tags.map(t => `"${t}"`).join(', ')}]
+image: "/images/blog/${title.toLowerCase().replace(/[^a-z0-9]+/g, '-')}.png"
+---
+
+## Introduction
+
+[Hook - Why should the reader care about this topic?]
+
+[Problem statement - What pain point are we addressing?]
+
+## What You'll Learn
+
+- Point 1
+- Point 2
+- Point 3
+
+## Main Content
+
+### Section 1
+
+[Content]
+
+\`\`\`typescript
+// Code example
+\`\`\`
+
+### Section 2
+
+[Content]
+
+### Section 3
+
+[Content]
+
+## Key Takeaways
+
+1. **Takeaway 1** - Brief explanation
+2. **Takeaway 2** - Brief explanation
+3. **Takeaway 3** - Brief explanation
+
+## Next Steps
+
+[Call to action - What should the reader do next?]
+
+---
+
+*Have questions? Join our [Discord community](https://discord.gg/bootspring) or reach out on [Twitter](https://twitter.com/bootspring).*
+`;
+}
+
+/**
+ * Generate release notes template
+ */
+function generateReleaseNotes(options = {}) {
+  const {
+    version = '1.0.0',
+    date = new Date().toISOString().split('T')[0],
+    codename = ''
+  } = options;
+
+  const codenameSection = codename ? ` "${codename}"` : '';
+
+  return `---
+title: "v${version} Release Notes"
+version: "${version}"
+date: "${date}"
+---
+
+# v${version}${codenameSection}
+
+> Released on ${date}
+
+## Highlights
+
+Brief summary of the most important changes in this release.
+
+- **Feature 1** - What it does and why it matters
+- **Feature 2** - What it does and why it matters
+- **Feature 3** - What it does and why it matters
+
+## What's New
+
+### Feature Name
+
+Description of the feature and the value it provides to users.
+
+**How to use it:**
+
+\`\`\`bash
+# Example command or code
+bootspring new-command
+\`\`\`
+
+### Another Feature
+
+Description of another feature.
+
+## Improvements
+
+- Improved X by doing Y
+- Enhanced performance of Z
+- Better error messages for W
+
+## Bug Fixes
+
+- Fixed issue where X caused Y (#123)
+- Resolved crash when Z happened (#124)
+- Corrected display of W in certain conditions
+
+## Breaking Changes
+
+> **Important:** Please review these changes before upgrading.
+
+### Change Name
+
+**What changed:** Description of the breaking change.
+
+**Migration steps:**
+1. Step 1
+2. Step 2
+3. Step 3
+
+**Before:**
+\`\`\`javascript
+// Old code
+\`\`\`
+
+**After:**
+\`\`\`javascript
+// New code
+\`\`\`
+
+## Deprecations
+
+| Deprecated | Use Instead | Removal Version |
+|------------|-------------|-----------------|
+| \`oldMethod()\` | \`newMethod()\` | v${parseInt(version) + 1}.0.0 |
+
+## Upgrade Guide
+
+### From v${(parseFloat(version) - 0.1).toFixed(1)}.x
+
+\`\`\`bash
+# Upgrade command
+npm update @bootspring/cli
+\`\`\`
+
+### Compatibility
+
+| Dependency | Minimum Version |
+|------------|-----------------|
+| Node.js | 18.0.0 |
+| npm | 9.0.0 |
+
+## Contributors
+
+Thanks to all contributors who made this release possible!
+
+---
+
+[Full Changelog](https://github.com/bootspring/bootspring/compare/v${(parseFloat(version) - 0.1).toFixed(1)}...v${version})
+`;
+}
+
+/**
+ * Generate documentation page template
+ */
+function generateDocumentation(options = {}) {
+  const {
+    title = 'Documentation',
+    description = '',
+    category = 'guides',
+    order = 1
+  } = options;
+
+  return `---
+title: "${title}"
+description: "${description}"
+category: "${category}"
+order: ${order}
+---
+
+# ${title}
+
+${description || 'Introduction to this topic.'}
+
+## Prerequisites
+
+Before you begin, make sure you have:
+
+- [ ] Requirement 1
+- [ ] Requirement 2
+- [ ] Requirement 3
+
+## Overview
+
+[Brief overview of what this guide covers]
+
+## Quick Start
+
+\`\`\`bash
+# Get started quickly
+npx bootspring command
+\`\`\`
+
+## Step-by-Step Guide
+
+### Step 1: Setup
+
+[Instructions]
+
+\`\`\`typescript
+// Code example
+\`\`\`
+
+### Step 2: Configuration
+
+[Instructions]
+
+### Step 3: Implementation
+
+[Instructions]
+
+## Examples
+
+### Basic Example
+
+\`\`\`typescript
+// Basic usage
+\`\`\`
+
+### Advanced Example
+
+\`\`\`typescript
+// Advanced usage
+\`\`\`
+
+## Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| \`option1\` | string | \`"default"\` | Description |
+| \`option2\` | boolean | \`false\` | Description |
+
+## Troubleshooting
+
+### Common Issue 1
+
+**Problem:** Description of the problem.
+
+**Solution:** How to fix it.
+
+### Common Issue 2
+
+**Problem:** Description of the problem.
+
+**Solution:** How to fix it.
+
+## Related Resources
+
+- [Related Guide 1](/docs/related-1)
+- [Related Guide 2](/docs/related-2)
+- [API Reference](/docs/api)
+
+## Next Steps
+
+- [ ] Action item 1
+- [ ] Action item 2
+
+---
+
+<Callout type="info">
+Need help? Join our [Discord community](https://discord.gg/bootspring) for support.
+</Callout>
+`;
+}
+
+/**
+ * Generate README template
+ */
+function generateReadme(options = {}) {
+  const {
+    name = 'Project',
+    description = 'A project built with Bootspring',
+    author = '',
+    license = 'MIT',
+    features = [],
+    tech = []
+  } = options;
+
+  const featuresSection = features.length > 0
+    ? features.map(f => `- **${f.name}** - ${f.description}`).join('\n')
+    : '- Feature 1\n- Feature 2\n- Feature 3';
+
+  const techSection = tech.length > 0
+    ? tech.map(t => `- ${t}`).join('\n')
+    : '- Next.js 14\n- TypeScript\n- Tailwind CSS\n- Prisma';
+
+  return `# ${name}
+
+> ${description}
+
+[![npm version](https://img.shields.io/npm/v/${name.toLowerCase()}.svg)](https://www.npmjs.com/package/${name.toLowerCase()})
+[![License: ${license}](https://img.shields.io/badge/License-${license}-blue.svg)](LICENSE)
+
+## Features
+
+${featuresSection}
+
+## Tech Stack
+
+${techSection}
+
+## Quick Start
+
+\`\`\`bash
+# Clone the repository
+git clone https://github.com/${author || 'username'}/${name.toLowerCase()}.git
+
+# Install dependencies
+npm install
+
+# Start development server
+npm run dev
+\`\`\`
+
+## Installation
+
+\`\`\`bash
+npm install ${name.toLowerCase()}
+\`\`\`
+
+## Usage
+
+\`\`\`typescript
+import { feature } from '${name.toLowerCase()}';
+
+// Basic usage example
+feature.doSomething();
+\`\`\`
+
+## Configuration
+
+Create a \`config.js\` file in your project root:
+
+\`\`\`javascript
+module.exports = {
+  // Configuration options
+};
+\`\`\`
+
+## Documentation
+
+[Full documentation](https://docs.example.com)
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) before submitting a PR.
+
+## License
+
+${license} - see the [LICENSE](LICENSE) file for details.
+
+---
+
+Built with [Bootspring](https://bootspring.com)
+`;
+}
+
+/**
+ * Generate changelog entry template
+ */
+function generateChangelog(options = {}) {
+  const {
+    version = '1.0.0',
+    date = new Date().toISOString().split('T')[0],
+    added = [],
+    changed = [],
+    deprecated = [],
+    removed = [],
+    fixed = [],
+    security = []
+  } = options;
+
+  const sections = [];
+
+  sections.push(`## [${version}] - ${date}`);
+  sections.push('');
+
+  if (added.length > 0) {
+    sections.push('### Added');
+    added.forEach(item => sections.push(`- ${item}`));
+    sections.push('');
+  }
+
+  if (changed.length > 0) {
+    sections.push('### Changed');
+    changed.forEach(item => sections.push(`- ${item}`));
+    sections.push('');
+  }
+
+  if (deprecated.length > 0) {
+    sections.push('### Deprecated');
+    deprecated.forEach(item => sections.push(`- ${item}`));
+    sections.push('');
+  }
+
+  if (removed.length > 0) {
+    sections.push('### Removed');
+    removed.forEach(item => sections.push(`- ${item}`));
+    sections.push('');
+  }
+
+  if (fixed.length > 0) {
+    sections.push('### Fixed');
+    fixed.forEach(item => sections.push(`- ${item}`));
+    sections.push('');
+  }
+
+  if (security.length > 0) {
+    sections.push('### Security');
+    security.forEach(item => sections.push(`- ${item}`));
+    sections.push('');
+  }
+
+  return sections.join('\n');
+}
+
+/**
+ * Generate API documentation template
+ */
+function generateApiDoc(options = {}) {
+  const {
+    endpoint = '/api/v1/resource',
+    method = 'GET',
+    title = 'Endpoint',
+    description = ''
+  } = options;
+
+  return `---
+title: "${title}"
+method: "${method}"
+endpoint: "${endpoint}"
+---
+
+# ${title}
+
+${description || 'Description of what this endpoint does.'}
+
+## Endpoint
+
+\`\`\`
+${method} ${endpoint}
+\`\`\`
+
+## Authentication
+
+This endpoint requires authentication via Bearer token.
+
+| Header | Required | Description |
+|--------|----------|-------------|
+| \`Authorization\` | Yes | Bearer {token} |
+| \`Content-Type\` | Yes | application/json |
+
+## Request
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| \`param1\` | string | Yes | Description |
+| \`param2\` | number | No | Description |
+
+### Request Body
+
+\`\`\`json
+{
+  "field1": "value",
+  "field2": 123,
+  "nested": {
+    "property": "value"
+  }
+}
+\`\`\`
+
+## Response
+
+### Success Response
+
+**Code:** 200 OK
+
+\`\`\`json
+{
+  "success": true,
+  "data": {
+    "id": "abc123",
+    "createdAt": "2024-01-01T00:00:00Z"
+  }
+}
+\`\`\`
+
+### Error Responses
+
+| Status | Code | Description |
+|--------|------|-------------|
+| 400 | \`INVALID_INPUT\` | Request validation failed |
+| 401 | \`UNAUTHORIZED\` | Missing or invalid token |
+| 403 | \`FORBIDDEN\` | Insufficient permissions |
+| 404 | \`NOT_FOUND\` | Resource not found |
+| 500 | \`INTERNAL_ERROR\` | Server error |
+
+## Examples
+
+### cURL
+
+\`\`\`bash
+curl -X ${method} "${endpoint}" \\
+  -H "Authorization: Bearer $TOKEN" \\
+  -H "Content-Type: application/json" \\
+  -d '{"field1": "value"}'
+\`\`\`
+
+### JavaScript
+
+\`\`\`typescript
+const response = await fetch('${endpoint}', {
+  method: '${method}',
+  headers: {
+    'Authorization': \`Bearer \${token}\`,
+    'Content-Type': 'application/json'
+  },
+  body: JSON.stringify({
+    field1: 'value'
+  })
+});
+
+const data = await response.json();
+\`\`\`
+
+## Rate Limiting
+
+| Limit | Window | Scope |
+|-------|--------|-------|
+| 100 | 1 minute | Per API key |
+| 1000 | 1 hour | Per API key |
+
+## Changelog
+
+| Version | Date | Changes |
+|---------|------|---------|
+| v1 | 2024-01-01 | Initial release |
+`;
+}
+
+/**
+ * Generate tutorial template
+ */
+function generateTutorial(options = {}) {
+  const {
+    title = 'Tutorial',
+    description = '',
+    difficulty = 'beginner',
+    duration = '15 minutes'
+  } = options;
+
+  return `---
+title: "${title}"
+description: "${description}"
+difficulty: "${difficulty}"
+duration: "${duration}"
+---
+
+# ${title}
+
+${description || 'Learn how to accomplish a specific task.'}
+
+<Callout type="info">
+**Difficulty:** ${difficulty.charAt(0).toUpperCase() + difficulty.slice(1)} | **Duration:** ${duration}
+</Callout>
+
+## What You'll Build
+
+[Screenshot or diagram of the end result]
+
+## Prerequisites
+
+Before starting this tutorial, you should have:
+
+- [ ] Node.js 18+ installed
+- [ ] Basic understanding of X
+- [ ] Y configured
+
+## Step 1: Project Setup
+
+First, let's set up the project.
+
+\`\`\`bash
+# Create a new project
+npx create-next-app@latest my-project
+cd my-project
+\`\`\`
+
+## Step 2: Install Dependencies
+
+\`\`\`bash
+npm install package-name
+\`\`\`
+
+## Step 3: Configuration
+
+Create a configuration file:
+
+\`\`\`typescript
+// config.ts
+export const config = {
+  // Configuration here
+};
+\`\`\`
+
+## Step 4: Implementation
+
+Now let's implement the main functionality:
+
+\`\`\`typescript
+// Main implementation
+export function feature() {
+  // Code here
+}
+\`\`\`
+
+## Step 5: Testing
+
+Verify everything works:
+
+\`\`\`bash
+npm run dev
+\`\`\`
+
+Then open http://localhost:3000 and you should see:
+
+[Expected result]
+
+## Troubleshooting
+
+### Issue 1
+
+**Problem:** Description of common issue.
+
+**Solution:** How to fix it.
+
+### Issue 2
+
+**Problem:** Another common issue.
+
+**Solution:** The fix.
+
+## Next Steps
+
+Now that you've completed this tutorial:
+
+1. Try modifying the code to X
+2. Explore the Y feature
+3. Check out the [advanced tutorial](/docs/tutorials/advanced)
+
+## Summary
+
+In this tutorial, you learned how to:
+
+- Set up the project
+- Configure the dependencies
+- Implement the feature
+- Test your work
+
+## Resources
+
+- [Official Documentation](/docs)
+- [API Reference](/docs/api)
+- [GitHub Repository](https://github.com/bootspring/bootspring)
+
+---
+
+<Callout type="success">
+Completed this tutorial? Share your results on [Twitter](https://twitter.com/bootspring)!
+</Callout>
+`;
+}
+
+/**
+ * Generate content based on type
+ */
+function generate(type, options = {}) {
+  switch (type) {
+    case 'blog-post':
+      return generateBlogPost(options);
+    case 'release-notes':
+      return generateReleaseNotes(options);
+    case 'documentation':
+      return generateDocumentation(options);
+    case 'readme':
+      return generateReadme(options);
+    case 'changelog':
+      return generateChangelog(options);
+    case 'api-doc':
+      return generateApiDoc(options);
+    case 'tutorial':
+      return generateTutorial(options);
+    default:
+      throw new Error(`Unknown content type: ${type}`);
+  }
+}
+
+/**
+ * Get content type metadata
+ */
+function getContentType(type) {
+  return CONTENT_TYPES[type] || null;
+}
+
+/**
+ * List all content types
+ */
+function listContentTypes() {
+  return CONTENT_TYPES;
+}
+
+module.exports = {
+  generate,
+  getContentType,
+  listContentTypes,
+  CONTENT_TYPES,
+  // Individual generators for direct use
+  generateBlogPost,
+  generateReleaseNotes,
+  generateDocumentation,
+  generateReadme,
+  generateChangelog,
+  generateApiDoc,
+  generateTutorial
+};