@lexibase/create-rdx 4.1.0 → 4.2.0

package/README.md

@@ -39,6 +39,12 @@ npm create @lexibase/rdx@latest my-docs -- --skip-install
 `.rdx/`. Otherwise the creator uses the invoking package manager and prepares
 the runtime. Follow the commands printed by the generator.
 
+The creator reports file creation, dependency installation, and runtime preparation
+as separate stages, with elapsed time and periodic activity messages during long
+operations. Package-manager output and prompts stay visible. npm and pnpm projects
+prepare using their installed RDX executable directly; Yarn provides its project
+execution environment for Plug'n'Play compatibility.
+
 ## Recovery
 
 In a pnpm workspace, installation uses the workspace's existing dependencies and

package/bin/index.js

@@ -9,6 +9,8 @@ import prompts from 'prompts'
 
 import { parseArguments, validateProjectName } from './options.mjs'
 import { normalizePnpmRdxApprovals } from './pnpm-policy.mjs'
+import { installedRuntime } from './installed-runtime.mjs'
+import { runStep } from './progress.mjs'
 
 function getPackageManager() {
   const userAgent = process.env.npm_config_user_agent || ''
@@ -19,7 +21,7 @@ function getPackageManager() {
   return 'npm'
 }
 
-function run(command, args, cwd) {
+function run(command, args, cwd, label = `${command} ${args.join(' ')}`) {
   return new Promise((resolve, reject) => {
     // Reuse the Node entry point when available. Otherwise cross-spawn
     // resolves Windows command shims and escapes their arguments.
@@ -33,12 +35,13 @@ function run(command, args, cwd) {
     const child = spawn(executable, commandArgs, {
       cwd,
       stdio: 'inherit',
+      windowsHide: true,
     })
 
     child.on('error', reject)
     child.on('exit', (code) => {
       if (code === 0) resolve()
-      else reject(new Error(`${command} ${args.join(' ')} exited with ${code}`))
+      else reject(new Error(`${label} exited with ${code}`))
     })
   })
 }
@@ -93,73 +96,92 @@ async function main() {
   if (relativeTarget.startsWith('..') || path.isAbsolute(relativeTarget)) {
     throw new Error('Project must be created inside the current directory.')
   }
-  try {
-    await fs.mkdir(targetDir)
-  } catch (error) {
-    if (error.code === 'EEXIST')
-      throw new Error(
-        `The path "${projectName}" already exists. Choose another name; existing files are never overwritten.`
+  await runStep(
+    `[1/${skipInstall ? 1 : 3}] Creating project files...`,
+    async () => {
+      try {
+        await fs.mkdir(targetDir)
+      } catch (error) {
+        if (error.code === 'EEXIST')
+          throw new Error(
+            `The path "${projectName}" already exists. Choose another name; existing files are never overwritten.`
+          )
+        throw error
+      }
+
+      const currentFile = fileURLToPath(import.meta.url)
+      const templateDir = path.resolve(
+        path.dirname(currentFile),
+        '../templates/default'
+      )
+      await fs.copy(templateDir, targetDir, {
+        errorOnExist: true,
+        overwrite: false,
+      })
+      await fs.ensureDir(path.join(targetDir, 'public'))
+
+      const configPath = path.join(targetDir, 'rdx.config.ts')
+      const config = await fs.readFile(configPath, 'utf8')
+      await fs.writeFile(
+        configPath,
+        config.replace(
+          'since: new Date().getFullYear(),',
+          `since: ${new Date().getFullYear()},`
+        )
       )
-    throw error
-  }
-
-  const currentFile = fileURLToPath(import.meta.url)
-  const templateDir = path.resolve(
-    path.dirname(currentFile),
-    '../templates/default'
-  )
-  await fs.copy(templateDir, targetDir, {
-    errorOnExist: true,
-    overwrite: false,
-  })
-  await fs.ensureDir(path.join(targetDir, 'public'))
-
-  const configPath = path.join(targetDir, 'rdx.config.ts')
-  const config = await fs.readFile(configPath, 'utf8')
-  await fs.writeFile(
-    configPath,
-    config.replace(
-      'since: new Date().getFullYear(),',
-      `since: ${new Date().getFullYear()},`
-    )
-  )
 
-  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.toLowerCase()
-  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)
-      .replaceAll('__RDX_PROJECT_NAME__', projectName)
+      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.toLowerCase()
+      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)
+          .replaceAll('__RDX_PROJECT_NAME__', projectName)
+      )
+    }
   )
 
   const packageManager = getPackageManager()
 
   if (!skipInstall) {
     try {
-      console.log(`\nInstalling dependencies with ${packageManager}...\n`)
-      if (packageManager === 'pnpm')
-        await normalizePnpmRdxApprovals(targetDir)
-      await run(packageManager, ['install'], targetDir)
-      if (packageManager === 'pnpm')
-        await normalizePnpmRdxApprovals(targetDir)
-      const prepareArgs =
-        packageManager === 'npm'
-          ? ['exec', '--', 'rdx', 'prepare']
-          : ['exec', 'rdx', 'prepare']
-      await run(packageManager, prepareArgs, targetDir)
+      await runStep(
+        `[2/3] Installing dependencies with ${packageManager}...`,
+        async () => {
+          if (packageManager === 'pnpm')
+            await normalizePnpmRdxApprovals(targetDir)
+          await run(packageManager, ['install'], targetDir)
+          if (packageManager === 'pnpm')
+            await normalizePnpmRdxApprovals(targetDir)
+        }
+      )
+      await runStep('[3/3] Preparing RDX...', async () => {
+        if (packageManager === 'yarn') {
+          // Yarn provides the project's Plug'n'Play loader when needed.
+          await run(packageManager, ['exec', 'rdx', 'prepare'], targetDir)
+        } else {
+          // Avoid another package-manager startup and automatic install check.
+          const executable = await installedRuntime(targetDir)
+          await run(
+            process.execPath,
+            [executable, 'prepare'],
+            targetDir,
+            'rdx prepare'
+          )
+        }
+      })
     } catch (error) {
       const runner = packageManager === 'npm' ? 'npm run' : packageManager
       throw new Error(

package/bin/installed-runtime.mjs

@@ -0,0 +1,32 @@
+import { createRequire } from 'node:module'
+import { readFile, stat } from 'node:fs/promises'
+import path from 'node:path'
+
+/** Resolve the framework installed in the new project, including hoisted workspaces. */
+export async function installedRuntime(directory) {
+  const require = createRequire(path.join(directory, 'package.json'))
+  let filename
+  try {
+    filename = require.resolve('@lexibase/rdx/package.json')
+  } catch {
+    throw new Error(
+      'Could not find @lexibase/rdx in the new project after installation.'
+    )
+  }
+  const manifest = JSON.parse(await readFile(filename, 'utf8'))
+  const entry =
+    typeof manifest.bin === 'string' ? manifest.bin : manifest.bin?.rdx
+  if (typeof entry !== 'string' || !entry)
+    throw new Error(
+      'The installed @lexibase/rdx package does not provide its rdx executable.'
+    )
+  const executable = path.resolve(path.dirname(filename), entry)
+  try {
+    if (!(await stat(executable)).isFile()) throw new Error()
+  } catch {
+    throw new Error(
+      'The installed RDX executable is missing. Run the package manager install command again.'
+    )
+  }
+  return executable
+}

package/bin/progress.mjs

@@ -0,0 +1,23 @@
+import { performance } from 'node:perf_hooks'
+
+/** Show real stage timings while preserving the installer's own terminal output. */
+export async function runStep(
+  label,
+  operation,
+  { log = console.log, intervalMs = 15_000 } = {}
+) {
+  const started = performance.now()
+  const elapsed = () => ((performance.now() - started) / 1000).toFixed(1)
+  log(`\n${label}`)
+  const timer = setInterval(() => {
+    log(`[RDX] ${label} (${elapsed()}s elapsed)`)
+  }, intervalMs)
+  timer.unref()
+  try {
+    const result = await operation()
+    log(`[RDX] Completed in ${elapsed()}s.`)
+    return result
+  } finally {
+    clearInterval(timer)
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lexibase/create-rdx",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "Create a new RDX documentation project.",
   "license": "MIT",
   "bin": {

package/templates/default/README.md

@@ -51,7 +51,8 @@ public/images/rdx.svg        → /images/rdx.svg
 public/downloads/example.txt → /downloads/example.txt
 ```
 
-Use site-root URLs in MDX:
+Write pages as `.md` or `.mdx` inside `docs/`. Both formats support RDX's
+Markdown components. Use site-root URLs for assets:
 
 ```md
 ![RDX logo](/images/rdx.svg)

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

@@ -6,5 +6,5 @@ link_position: 1
 
 # Welcome to your documentation
 
-RDX turns folders and `.mdx` files into a documentation site. Start by editing
+RDX turns folders and `.md` or `.mdx` files into a documentation site. Start by editing
 this page or adding new pages inside `docs/`.

package/templates/default/package.json

@@ -9,7 +9,7 @@
     "start": "rdx start"
   },
   "dependencies": {
-    "@lexibase/rdx": "4.1.0",
+    "@lexibase/rdx": "4.2.0",
     "next": "^16.4.2",
     "react": "19.3.1",
     "react-dom": "19.3.1"

package/templates/default/rdx.config.ts

@@ -32,7 +32,8 @@ export default defineConfig({
   // Optional navbar text does not change metadata.applicationName.
   navbar: {
     title: '', // Text beside the logo; empty or omitted shows only the logo.
-    // logo: Logo, // Import a React component that accepts className, not an image path.
+    // logo: '/images/logo.png', // File in public/images/; PNG, SVG and other image formats work.
+    // Or import your components/logo.tsx and set logo: Logo.
     actions: {
       github: {
         visible: true,