@xfilecom/create-xframe 0.1.0

package/bin/create-xframe.js

@@ -0,0 +1,163 @@
+#!/usr/bin/env node
+/**
+ * create-xframe — copy template, substitute package name and backend-core spec.
+ * Usage: npx create-xframe <project-dir> [--backend-core <npm-spec>]
+ * Example: npx create-xframe my-api --backend-core file:../packages/backend-core
+ */
+
+const fs = require('fs');
+const path = require('path');
+
+const TEXT_EXT = new Set([
+  '.json',
+  '.ts',
+  '.md',
+  '.yml',
+  '.yaml',
+  '.gitignore',
+]);
+
+function usage() {
+  console.log(`Usage: create-xframe <project-directory> [options]
+
+Options:
+  --backend-core <spec>   @xfilecom/backend-core dependency (default: ^1.0.0)
+                          e.g. file:../packages/backend-core (app next to packages/)
+
+Examples:
+  npx create-xframe my-api
+  npm create xframe@latest -- my-api
+  npx create-xframe my-api --backend-core file:../packages/backend-core`);
+}
+
+function parseArgs(argv) {
+  const rest = argv.slice(2);
+  let projectDir = null;
+  let backendCore = '^1.0.0';
+
+  for (let i = 0; i < rest.length; i += 1) {
+    const a = rest[i];
+    if (a === '--help' || a === '-h') {
+      usage();
+      process.exit(0);
+    }
+    if (a === '--backend-core') {
+      const v = rest[i + 1];
+      if (!v || v.startsWith('-')) {
+        console.error('create-xframe: --backend-core requires a value');
+        process.exit(1);
+      }
+      backendCore = v;
+      i += 1;
+      continue;
+    }
+    if (a.startsWith('-')) {
+      console.error(`create-xframe: unknown option ${a}`);
+      usage();
+      process.exit(1);
+    }
+    if (projectDir !== null) {
+      console.error('create-xframe: only one project directory allowed');
+      process.exit(1);
+    }
+    projectDir = a;
+  }
+
+  return { projectDir, backendCore };
+}
+
+function isValidNpmName(name) {
+  if (!name || typeof name !== 'string') return false;
+  if (name.length > 214) return false;
+  // unscoped: lowercase, hyphens, digits; no leading/trailing hyphen
+  if (name.startsWith('@')) return false;
+  return /^[a-z0-9]([a-z0-9-]*[a-z0-9])?$/.test(name);
+}
+
+function walkFiles(dir, base = dir, out = []) {
+  for (const ent of fs.readdirSync(dir, { withFileTypes: true })) {
+    const full = path.join(dir, ent.name);
+    if (ent.isDirectory()) {
+      walkFiles(full, base, out);
+    } else {
+      out.push(full);
+    }
+  }
+  return out;
+}
+
+function substitute(content, vars) {
+  let s = content;
+  for (const [key, val] of Object.entries(vars)) {
+    const token = `__${key}__`;
+    if (s.includes(token)) {
+      s = s.split(token).join(val);
+    }
+  }
+  return s;
+}
+
+function processFile(filePath, vars) {
+  const ext = path.extname(filePath);
+  if (!TEXT_EXT.has(ext)) return;
+  const raw = fs.readFileSync(filePath, 'utf8');
+  const next = substitute(raw, vars);
+  if (next !== raw) {
+    fs.writeFileSync(filePath, next, 'utf8');
+  }
+}
+
+function main() {
+  const { projectDir, backendCore } = parseArgs(process.argv);
+
+  if (!projectDir) {
+    console.error('create-xframe: missing <project-directory>\n');
+    usage();
+    process.exit(1);
+  }
+
+  const packageName = path.basename(path.resolve(process.cwd(), projectDir));
+  if (!isValidNpmName(packageName)) {
+    console.error(
+      `create-xframe: "${packageName}" is not a valid unscoped npm package name (use lowercase, digits, hyphens).`,
+    );
+    process.exit(1);
+  }
+
+  const targetRoot = path.resolve(process.cwd(), projectDir);
+  if (fs.existsSync(targetRoot)) {
+    const entries = fs.readdirSync(targetRoot);
+    if (entries.length > 0) {
+      console.error(`create-xframe: directory is not empty: ${targetRoot}`);
+      process.exit(1);
+    }
+  } else {
+    fs.mkdirSync(targetRoot, { recursive: true });
+  }
+
+  const templateRoot = path.join(__dirname, '..', 'template');
+  if (!fs.existsSync(templateRoot)) {
+    console.error(`create-xframe: template missing at ${templateRoot}`);
+    process.exit(1);
+  }
+
+  fs.cpSync(templateRoot, targetRoot, { recursive: true });
+
+  const vars = {
+    PACKAGE_NAME: packageName,
+    SERVICE_LABEL: packageName,
+    BACKEND_CORE_SPEC: backendCore,
+  };
+
+  for (const file of walkFiles(targetRoot)) {
+    processFile(file, vars);
+  }
+
+  console.log(`Created ${packageName} at ${targetRoot}
+Next:
+  cd ${projectDir}
+  npm install
+  npm run start:dev`);
+}
+
+main();

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@xfilecom/create-xframe",
+  "version": "0.1.0",
+  "description": "Scaffold a Nest app wired to @xfilecom/backend-core (xframe)",
+  "license": "UNLICENSED",
+  "bin": {
+    "create-xframe": "bin/create-xframe.js"
+  },
+  "files": ["bin", "template"],
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "keywords": ["xframe", "nestjs", "xfilecom", "scaffold", "create-xframe"]
+}

package/template/nest-cli.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true
+  }
+}

package/template/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "__PACKAGE_NAME__",
+  "version": "0.0.1",
+  "private": true,
+  "scripts": {
+    "build": "nest build",
+    "start": "nest start",
+    "start:dev": "nest start --watch"
+  },
+  "dependencies": {
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/core": "^10.0.0",
+    "@nestjs/platform-express": "^10.0.0",
+    "@xfilecom/backend-core": "__BACKEND_CORE_SPEC__",
+    "reflect-metadata": "^0.2.0",
+    "rxjs": "^7.8.0"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "^10.0.0",
+    "@types/express": "^4.17.21",
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0"
+  }
+}

package/template/src/app.controller.ts

@@ -0,0 +1,9 @@
+import { Controller, Get } from '@nestjs/common';
+
+@Controller()
+export class AppController {
+  @Get('health')
+  health() {
+    return { ok: true, service: '__SERVICE_LABEL__' };
+  }
+}

package/template/src/app.module.ts

@@ -0,0 +1,14 @@
+import { Module } from '@nestjs/common';
+import { CoreModule } from '@xfilecom/backend-core';
+import { AppController } from './app.controller';
+
+@Module({
+  imports: [
+    CoreModule.forHttpApi({
+      database: { auto: false },
+      guards: { jwt: false },
+    }),
+  ],
+  controllers: [AppController],
+})
+export class AppModule {}

package/template/src/main.ts

@@ -0,0 +1,10 @@
+import 'reflect-metadata';
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+  const port = Number(process.env.PORT) || 3000;
+  await app.listen(port);
+}
+bootstrap();

package/template/tsconfig.build.json

@@ -0,0 +1,5 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "**/*spec.ts"]
+}

package/template/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ES2021",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "strictNullChecks": false,
+    "noImplicitAny": false
+  }
+}