@nextsparkjs/core 0.1.0-beta.1 → 0.1.0-beta.3

package/dist/bin/wizard/generators/index.ts

@@ -0,0 +1,271 @@
+/**
+ * Generators Index
+ *
+ * Orchestrates all generators to create the complete project.
+ */
+
+import fs from 'fs-extra'
+import path from 'path'
+import { fileURLToPath } from 'url'
+import type { WizardConfig } from '../types.js'
+import {
+  copyStarterTheme,
+  updateThemeConfig,
+  updateDevConfig,
+  updateAppConfig,
+  updateBillingConfig,
+  updateMigrations,
+  updateRolesConfig,
+} from './theme-renamer.js'
+import {
+  updatePermissionsConfig,
+  updateDashboardConfig,
+  generateEnvExample,
+  updateReadme,
+  updateAuthConfig,
+  updateDashboardUIConfig,
+  updateDevToolsConfig,
+} from './config-generator.js'
+import { processI18n } from './messages-generator.js'
+import { copyContentFeatures } from './content-features-generator.js'
+// New DX improvement generators
+import { installDemoTheme } from './demo-installer.js'
+import { setupEnvironment } from './env-setup.js'
+import { setupGit } from './git-init.js'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+export {
+  copyStarterTheme,
+  updateThemeConfig,
+  updateDevConfig,
+  updateAppConfig,
+  updateBillingConfig,
+  updateMigrations,
+  updateRolesConfig,
+  updatePermissionsConfig,
+  updateDashboardConfig,
+  generateEnvExample,
+  updateReadme,
+  processI18n,
+  updateAuthConfig,
+  updateDashboardUIConfig,
+  updateDevToolsConfig,
+  copyContentFeatures,
+  // New DX generators
+  installDemoTheme,
+  setupEnvironment,
+  setupGit,
+}
+
+/**
+ * Get the templates directory path
+ */
+function getTemplatesDir(): string {
+  return path.resolve(__dirname, '../../../../templates')
+}
+
+/**
+ * Copy core project files (app/, public/, config files)
+ */
+async function copyProjectFiles(): Promise<void> {
+  const templatesDir = getTemplatesDir()
+  const projectDir = process.cwd()
+
+  // Files and directories to copy
+  const itemsToCopy = [
+    { src: 'app', dest: 'app', force: true },
+    { src: 'public', dest: 'public', force: true },
+    { src: 'next.config.mjs', dest: 'next.config.mjs', force: true },
+    { src: 'tsconfig.json', dest: 'tsconfig.json', force: true },
+    { src: 'postcss.config.mjs', dest: 'postcss.config.mjs', force: true },
+    { src: 'i18n.ts', dest: 'i18n.ts', force: true },
+    { src: 'npmrc', dest: '.npmrc', force: false },
+    { src: 'tsconfig.cypress.json', dest: 'tsconfig.cypress.json', force: false },
+    { src: 'cypress.d.ts', dest: 'cypress.d.ts', force: false },
+    { src: 'eslint.config.mjs', dest: 'eslint.config.mjs', force: false },
+  ]
+
+  for (const item of itemsToCopy) {
+    const srcPath = path.join(templatesDir, item.src)
+    const destPath = path.join(projectDir, item.dest)
+
+    if (await fs.pathExists(srcPath)) {
+      if (item.force || !await fs.pathExists(destPath)) {
+        await fs.copy(srcPath, destPath)
+      }
+    }
+  }
+}
+
+/**
+ * Update or create package.json with required scripts and dependencies
+ */
+async function updatePackageJson(config: WizardConfig): Promise<void> {
+  const packageJsonPath = path.resolve(process.cwd(), 'package.json')
+
+  // Create package.json if it doesn't exist
+  let packageJson: {
+    name?: string
+    version?: string
+    private?: boolean
+    scripts?: Record<string, string>
+    dependencies?: Record<string, string>
+    devDependencies?: Record<string, string>
+  }
+  if (!await fs.pathExists(packageJsonPath)) {
+    packageJson = {
+      name: config.projectSlug,
+      version: '0.1.0',
+      private: true,
+      scripts: {},
+      dependencies: {
+        '@nextsparkjs/core': 'latest',
+        'next': '^15.0.0',
+        'react': '^19.0.0',
+        'react-dom': '^19.0.0',
+      },
+      devDependencies: {
+        'typescript': '^5.0.0',
+        '@types/node': '^22.0.0',
+        '@types/react': '^19.0.0',
+        '@types/react-dom': '^19.0.0',
+      },
+    }
+  } else {
+    packageJson = await fs.readJson(packageJsonPath)
+  }
+
+  // Ensure scripts object exists
+  packageJson.scripts = packageJson.scripts || {}
+
+  // Add NextSpark scripts
+  const scriptsToAdd: Record<string, string> = {
+    'dev': 'next dev --turbopack',
+    'build': 'next build',
+    'start': 'next start',
+    'lint': 'next lint',
+    'build:registries': 'node node_modules/@nextsparkjs/core/scripts/build/registry.mjs',
+    'db:migrate': 'node node_modules/@nextsparkjs/core/scripts/db/run-migrations.mjs',
+    'test:theme': `jest --config contents/themes/${config.projectSlug}/tests/jest/jest.config.ts`,
+    'cy:open': `cypress open --config-file contents/themes/${config.projectSlug}/tests/cypress.config.ts`,
+    'cy:run': `cypress run --config-file contents/themes/${config.projectSlug}/tests/cypress.config.ts`,
+    'allure:generate': `allure generate contents/themes/${config.projectSlug}/tests/cypress/allure-results --clean -o contents/themes/${config.projectSlug}/tests/cypress/allure-report`,
+    'allure:open': `allure open contents/themes/${config.projectSlug}/tests/cypress/allure-report`,
+  }
+
+  for (const [name, command] of Object.entries(scriptsToAdd)) {
+    if (!packageJson.scripts[name]) {
+      packageJson.scripts[name] = command
+    }
+  }
+
+  // Add devDependencies
+  packageJson.devDependencies = packageJson.devDependencies || {}
+  const devDepsToAdd: Record<string, string> = {
+    '@tailwindcss/postcss': '^4',
+    'eslint': '^9',
+    'eslint-config-next': '^15.0.0',
+    '@eslint/eslintrc': '^3',
+    'jest': '^29.7.0',
+    'ts-jest': '^29.2.5',
+    'ts-node': '^10.9.2',
+    '@types/jest': '^29.5.14',
+    '@testing-library/jest-dom': '^6.6.3',
+    '@testing-library/react': '^16.3.0',
+    'jest-environment-jsdom': '^29.7.0',
+    'cypress': '^15.0.0',
+    '@testing-library/cypress': '^10.0.2',
+    '@cypress/webpack-preprocessor': '^6.0.2',
+    '@cypress/grep': '^4.1.0',
+    'ts-loader': '^9.5.1',
+    'webpack': '^5.97.0',
+    'allure-cypress': '^3.0.0',
+    'allure-commandline': '^2.27.0',
+  }
+
+  for (const [name, version] of Object.entries(devDepsToAdd)) {
+    if (!packageJson.devDependencies[name]) {
+      packageJson.devDependencies[name] = version
+    }
+  }
+
+  await fs.writeJson(packageJsonPath, packageJson, { spaces: 2 })
+}
+
+/**
+ * Update .gitignore with NextSpark entries
+ */
+async function updateGitignore(config: WizardConfig): Promise<void> {
+  const gitignorePath = path.resolve(process.cwd(), '.gitignore')
+
+  const entriesToAdd = `
+# NextSpark
+.nextspark/
+
+# Cypress (theme-based)
+contents/themes/*/tests/cypress/videos
+contents/themes/*/tests/cypress/screenshots
+contents/themes/*/tests/cypress/allure-results
+contents/themes/*/tests/cypress/allure-report
+
+# Jest (theme-based)
+contents/themes/*/tests/jest/coverage
+
+# Environment
+.env
+.env.local
+`
+
+  if (await fs.pathExists(gitignorePath)) {
+    const currentContent = await fs.readFile(gitignorePath, 'utf-8')
+    if (!currentContent.includes('.nextspark/')) {
+      await fs.appendFile(gitignorePath, entriesToAdd)
+    }
+  } else {
+    await fs.writeFile(gitignorePath, entriesToAdd.trim())
+  }
+}
+
+/**
+ * Generate complete project based on wizard configuration
+ */
+export async function generateProject(config: WizardConfig): Promise<void> {
+  // 1. Copy core project files
+  await copyProjectFiles()
+
+  // 2. Copy and rename starter theme
+  await copyStarterTheme(config)
+
+  // 3. Copy optional content features (pages entity, blog entity + block)
+  await copyContentFeatures(config)
+
+  // 4. Update theme configuration files
+  await updateThemeConfig(config)
+  await updateDevConfig(config)
+  await updateAppConfig(config)
+  await updateBillingConfig(config)
+  await updateRolesConfig(config)
+
+  // 5. Update migrations
+  await updateMigrations(config)
+
+  // 6. Update additional configs
+  await updatePermissionsConfig(config)
+  await updateDashboardConfig(config)
+
+  // 7. Update Phase 3 configs (auth, dashboard UI, dev tools)
+  await updateAuthConfig(config)
+  await updateDashboardUIConfig(config)
+  await updateDevToolsConfig(config)
+
+  // 8. Process i18n files
+  await processI18n(config)
+
+  // 9. Update project files
+  await updatePackageJson(config)
+  await updateGitignore(config)
+  await generateEnvExample(config)
+  await updateReadme(config)
+}

package/dist/bin/wizard/generators/messages-generator.ts

@@ -0,0 +1,159 @@
+/**
+ * Messages Generator
+ *
+ * Manages i18n message files - removes unused languages and ensures
+ * selected languages have complete message files.
+ */
+
+import fs from 'fs-extra'
+import path from 'path'
+import type { WizardConfig } from '../types.js'
+import { AVAILABLE_LOCALES } from '../types.js'
+
+/**
+ * Get the target themes directory in the user's project
+ */
+function getTargetThemesDir(): string {
+  return path.resolve(process.cwd(), 'contents', 'themes')
+}
+
+/**
+ * Remove unused language folders from messages directory
+ */
+export async function removeUnusedLanguages(config: WizardConfig): Promise<void> {
+  const messagesDir = path.join(getTargetThemesDir(), config.projectSlug, 'messages')
+
+  if (!await fs.pathExists(messagesDir)) {
+    return
+  }
+
+  // Get all language folders
+  const folders = await fs.readdir(messagesDir)
+  const languageFolders = folders.filter(f => {
+    const folderPath = path.join(messagesDir, f)
+    return fs.statSync(folderPath).isDirectory() && Object.keys(AVAILABLE_LOCALES).includes(f)
+  })
+
+  // Remove folders that are not in supported locales
+  for (const folder of languageFolders) {
+    if (!config.supportedLocales.includes(folder)) {
+      await fs.remove(path.join(messagesDir, folder))
+    }
+  }
+}
+
+/**
+ * Remove unused language files from entity messages
+ */
+export async function removeUnusedEntityMessages(config: WizardConfig): Promise<void> {
+  const entitiesDir = path.join(getTargetThemesDir(), config.projectSlug, 'entities')
+
+  if (!await fs.pathExists(entitiesDir)) {
+    return
+  }
+
+  // Get all entity folders
+  const entityFolders = await fs.readdir(entitiesDir)
+
+  for (const entity of entityFolders) {
+    const messagesDir = path.join(entitiesDir, entity, 'messages')
+
+    if (!await fs.pathExists(messagesDir)) {
+      continue
+    }
+
+    // Get all message files
+    const files = await fs.readdir(messagesDir)
+
+    for (const file of files) {
+      // Extract locale from filename (e.g., en.json -> en)
+      const locale = path.basename(file, '.json')
+
+      // Remove if not in supported locales
+      if (Object.keys(AVAILABLE_LOCALES).includes(locale) && !config.supportedLocales.includes(locale)) {
+        await fs.remove(path.join(messagesDir, file))
+      }
+    }
+  }
+}
+
+/**
+ * Create missing language folders with copied translations from default locale
+ */
+export async function ensureLanguageFolders(config: WizardConfig): Promise<void> {
+  const messagesDir = path.join(getTargetThemesDir(), config.projectSlug, 'messages')
+
+  if (!await fs.pathExists(messagesDir)) {
+    return
+  }
+
+  const defaultLocaleDir = path.join(messagesDir, config.defaultLocale)
+
+  // Ensure default locale exists
+  if (!await fs.pathExists(defaultLocaleDir)) {
+    // If default doesn't exist, try to copy from 'en'
+    const enDir = path.join(messagesDir, 'en')
+    if (await fs.pathExists(enDir)) {
+      await fs.copy(enDir, defaultLocaleDir)
+    }
+  }
+
+  // Create missing locale folders by copying from default
+  for (const locale of config.supportedLocales) {
+    const localeDir = path.join(messagesDir, locale)
+
+    if (!await fs.pathExists(localeDir) && await fs.pathExists(defaultLocaleDir)) {
+      // Copy from default locale as a starting point
+      await fs.copy(defaultLocaleDir, localeDir)
+    }
+  }
+}
+
+/**
+ * Update message files with project-specific values
+ */
+export async function updateMessageFiles(config: WizardConfig): Promise<void> {
+  const messagesDir = path.join(getTargetThemesDir(), config.projectSlug, 'messages')
+
+  if (!await fs.pathExists(messagesDir)) {
+    return
+  }
+
+  // Update common.json in each language folder
+  for (const locale of config.supportedLocales) {
+    const commonPath = path.join(messagesDir, locale, 'common.json')
+
+    if (await fs.pathExists(commonPath)) {
+      try {
+        const content = await fs.readJson(commonPath)
+
+        // Update app name if it exists in the translations
+        if (content.app) {
+          content.app.name = config.projectName
+          if (content.app.description) {
+            content.app.description = config.projectDescription
+          }
+        }
+
+        await fs.writeJson(commonPath, content, { spaces: 2 })
+      } catch {
+        // Skip if JSON parsing fails
+      }
+    }
+  }
+}
+
+/**
+ * Main function to process all i18n-related tasks
+ */
+export async function processI18n(config: WizardConfig): Promise<void> {
+  // Remove unused languages
+  await removeUnusedLanguages(config)
+  await removeUnusedEntityMessages(config)
+
+  // Ensure all selected languages have folders
+  await ensureLanguageFolders(config)
+
+  // Update message files with project values
+  await updateMessageFiles(config)
+}