@lexibase/create-rdx 0.0.0-stage → 1.0.0-beta.1

package/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2025 Lexibase
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/bin/index.js

@@ -0,0 +1,128 @@
+#!/usr/bin/env node
+
+import { spawn } from 'node:child_process'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+import fs from 'fs-extra'
+import prompts from 'prompts'
+
+const projectNamePattern = /^[a-z0-9][a-z0-9._-]*$/i
+const argumentsFromCli = process.argv.slice(2)
+const skipInstall = argumentsFromCli.includes('--skip-install')
+const nameFromCli = argumentsFromCli.find(
+  (argument) => !argument.startsWith('-')
+)
+
+function getPackageManager() {
+  const userAgent = process.env.npm_config_user_agent || ''
+
+  if (userAgent.startsWith('pnpm')) return 'pnpm'
+  if (userAgent.startsWith('yarn')) return 'yarn'
+
+  return 'npm'
+}
+
+function validateProjectName(projectName) {
+  if (!projectName) return 'Please enter a project name.'
+  if (!projectNamePattern.test(projectName)) {
+    return 'Use letters, numbers, dots, dashes, or underscores only.'
+  }
+  if (projectName === '.' || projectName === '..') {
+    return 'Choose a name other than . or ...'
+  }
+
+  return true
+}
+
+function run(command, args, cwd) {
+  return new Promise((resolve, reject) => {
+    // Reuse the package manager's Node entry point, including on Windows,
+    // where a .cmd shim cannot be launched directly with spawn().
+    const packageManagerEntry = process.env.npm_execpath
+    const useNodeEntry =
+      command === getPackageManager() &&
+      packageManagerEntry &&
+      /\.[cm]?js$/i.test(packageManagerEntry)
+    const executable = useNodeEntry ? process.execPath : command
+    const commandArgs = useNodeEntry ? [packageManagerEntry, ...args] : args
+    const child = spawn(executable, commandArgs, {
+      cwd,
+      stdio: 'inherit',
+      shell: !useNodeEntry && process.platform === 'win32',
+    })
+
+    child.on('error', reject)
+    child.on('exit', (code) => {
+      if (code === 0) resolve()
+      else reject(new Error(`${command} ${args.join(' ')} exited with ${code}`))
+    })
+  })
+}
+
+const response = nameFromCli
+  ? { projectName: nameFromCli }
+  : await prompts({
+      type: 'text',
+      name: 'projectName',
+      message: 'What is your project named?',
+      validate: validateProjectName,
+    })
+
+const { projectName } = response
+if (!projectName) {
+  console.log('Project creation cancelled.')
+  process.exit(0)
+}
+
+const targetDir = path.resolve(process.cwd(), projectName)
+const relativeTarget = path.relative(process.cwd(), targetDir)
+
+if (relativeTarget.startsWith('..') || path.isAbsolute(relativeTarget)) {
+  throw new Error('Project must be created inside the current directory.')
+}
+if (await fs.pathExists(targetDir)) {
+  throw new Error(`The directory "${projectName}" already exists.`)
+}
+
+const currentFile = fileURLToPath(import.meta.url)
+const templateDir = path.resolve(
+  path.dirname(currentFile),
+  '../templates/default'
+)
+await fs.copy(templateDir, targetDir, { errorOnExist: true })
+
+const gitignoreTemplatePath = path.join(targetDir, 'gitignore.template')
+await fs.move(gitignoreTemplatePath, path.join(targetDir, '.gitignore'), {
+  overwrite: true,
+})
+await fs.remove(path.join(targetDir, 'gitignore'))
+await fs.remove(path.join(targetDir, '.npmignore'))
+
+const pkgPath = path.join(targetDir, 'package.json')
+const pkg = await fs.readJson(pkgPath)
+pkg.name = projectName
+await fs.writeJson(pkgPath, pkg, { spaces: 2 })
+
+const readmePath = path.join(targetDir, 'README.md')
+const readme = await fs.readFile(readmePath, 'utf8')
+await fs.writeFile(
+  readmePath,
+  readme.replaceAll('__RDX_PROJECT_NAME__', projectName)
+)
+
+const packageManager = getPackageManager()
+
+if (!skipInstall) {
+  console.log(`\nInstalling dependencies with ${packageManager}...\n`)
+  await run(packageManager, ['install'], targetDir)
+  const prepareArgs =
+    packageManager === 'npm'
+      ? ['exec', '--', 'rdx', 'prepare']
+      : ['exec', 'rdx', 'prepare']
+  await run(packageManager, prepareArgs, targetDir)
+}
+
+console.log(`\nRDX project "${projectName}" created successfully.\n`)
+console.log(`  cd ${projectName}`)
+console.log(`  ${packageManager} dev\n`)

package/package.json

@@ -1,6 +1,34 @@
 {
   "name": "@lexibase/create-rdx",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0-beta.1",
+  "description": "Create a new RDX documentation project.",
+  "license": "MIT",
+  "bin": {
+    "create-rdx": "./bin/index.js"
+  },
+  "type": "module",
+  "files": [
+    "bin",
+    "templates",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18.18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lexibase/rdx.git",
+    "directory": "packages/create-rdx"
+  },
+  "bugs": {
+    "url": "https://github.com/lexibase/rdx/issues"
+  },
+  "homepage": "https://github.com/lexibase/rdx#readme",
+  "dependencies": {
+    "fs-extra": "^11.1.1",
+    "prompts": "^2.4.2"
+  }
 }

package/templates/default/README.md

@@ -0,0 +1,12 @@
+# **RDX_PROJECT_NAME**
+
+This documentation site was created with RDX.
+
+## Development
+
+```bash
+pnpm dev
+```
+
+Edit files in `docs/` to create your documentation. RDX creates and maintains
+its internal runtime in `.rdx/`.

package/templates/default/docs/examples/_category.json

@@ -0,0 +1,4 @@
+{
+  "title": "Examples",
+  "sidebar_position": 2
+}

package/templates/default/docs/examples/colors.mdx

@@ -0,0 +1,7 @@
+---
+title: Colors
+description: An example page inside a second category.
+link_position: 2
+---
+
+RDX includes a clean default theme that adapts to your system preference.

package/templates/default/docs/examples/markdown.mdx

@@ -0,0 +1,15 @@
+---
+title: Markdown
+description: A small Markdown and MDX example.
+link_position: 1
+---
+
+## Markdown works
+
+- Organize content with lists
+- Add [links](https://mdxjs.com/)
+- Use **strong text** and `inline code`
+
+```ts
+const framework = 'RDX'
+```

package/templates/default/docs/init/_category.json

@@ -0,0 +1,4 @@
+{
+  "title": "Getting started",
+  "sidebar_position": 1
+}

package/templates/default/docs/init/getting-started.mdx

@@ -0,0 +1,17 @@
+---
+title: Getting started
+description: Learn how to add pages and categories to your site.
+link_position: 2
+---
+
+## Create a page
+
+Add an `.mdx` file inside a folder in `docs/`. Its path becomes the page URL.
+
+```text
+docs/
+└── guides/
+    └── deployment.mdx
+```
+
+This file is available at `/docs/guides/deployment`.

package/templates/default/docs/init/intro.mdx

@@ -0,0 +1,10 @@
+---
+title: Introduction
+description: Start building your documentation with RDX.
+link_position: 1
+---
+
+# Welcome to your documentation
+
+RDX turns folders and `.mdx` files into a documentation site. Start by editing
+this page or adding new pages inside `docs/`.

package/templates/default/gitignore.template

@@ -0,0 +1,4 @@
+node_modules
+.next
+.rdx
+.env*.local

package/templates/default/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "__RDX_PROJECT_NAME__",
+  "version": "1.0.0",
+  "type": "module",
+  "private": true,
+  "scripts": {
+    "dev": "rdx dev",
+    "build": "rdx build",
+    "start": "rdx start"
+  },
+  "dependencies": {
+    "@lexibase/rdx-next": "^1.0.0-beta.0",
+    "next": "^15.5.0",
+    "react": "19.1.0",
+    "react-dom": "19.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.3",
+    "@types/react": "19.1.0",
+    "typescript": "5.9.2"
+  },
+  "engines": {
+    "node": ">=18.18"
+  }
+}

package/templates/default/rdx.config.ts

@@ -0,0 +1,11 @@
+import type { RdxRuntimeConfig } from '@lexibase/rdx-next'
+
+const config: RdxRuntimeConfig = {
+  title: 'My documentation',
+  description: 'Documentation built with RDX.',
+  theme: {
+    defaultTheme: 'system',
+  },
+}
+
+export default config

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.