@nera-static/nera 1.4.1 → 1.5.1

package/README.md

@@ -14,11 +14,16 @@ cd my-site
 npm run dev            # or: nera dev
 ```
 
+Already in the folder the site should live in? `nera new .` scaffolds into the
+current folder instead. The folder must be empty apart from dotfiles such as
+`.git` (an existing `.gitignore` is kept), and the package is named after the
+folder (`My Bakery` → `my-bakery`).
+
 ## Commands
 
 | Command | What it does |
 |---|---|
-| `nera new <name>` | Scaffold a new thin Nera site (one dependency: `@nera-static/nera`). Add `--theme <name>` to start from a theme. |
+| `nera new <name>` | Scaffold a new thin Nera site (one dependency: `@nera-static/nera`). Add `--theme <name>` to start from a theme. `nera new .` scaffolds into the current, empty folder. |
 | `nera build` | Render `pages/` → `public/`. With `--check`, then run `nera check` on the result — one command for CI. |
 | `nera dev` | Build, serve `public/`, and rebuild on change with live reload. Watches `pages/`, `config/`, `theme/` and a local theme (`theme: ./themes/<name>`). |
 | `nera serve` | Serve the already-built `public/` folder. |

package/bin/nera.js

@@ -13,6 +13,7 @@ const usage = `Nera — the static site generator CLI
 
 Usage:
   nera new <name>    scaffold a new Nera site (--theme <name> to start from a theme)
+  nera new .         scaffold into the current, empty folder
   nera build         render pages/ → public/ (--check to check the output after)
   nera dev           build, serve and live-reload
   nera serve         serve the built public/ folder

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nera-static/nera",
-    "version": "1.4.1",
+    "version": "1.5.1",
     "description": "The Nera CLI — scaffold, build, preview and update a Nera static site with one command over the @nera-static/core engine",
     "type": "module",
     "bin": {

package/src/scaffold.js

@@ -12,7 +12,8 @@ const VALID_PROJECT_NAME = /^[A-Za-z0-9][A-Za-z0-9._-]*$/
 export function validateProjectName(projectName) {
     if (typeof projectName !== 'string' || projectName.trim() === '') {
         throw new Error(
-            'Project name is required. Usage: nera new <project-name>'
+            'Project name is required. Usage: nera new <project-name> ' +
+                '(or `nera new .` for the current folder)'
         )
     }
 
@@ -26,6 +27,55 @@ export function validateProjectName(projectName) {
     return projectName
 }
 
+// `nera new .` scaffolds into the current folder. Only these two spellings:
+// `..`, absolute paths and every other name still go through
+// validateProjectName unchanged.
+const CURRENT_DIR = new Set(['.', './'])
+
+export const isCurrentDir = (projectName) => CURRENT_DIR.has(projectName)
+
+// Letters NFKD does not decompose into a base letter plus an accent.
+const LETTER_FOLDS = { ß: 'ss', æ: 'ae', œ: 'oe', ø: 'o', ł: 'l', đ: 'd' }
+
+// npm refuses these names outright, and longer ones than this.
+const NPM_RESERVED = new Set(['node_modules', 'favicon.ico'])
+const NPM_MAX_LENGTH = 214
+
+// The package name for a site scaffolded in place, derived from the folder's
+// basename and normalised until it passes validateProjectName and npm's own
+// rules: accents dropped (`Bäckerei` → `backerei`, `Straße` → `strasse`),
+// lower-case, each run of other characters → one `-`, no leading dot, dash or
+// underscore, at most 214 characters. `nera-site` when nothing usable is left.
+export function projectNameFromDir(dir) {
+    const name = path
+        .basename(path.resolve(dir))
+        .toLowerCase()
+        .replace(/[ßæœøłđ]/g, (c) => LETTER_FOLDS[c])
+        .normalize('NFKD')
+        .replace(/[\u0300-\u036f]/g, '')
+        .replace(/[^a-z0-9._-]+/g, '-')
+        .replace(/^[._-]+/, '')
+        .slice(0, NPM_MAX_LENGTH)
+        .replace(/[-.]+$/, '')
+    return name === '' || NPM_RESERVED.has(name)
+        ? 'nera-site'
+        : validateProjectName(name)
+}
+
+// In-place scaffolding only goes ahead in an empty folder. Dotfiles such as
+// `.git` or an editor folder do not count: `git init` first is the usual way
+// to start a project.
+async function assertEmptyDir(dir) {
+    const entries = (await fs.readdir(dir)).filter((n) => !n.startsWith('.'))
+    if (entries.length > 0) {
+        throw new Error(
+            `The current folder is not empty (${entries.slice(0, 3).join(', ')}` +
+                `${entries.length > 3 ? ', …' : ''}). Run \`nera new .\` in an ` +
+                'empty folder, or `nera new <name>` to create a new one.'
+        )
+    }
+}
+
 // What `--theme` accepts, mirroring the three forms `app.theme` takes in
 // @nera-static/core (src/theme.js): a bare name (`example` →
 // @nera-static/theme-example), a full package name (`@acme/my-theme`), or a
@@ -85,6 +135,10 @@ async function copyDir(src, dest, { skipStarters = false } = {}) {
             await copyDir(from, to, { skipStarters })
         } else if (skipStarters && (await isStarterTemplate(from))) {
             continue
+        } else if (fssync.existsSync(to)) {
+            // Only in place, and then only a dotfile such as .gitignore can be
+            // there already (assertEmptyDir): the user's copy wins.
+            console.log(`  • Kept your existing ${path.basename(to)}`)
         } else {
             await fs.copyFile(from, to)
         }
@@ -126,17 +180,21 @@ async function applyTheme(targetDir, theme) {
 export async function scaffoldProject(projectName, options = {}) {
     const { install = true, cwd = process.cwd(), theme } = options
 
-    validateProjectName(projectName)
+    const inPlace = isCurrentDir(projectName)
+    if (!inPlace) validateProjectName(projectName)
     if (theme !== undefined) validateThemeSpec(theme)
 
-    const targetDir = path.resolve(cwd, projectName)
-    if (fssync.existsSync(targetDir)) {
+    const targetDir = path.resolve(cwd, inPlace ? '.' : projectName)
+    if (inPlace) {
+        await assertEmptyDir(targetDir)
+    } else if (fssync.existsSync(targetDir)) {
         throw new Error(`Target directory "${projectName}" already exists.`)
     }
+    const packageName = inPlace ? projectNameFromDir(targetDir) : projectName
 
     console.log(`📦 Creating a new Nera site in ${targetDir}...`)
     await copyDir(templateDir(), targetDir, { skipStarters: Boolean(theme) })
-    await personalize(targetDir, projectName)
+    await personalize(targetDir, packageName)
     if (theme) await applyTheme(targetDir, theme)
 
     if (install) {
@@ -149,7 +207,15 @@ export async function scaffoldProject(projectName, options = {}) {
         execFileSync('npm', args, { cwd: targetDir, stdio: 'inherit' })
     }
 
+    // `npm run dev`, not `nera dev`: it works without a global `nera`.
+    const nextSteps = [
+        ...(inPlace ? [] : [`cd ${projectName}`]),
+        ...(install ? [] : ['npm install']),
+        'npm run dev',
+    ]
     console.log('✅ Done!')
-    console.log(`👉 Next steps:\n  cd ${projectName}\n  nera dev\n`)
+    console.log(
+        `👉 Next steps:\n${nextSteps.map((l) => `  ${l}\n`).join('')}`
+    )
     return targetDir
 }