@confluxjs/create-conflux 0.1.0

package/README.md

@@ -0,0 +1,27 @@
+# @confluxjs/create-conflux
+
+Scaffold a new Conflux bot project.
+
+## Usage
+
+```bash
+bunx create-conflux
+# npm: npm create @confluxjs/create-conflux@latest
+# pnpm: pnpm create @confluxjs/create-conflux
+```
+
+## Publishing (maintainers)
+
+Build and publish from the monorepo root (see [root README](../../README.md#publishing) or `packages/conflux/README.md`). This package is published as `@confluxjs/create-conflux`.
+
+## Scripts
+
+| Script                | Description |
+| --------------------- | ----------- |
+| `bun run build`       | Build CLI   |
+| `bun run check-types` | Typecheck   |
+| `bun run lint`        | ESLint      |
+
+## Links
+
+- [Manual installation](https://conflux.js.org/guides/manual-installation)

package/dist/cli.cjs

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/cli.d.cts

@@ -0,0 +1 @@
+export { };

package/dist/cli.d.ts

@@ -0,0 +1 @@
+export { };

package/dist/cli.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {  };

package/dist/index.cjs

@@ -0,0 +1,54 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+let __clack_prompts = require("@clack/prompts");
+__clack_prompts = __toESM(__clack_prompts);
+let picocolors = require("picocolors");
+picocolors = __toESM(picocolors);
+let validate_npm_package_name = require("validate-npm-package-name");
+validate_npm_package_name = __toESM(validate_npm_package_name);
+
+//#region src/lib/create-project.ts
+async function runCreateConflux(options = {}) {
+	__clack_prompts.intro(picocolors.default.bgCyan(picocolors.default.black(" create-conflux ")));
+	const name = options.name ?? await __clack_prompts.text({
+		message: "Project name",
+		placeholder: "my-conflux-bot",
+		validate(value) {
+			if (!value) return "Name is required";
+			const result = (0, validate_npm_package_name.default)(value);
+			if (!result.validForNewPackages) return result.errors?.[0] ?? result.warnings?.[0] ?? "Invalid package name";
+		}
+	});
+	if (__clack_prompts.isCancel(name)) {
+		__clack_prompts.cancel("Cancelled");
+		return 1;
+	}
+	__clack_prompts.log.info(`Scaffold stub — would create ${picocolors.default.cyan(String(name))} in ${options.cwd ?? process.cwd()}`);
+	__clack_prompts.outro(picocolors.default.green("Done"));
+	return 0;
+}
+
+//#endregion
+exports.runCreateConflux = runCreateConflux;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":["pc","p"],"sources":["../src/lib/create-project.ts"],"sourcesContent":["import * as p from \"@clack/prompts\";\nimport pc from \"picocolors\";\nimport validatePackageName from \"validate-npm-package-name\";\n\nexport type CreateConfluxOptions = {\n  name?: string;\n  cwd?: string;\n};\n\nexport async function runCreateConflux(options: CreateConfluxOptions = {}): Promise<number> {\n  p.intro(pc.bgCyan(pc.black(\" create-conflux \")));\n\n  const name =\n    options.name ??\n    (await p.text({\n      message: \"Project name\",\n      placeholder: \"my-conflux-bot\",\n      validate(value) {\n        if (!value) return \"Name is required\";\n        const result = validatePackageName(value);\n        if (!result.validForNewPackages) {\n          return result.errors?.[0] ?? result.warnings?.[0] ?? \"Invalid package name\";\n        }\n      },\n    }));\n\n  if (p.isCancel(name)) {\n    p.cancel(\"Cancelled\");\n    return 1;\n  }\n\n  p.log.info(\n    `Scaffold stub — would create ${pc.cyan(String(name))} in ${options.cwd ?? process.cwd()}`,\n  );\n  p.outro(pc.green(\"Done\"));\n  return 0;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AASA,eAAsB,iBAAiB,UAAgC,EAAE,EAAmB;AAC1F,iBAAE,MAAMA,mBAAG,OAAOA,mBAAG,MAAM,mBAAmB,CAAC,CAAC;CAEhD,MAAM,OACJ,QAAQ,QACP,MAAMC,gBAAE,KAAK;EACZ,SAAS;EACT,aAAa;EACb,SAAS,OAAO;AACd,OAAI,CAAC,MAAO,QAAO;GACnB,MAAM,gDAA6B,MAAM;AACzC,OAAI,CAAC,OAAO,oBACV,QAAO,OAAO,SAAS,MAAM,OAAO,WAAW,MAAM;;EAG1D,CAAC;AAEJ,KAAIA,gBAAE,SAAS,KAAK,EAAE;AACpB,kBAAE,OAAO,YAAY;AACrB,SAAO;;AAGT,iBAAE,IAAI,KACJ,gCAAgCD,mBAAG,KAAK,OAAO,KAAK,CAAC,CAAC,MAAM,QAAQ,OAAO,QAAQ,KAAK,GACzF;AACD,iBAAE,MAAMA,mBAAG,MAAM,OAAO,CAAC;AACzB,QAAO"}

package/dist/index.d.cts

@@ -0,0 +1,9 @@
+//#region src/lib/create-project.d.ts
+type CreateConfluxOptions = {
+  name?: string;
+  cwd?: string;
+};
+declare function runCreateConflux(options?: CreateConfluxOptions): Promise<number>;
+//#endregion
+export { type CreateConfluxOptions, runCreateConflux };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/lib/create-project.ts"],"sourcesContent":[],"mappings":";KAIY,oBAAA;EAAA,IAAA,CAAA,EAAA,MAAA;EAKU,GAAA,CAAA,EAAA,MAAA;;iBAAA,gBAAA,WAA0B,uBAA4B"}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+//#region src/lib/create-project.d.ts
+type CreateConfluxOptions = {
+  name?: string;
+  cwd?: string;
+};
+declare function runCreateConflux(options?: CreateConfluxOptions): Promise<number>;
+//#endregion
+export { type CreateConfluxOptions, runCreateConflux };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/lib/create-project.ts"],"sourcesContent":[],"mappings":";KAIY,oBAAA;EAAA,IAAA,CAAA,EAAA,MAAA;EAKU,GAAA,CAAA,EAAA,MAAA;;iBAAA,gBAAA,WAA0B,uBAA4B"}

package/dist/index.js

@@ -0,0 +1,28 @@
+import * as p from "@clack/prompts";
+import pc from "picocolors";
+import validatePackageName from "validate-npm-package-name";
+
+//#region src/lib/create-project.ts
+async function runCreateConflux(options = {}) {
+	p.intro(pc.bgCyan(pc.black(" create-conflux ")));
+	const name = options.name ?? await p.text({
+		message: "Project name",
+		placeholder: "my-conflux-bot",
+		validate(value) {
+			if (!value) return "Name is required";
+			const result = validatePackageName(value);
+			if (!result.validForNewPackages) return result.errors?.[0] ?? result.warnings?.[0] ?? "Invalid package name";
+		}
+	});
+	if (p.isCancel(name)) {
+		p.cancel("Cancelled");
+		return 1;
+	}
+	p.log.info(`Scaffold stub — would create ${pc.cyan(String(name))} in ${options.cwd ?? process.cwd()}`);
+	p.outro(pc.green("Done"));
+	return 0;
+}
+
+//#endregion
+export { runCreateConflux };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/lib/create-project.ts"],"sourcesContent":["import * as p from \"@clack/prompts\";\nimport pc from \"picocolors\";\nimport validatePackageName from \"validate-npm-package-name\";\n\nexport type CreateConfluxOptions = {\n  name?: string;\n  cwd?: string;\n};\n\nexport async function runCreateConflux(options: CreateConfluxOptions = {}): Promise<number> {\n  p.intro(pc.bgCyan(pc.black(\" create-conflux \")));\n\n  const name =\n    options.name ??\n    (await p.text({\n      message: \"Project name\",\n      placeholder: \"my-conflux-bot\",\n      validate(value) {\n        if (!value) return \"Name is required\";\n        const result = validatePackageName(value);\n        if (!result.validForNewPackages) {\n          return result.errors?.[0] ?? result.warnings?.[0] ?? \"Invalid package name\";\n        }\n      },\n    }));\n\n  if (p.isCancel(name)) {\n    p.cancel(\"Cancelled\");\n    return 1;\n  }\n\n  p.log.info(\n    `Scaffold stub — would create ${pc.cyan(String(name))} in ${options.cwd ?? process.cwd()}`,\n  );\n  p.outro(pc.green(\"Done\"));\n  return 0;\n}\n"],"mappings":";;;;;AASA,eAAsB,iBAAiB,UAAgC,EAAE,EAAmB;AAC1F,GAAE,MAAM,GAAG,OAAO,GAAG,MAAM,mBAAmB,CAAC,CAAC;CAEhD,MAAM,OACJ,QAAQ,QACP,MAAM,EAAE,KAAK;EACZ,SAAS;EACT,aAAa;EACb,SAAS,OAAO;AACd,OAAI,CAAC,MAAO,QAAO;GACnB,MAAM,SAAS,oBAAoB,MAAM;AACzC,OAAI,CAAC,OAAO,oBACV,QAAO,OAAO,SAAS,MAAM,OAAO,WAAW,MAAM;;EAG1D,CAAC;AAEJ,KAAI,EAAE,SAAS,KAAK,EAAE;AACpB,IAAE,OAAO,YAAY;AACrB,SAAO;;AAGT,GAAE,IAAI,KACJ,gCAAgC,GAAG,KAAK,OAAO,KAAK,CAAC,CAAC,MAAM,QAAQ,OAAO,QAAQ,KAAK,GACzF;AACD,GAAE,MAAM,GAAG,MAAM,OAAO,CAAC;AACzB,QAAO"}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@confluxjs/create-conflux",
+  "version": "0.1.0",
+  "description": "Scaffold a new Conflux bot project",
+  "keywords": [
+    "conflux",
+    "fluxer",
+    "bot",
+    "create",
+    "scaffold",
+    "cli"
+  ],
+  "homepage": "https://conflux.js.org",
+  "bugs": "https://github.com/maybeizen/confluxjs/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/maybeizen/confluxjs.git",
+    "directory": "packages/create-conflux"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./cli": {
+      "types": "./dist/cli.d.ts",
+      "import": "./dist/cli.js",
+      "require": "./dist/cli.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "create-conflux": "./dist/cli.cjs"
+  },
+  "files": [
+    "dist",
+    "templates",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "check-types": "tsc -p tsconfig.json --noEmit",
+    "clean": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\"",
+    "dev": "tsdown --watch",
+    "lint": "eslint src",
+    "prepublishOnly": "bun run build"
+  },
+  "dependencies": {
+    "@clack/prompts": "^0.10.0",
+    "picocolors": "^1.1.1",
+    "validate-npm-package-name": "^6.0.0"
+  },
+  "devDependencies": {
+    "@confluxjs/tsconfig": "workspace:*",
+    "@types/node": "^22.0.0",
+    "tsdown": "catalog:build",
+    "typescript": "catalog:build"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/templates/default/.env.example

@@ -0,0 +1 @@
+FLUXER_BOT_TOKEN=

package/templates/default/conflux.config.ts

@@ -0,0 +1,3 @@
+import { defineConfig } from "@confluxjs/conflux";
+
+export default defineConfig({});

package/templates/default/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "my-conflux-bot",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "conflux build",
+    "dev": "conflux dev",
+    "start": "conflux start"
+  },
+  "dependencies": {
+    "@confluxjs/conflux": "latest",
+    "@fluxerjs/core": "^2.1.0"
+  },
+  "devDependencies": {
+    "@confluxjs/tsconfig": "latest",
+    "typescript": "^5.9.2"
+  }
+}

package/templates/default/src/commands/[utility]/pong.ts

@@ -0,0 +1,9 @@
+import type { MessageCommand } from "@confluxjs/conflux";
+
+export const data = {
+  name: "pong",
+};
+
+export const message: MessageCommand = async (ctx) => {
+  await ctx.message.reply(ctx.args().join(" ") || "Pong!");
+};

package/templates/default/src/commands/ping.ts

@@ -0,0 +1,9 @@
+import type { MessageCommand } from "@confluxjs/conflux";
+
+export const data = {
+  name: "ping",
+};
+
+export const message: MessageCommand = async (ctx) => {
+  await ctx.message.reply("Pong!");
+};

package/templates/default/src/events/ready/01-log.ts

@@ -0,0 +1,7 @@
+import type { EventHandler } from "@confluxjs/conflux";
+
+const handler: EventHandler<"ready"> = (ctx) => {
+  console.log(`Logged in as ${ctx.client.user?.username ?? "unknown"}`);
+};
+
+export default handler;

package/templates/default/src/index.ts

@@ -0,0 +1,10 @@
+import type { Conflux } from "@confluxjs/conflux";
+import { Client } from "@fluxerjs/core";
+
+const client = new Client({ intents: 0 });
+
+export async function configure(conflux: Conflux) {
+  conflux.setPrefix(async () => ["!"]);
+}
+
+export { client };

package/templates/default/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@confluxjs/tsconfig/node.json",
+  "compilerOptions": {
+    "rootDir": "."
+  },
+  "include": ["src", "conflux.config.ts"]
+}