create-nextly-app 0.0.1 → 0.0.2-alpha.1

package/dist/index.d.cts

@@ -0,0 +1,69 @@
+/**
+ * Project type / template selection.
+ * "blog" is the first content template added for alpha.
+ */
+type ProjectType = "blank" | "blog";
+/**
+ * Schema approach selection for content templates.
+ * - code-first: Full schema definitions in nextly.config.ts (like Payload CMS)
+ * - visual: Empty config, schemas created via Admin Panel UI (like Strapi/WordPress)
+ * - both: Core schemas in code, additional schemas creatable via Admin Panel
+ */
+type ProjectApproach = "code-first" | "visual";
+/**
+ * Supported database types
+ */
+type DatabaseType = "postgresql" | "mysql" | "sqlite";
+/**
+ * Options for createNextly function
+ */
+interface CreateNextlyOptions {
+    /** Working directory (defaults to process.cwd()) */
+    cwd?: string;
+    /** Skip interactive prompts and use defaults */
+    defaults?: boolean;
+    /** Pre-selected project type / template name */
+    projectType?: ProjectType;
+    /** Pre-selected database type */
+    database?: DatabaseType;
+    /** Skip dependency installation (useful for local testing before packages are published) */
+    skipInstall?: boolean;
+    /** Use yalc for local package installation (for testing before npm publish) */
+    useYalc?: boolean;
+    /**
+     * Project name derived from the CLI's positional `[directory]` argument.
+     * Must be a bare directory name (no slashes). Callers pass the basename
+     * of the user-provided argument.
+     */
+    projectNameFromArg?: string;
+    /**
+     * When true, the CLI was invoked with "." meaning "install in current directory".
+     * Different from projectNameFromArg which creates a subdirectory.
+     */
+    installInCwd?: boolean;
+    /** Schema approach for content templates (code-first, visual) */
+    approach?: ProjectApproach;
+    /** Path to local templates directory (for development, bypasses GitHub download) */
+    localTemplatePath?: string;
+    /** Git branch for template download from GitHub (defaults to "main") */
+    branch?: string;
+}
+
+/**
+ * Main entry point for scaffolding Nextly in a Next.js project.
+ *
+ * Two flows:
+ * 1. Empty directory -> scaffold Next.js + install Nextly
+ * 2. Existing Next.js project -> install Nextly into it
+ *
+ * Interactive prompt order:
+ * 1. Project name (or detect existing project)
+ * 2. Template selection (blank, blog, etc.)
+ * 3. Schema approach (code-first, visual) — only for content templates
+ * 4. Demo content (yes/no) - only for content templates
+ * 5. Database selection (sqlite, postgresql, mysql)
+ * 6. Database connection string (only for postgresql/mysql)
+ */
+declare function createNextly(options?: CreateNextlyOptions): Promise<void>;
+
+export { type CreateNextlyOptions, createNextly };

package/dist/index.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Project type / template selection.
+ * "blog" is the first content template added for alpha.
+ */
+type ProjectType = "blank" | "blog";
+/**
+ * Schema approach selection for content templates.
+ * - code-first: Full schema definitions in nextly.config.ts (like Payload CMS)
+ * - visual: Empty config, schemas created via Admin Panel UI (like Strapi/WordPress)
+ * - both: Core schemas in code, additional schemas creatable via Admin Panel
+ */
+type ProjectApproach = "code-first" | "visual";
+/**
+ * Supported database types
+ */
+type DatabaseType = "postgresql" | "mysql" | "sqlite";
+/**
+ * Options for createNextly function
+ */
+interface CreateNextlyOptions {
+    /** Working directory (defaults to process.cwd()) */
+    cwd?: string;
+    /** Skip interactive prompts and use defaults */
+    defaults?: boolean;
+    /** Pre-selected project type / template name */
+    projectType?: ProjectType;
+    /** Pre-selected database type */
+    database?: DatabaseType;
+    /** Skip dependency installation (useful for local testing before packages are published) */
+    skipInstall?: boolean;
+    /** Use yalc for local package installation (for testing before npm publish) */
+    useYalc?: boolean;
+    /**
+     * Project name derived from the CLI's positional `[directory]` argument.
+     * Must be a bare directory name (no slashes). Callers pass the basename
+     * of the user-provided argument.
+     */
+    projectNameFromArg?: string;
+    /**
+     * When true, the CLI was invoked with "." meaning "install in current directory".
+     * Different from projectNameFromArg which creates a subdirectory.
+     */
+    installInCwd?: boolean;
+    /** Schema approach for content templates (code-first, visual) */
+    approach?: ProjectApproach;
+    /** Path to local templates directory (for development, bypasses GitHub download) */
+    localTemplatePath?: string;
+    /** Git branch for template download from GitHub (defaults to "main") */
+    branch?: string;
+}
+
+/**
+ * Main entry point for scaffolding Nextly in a Next.js project.
+ *
+ * Two flows:
+ * 1. Empty directory -> scaffold Next.js + install Nextly
+ * 2. Existing Next.js project -> install Nextly into it
+ *
+ * Interactive prompt order:
+ * 1. Project name (or detect existing project)
+ * 2. Template selection (blank, blog, etc.)
+ * 3. Schema approach (code-first, visual) — only for content templates
+ * 4. Demo content (yes/no) - only for content templates
+ * 5. Database selection (sqlite, postgresql, mysql)
+ * 6. Database connection string (only for postgresql/mysql)
+ */
+declare function createNextly(options?: CreateNextlyOptions): Promise<void>;
+
+export { type CreateNextlyOptions, createNextly };

package/dist/index.mjs

@@ -0,0 +1,6 @@
+import { createRequire } from 'module';
+export { createNextly } from './chunk-AYJ2RKVJ.mjs';
+
+createRequire(import.meta.url);
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.mjs"}

package/package.json

@@ -1,13 +1,86 @@
 {
   "name": "create-nextly-app",
-  "version": "0.0.1",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "version": "0.0.2-alpha.1",
+  "description": "CLI to scaffold Nextly in your Next.js project",
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/index.mjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "create-nextly-app": "./bin/create-nextly-app.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "bin",
+    "templates"
+  ],
+  "dependencies": {
+    "@clack/prompts": "^1.1.0",
+    "commander": "^14.0.2",
+    "execa": "^9.6.0",
+    "fs-extra": "^11.3.0",
+    "ora": "^9.0.0",
+    "picocolors": "^1.1.1",
+    "tar": "^7.4.0"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/tar": "^6.1.13",
+    "@types/node": "^20.19.17",
+    "@vitest/coverage-v8": "^4.0.8",
+    "@vitest/ui": "^4.0.8",
+    "eslint": "^9.34.0",
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.3",
+    "vite-tsconfig-paths": "^5.1.4",
+    "vitest": "^4.0.8",
+    "@nextlyhq/eslint-config": "0.0.2-alpha.0",
+    "@nextlyhq/telemetry": "0.0.2-alpha.0",
+    "@nextlyhq/tsconfig": "0.0.2-alpha.0"
+  },
+  "engines": {
+    "node": ">=20.0.0"
   },
-  "keywords": [],
-  "author": "mobeenabdullah",
-  "license": "ISC",
-  "type": "commonjs"
-}
+  "keywords": [
+    "nextly",
+    "cms",
+    "nextjs",
+    "cli",
+    "scaffold",
+    "create-nextly-app",
+    "create-app"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nextlyhq/nextly.git",
+    "directory": "packages/create-nextly-app"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/",
+    "provenance": true
+  },
+  "homepage": "https://nextlyhq.com",
+  "bugs": {
+    "url": "https://github.com/nextlyhq/nextly/issues"
+  },
+  "author": "Nextly <contact@nextlyhq.com> (https://nextlyhq.com)",
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "check-types": "tsc --noEmit",
+    "lint": "eslint . --max-warnings 0",
+    "lint:fix": "eslint . --fix",
+    "test": "vitest run --passWithNoTests",
+    "test:watch": "vitest",
+    "clean": "rimraf dist"
+  }
+}