@elysiumjs/styx 0.8.2 → 0.9.0

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@elysiumjs/styx",
-  "version": "0.8.2",
+  "version": "0.9.0",
   "license": "Apache-2.0",
-  "description": "The CLI tool for the Elysium.js framework.",
+  "description": "The command line tool of the Elysium.js framework: creates projects, generates code and runs app commands.",
   "private": false,
   "author": "Workbud Technologies Inc.",
   "repository": {
@@ -17,13 +17,14 @@
   "scripts": {
     "format": "prettier --write \"./src/**/*.ts\"",
     "clean": "rimraf dist",
-    "build:js": "bun build ./src/styx.ts ./src/index.ts --outdir ./dist --target bun -e @elysiumjs/* --root ./src --minify-syntax --minify-whitespace",
+    "build:js": "bun build ./src/cli.ts ./src/index.ts --outdir ./dist --target bun -e @elysiumjs/* --root ./src --minify-syntax --minify-whitespace",
     "build:ts": "tsc",
     "build": "bun run clean && bun run build:js && bun run build:ts",
     "typecheck": "tsc --noEmit",
     "prepublishOnly": "bun run build",
     "test": "bun test",
-    "test:coverage": "bun test --coverage"
+    "test:coverage": "bun test --coverage",
+    "build:bin": "bun scripts/build-bin.ts"
   },
   "keywords": [
     "elysium",
@@ -36,26 +37,28 @@
   "type": "module",
   "sideEffects": false,
   "bin": {
-    "styx": "dist/styx.js"
+    "styx": "dist/cli.js"
   },
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist",
     "stubs",
+    "templates",
     "CHANGELOG.md"
   ],
   "devDependencies": {
-    "@elysiumjs/core": "0.10.0",
-    "@elysiumjs/heracles": "0.7.2",
+    "@elysiumjs/core": "0.11.0",
+    "@elysiumjs/hephaestus": "0.4.0",
+    "@elysiumjs/runtime-bun": "0.1.0",
     "@types/prompts": "^2.4.9",
     "@types/string-template": "^1.0.7",
     "prompts": "^2.4.2",
     "radash": "^12.1.1",
     "string-template": "^1.0.0"
   },
-  "peerDependencies": {
-    "@elysiumjs/core": "^0.10.0",
-    "@elysiumjs/heracles": "^0.7.2"
+  "dependencies": {
+    "@elysiumjs/core": "^0.11.0",
+    "@elysiumjs/runtime-bun": "^0.1.0"
   }
 }

package/stubs/http.controller.stub

@@ -1,6 +1,6 @@
 import { Http, HttpControllerScope } from '@elysiumjs/core';
 
-@Http.controller({ path: '{path}', scope: HttpControllerScope.{scope} })
+@Http.controller('{path}', { scope: HttpControllerScope.{scope} })
 export class {name} {
     @Http.get()
     public async get() {

package/stubs/ws.controller.stub

@@ -2,7 +2,7 @@ import type { WS, WSError } from '@elysiumjs/core';
 
 import { Websocket } from '@elysiumjs/core';
 
-@Websocket.controller({ path: '{path}' })
+@Websocket.controller('{path}')
 export class {name} {
 	@Websocket.onOpen()
 	private onOpen() {

package/templates/feature-hephaestus/.specs

@@ -0,0 +1,7 @@
+{
+	"packages": {
+		"dev": [
+			"@elysiumjs/hephaestus"
+		]
+	}
+}

package/templates/feature-hephaestus/hephaestus.config.ts

@@ -0,0 +1,7 @@
+import type { HephaestusConfig } from '@elysiumjs/hephaestus';
+
+export default {
+	output: {
+		name: '{PROJECT_NAME}'
+	}
+} satisfies HephaestusConfig;

package/templates/feature-prettier/.prettierignore

@@ -0,0 +1,5 @@
+# Package Managers
+package-lock.json
+pnpm-lock.yaml
+yarn.lock
+bun.lock

package/templates/feature-prettier/.prettierrc

@@ -0,0 +1,23 @@
+{
+	"useTabs": true,
+	"singleQuote": true,
+	"trailingComma": "none",
+	"printWidth": 100,
+	"plugins": ["@ianvs/prettier-plugin-sort-imports"],
+	"importOrder": [
+		"<TYPES>^(node:)",
+		"<TYPES>",
+		"<TYPES>^[.]",
+		"",
+		"<BUILTIN_MODULES>",
+		"",
+		"<THIRD_PARTY_MODULES>",
+		"",
+		"^\\#",
+		"",
+		"^[.]"
+	],
+	"importOrderParserPlugins": ["typescript", "decorators-legacy"],
+	"importOrderTypeScriptVersion": "5.8.0",
+	"overrides": []
+}

package/templates/feature-prettier/.specs

@@ -0,0 +1,13 @@
+{
+	"packages": {
+		"dev": [
+			"@ianvs/prettier-plugin-sort-imports",
+			"prettier"
+		]
+	},
+	"patch": {
+		"scripts": {
+			"format": "prettier --write \"./**/*.ts\""
+		}
+	}
+}

package/templates/plugin-sentry/.env.example

@@ -0,0 +1,2 @@
+# Required by SentryModule: boot fails without a DSN.
+SENTRY_DSN=

package/templates/plugin-sentry/.specs

@@ -0,0 +1,12 @@
+{
+	"packages": {
+		"prod": [
+			"@elysiumjs/plugin-sentry"
+		]
+	},
+	"module": {
+		"name": "@elysiumjs/plugin-sentry",
+		"import": "SentryModule",
+		"expression": "SentryModule.with({})"
+	}
+}

package/templates/template-multi/.gitattributes

@@ -0,0 +1,15 @@
+# Set default behavior to automatically normalize line endings
+* text=auto eol=lf
+
+# Denote all files that are truly binary and should not be modified.
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.ico binary
+*.woff binary
+*.woff2 binary
+*.ttf binary
+*.eot binary
+*.pdf binary
+*.zip binary

package/templates/template-multi/README.md

@@ -0,0 +1,20 @@
+# {PROJECT_NAME}
+
+A web application built with Elysium.
+
+## Getting Started
+
+Install the dependencies, then start the app in development:
+
+```bash
+{INSTALL}
+{RUN} dev
+```
+
+You can now access the application at http://localhost:3000.
+
+To list the `styx` commands, run:
+
+```bash
+styx
+```

package/templates/template-multi/gitignore

@@ -0,0 +1,45 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# vercel
+.vercel
+
+**/*.trace
+**/*.zip
+**/*.tar.gz
+**/*.tgz
+**/*.log
+package-lock.json
+**/*.bun
+
+# route types written by `styx routes:generate`
+src/routes.gen.ts

package/templates/template-multi/index.ts

@@ -0,0 +1,10 @@
+import type { LifecycleEvent } from '@elysiumjs/core';
+
+import { Lifecycle } from '@elysiumjs/core';
+import { App } from '#root/app';
+
+Lifecycle.on('elysium:error', (e: LifecycleEvent<Error>) => {
+	console.error(JSON.stringify(e));
+});
+
+await App.start();

package/templates/template-multi/package.json

@@ -0,0 +1,8 @@
+{
+	"name": "{PROJECT_NAME}",
+	"type": "module",
+	"private": true,
+	"imports": {
+		"#root/*": "./src/*.ts"
+	}
+}

package/templates/template-multi/tsconfig.json

@@ -0,0 +1,32 @@
+{
+  "compilerOptions": {
+    // Environment setup & latest features
+    "lib": [
+      "ESNext"
+    ],
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleDetection": "force",
+    "allowJs": true,
+    "types": [
+      "bun-types" // add Bun global
+    ],
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": false,
+    "forceConsistentCasingInFileNames": true,
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noPropertyAccessFromIndexSignature": false,
+  }
+}

package/templates/template-multi/types.d.ts

@@ -0,0 +1,5 @@
+import '@elysiumjs/core';
+
+declare module '@elysiumjs/core' {
+	type AppEnv = typeof import('./src/app').env.static;
+}

package/templates/template-single/.gitattributes

@@ -0,0 +1,15 @@
+# Set default behavior to automatically normalize line endings
+* text=auto eol=lf
+
+# Denote all files that are truly binary and should not be modified.
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.ico binary
+*.woff binary
+*.woff2 binary
+*.ttf binary
+*.eot binary
+*.pdf binary
+*.zip binary

package/templates/template-single/README.md

@@ -0,0 +1,20 @@
+# {PROJECT_NAME}
+
+A web application built with Elysium.
+
+## Getting Started
+
+Install the dependencies, then start the app in development:
+
+```bash
+{INSTALL}
+{RUN} dev
+```
+
+You can now access the application at http://localhost:3000.
+
+To list the `styx` commands, run:
+
+```bash
+styx
+```

package/templates/template-single/gitignore

@@ -0,0 +1,45 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# vercel
+.vercel
+
+**/*.trace
+**/*.zip
+**/*.tar.gz
+**/*.tgz
+**/*.log
+package-lock.json
+**/*.bun
+
+# route types written by `styx routes:generate`
+src/routes.gen.ts

package/templates/template-single/index.ts

@@ -0,0 +1,10 @@
+import type { LifecycleEvent } from '@elysiumjs/core';
+
+import { Lifecycle } from '@elysiumjs/core';
+import { App } from '#root/app';
+
+Lifecycle.on('elysium:error', (e: LifecycleEvent<Error>) => {
+	console.error(JSON.stringify(e));
+});
+
+await App.start();

package/templates/template-single/package.json

@@ -0,0 +1,8 @@
+{
+	"name": "{PROJECT_NAME}",
+	"type": "module",
+	"private": true,
+	"imports": {
+		"#root/*": "./src/*.ts"
+	}
+}

package/templates/template-single/tsconfig.json

@@ -0,0 +1,32 @@
+{
+  "compilerOptions": {
+    // Environment setup & latest features
+    "lib": [
+      "ESNext"
+    ],
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleDetection": "force",
+    "allowJs": true,
+    "types": [
+      "bun-types" // add Bun global
+    ],
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": false,
+    "forceConsistentCasingInFileNames": true,
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noPropertyAccessFromIndexSignature": false,
+  }
+}

package/templates/template-single/types.d.ts

@@ -0,0 +1,5 @@
+import '@elysiumjs/core';
+
+declare module '@elysiumjs/core' {
+	type AppEnv = typeof import('./src/app').env.static;
+}

package/dist/styx.js

@@ -1,11 +0,0 @@
-#!/usr/bin/env bun
-// @bun
-import{ElysiumError as ElysiumError2}from"@elysiumjs/core";import{existsSync}from"fs";import{mkdir,readdir,rename}from"fs/promises";import{dirname,extname,join}from"path";import{Application,ElysiumError}from"@elysiumjs/core";var capitalize=(str)=>{if(!str||str.length===0)return"";let lower=str.toLowerCase();return lower.substring(0,1).toUpperCase()+lower.substring(1,lower.length)};var snake=(str,options)=>{let parts=str?.replace(/([A-Z])+/g,capitalize).split(/(?=[A-Z])|[\.\-\s_]/).map((x)=>x.toLowerCase())??[];if(parts.length===0)return"";if(parts.length===1)return parts[0];let result=parts.reduce((acc,part)=>`${acc}_${part.toLowerCase()}`);return options?.splitOnNumber===!1?result:result.replace(/([A-Za-z]{1}[0-9]{1})/,(val)=>`${val[0]}_${val[1]}`)};var pascal=(str)=>{let parts=str?.split(/[\.\-\s_]/).map((x)=>x.toLowerCase())??[];if(parts.length===0)return"";return parts.map((str2)=>str2.charAt(0).toUpperCase()+str2.slice(1)).join("")};var trim=(str,charsToTrim=" ")=>{if(!str)return"";let toTrim=charsToTrim.replace(/[\W]{1}/g,"\\$&"),regex=new RegExp(`^[${toTrim}]+|[${toTrim}]+$`,"g");return str.replace(regex,"")};class AppEntryNotFoundError extends ElysiumError{path;constructor(path){super(`Could not find an exported Application class in ${path}`);this.path=path}}var resolveAppEntry=async(projectPath)=>{let appFile=join(projectPath,"src","app.ts"),entry=existsSync(appFile)?appFile:join(projectPath,"index.ts"),exports=await import(entry);for(let value of Object.values(exports))if(typeof value==="function"&&value.prototype instanceof Application)return value;throw new AppEntryNotFoundError(entry)},getRootPath=()=>dirname(Bun.fileURLToPath(import.meta.url)),getProjectPath=()=>{let startPath=process.cwd(),dir=startPath;while(!0){if(existsSync(join(dir,".elysiumrc")))return dir;let parentDir=dirname(dir);if(dir===parentDir)break;dir=parentDir}return startPath},createModule=async(name,oldName)=>{let root=getProjectPath();{let moduleDir=join(root,"src","modules",name);if(await mkdir(moduleDir,{recursive:!0}),!oldName){let moduleFile=join(moduleDir,`${name}.module.ts`);if(!existsSync(moduleFile)){let className=`${pascal(name)}Module`;await Bun.write(moduleFile,`import { Module } from '@elysiumjs/core';
-
-@Module.register({
-	services: [],
-	controllers: [],
-	commands: []
-})
-export class ${className} extends Module {}
-`)}}if(oldName)if(oldName==="root"){let entries=await readdir(join(root,"src"));for(let entry of entries){if(["app.ts","env.ts","database","modules"].includes(entry))continue;let oldPath=join(root,"src",entry),newPath=join(moduleDir,entry==="main.module.ts"?`${name}.module.ts`:entry);await rename(oldPath,newPath)}}else{let oldModuleDir=join(root,"src","modules",oldName);await rename(oldModuleDir,moduleDir)}}{let pkg=await Bun.file(join(root,"package.json")).json();if(pkg.imports=pkg.imports??{},pkg.imports[`#${name}/*`]=`./src/modules/${name}/*.ts`,oldName&&oldName!=="root")delete pkg.imports[`#${oldName}/*`];await Bun.write(join(root,"package.json"),JSON.stringify(pkg,null,2))}{let rc=await Bun.file(join(root,".elysiumrc")).json();if(rc.mono=!1,rc.modules=rc.modules??{},rc.modules[name]=`./src/modules/${name}`,oldName)delete rc.modules[oldName];await Bun.write(join(root,".elysiumrc"),JSON.stringify(rc,null,2))}if(oldName){let rewriteImports=async(dir)=>{let entries=await readdir(dir,{withFileTypes:!0});for(let entry of entries){let fullPath=join(dir,entry.name);if(entry.isDirectory())await rewriteImports(fullPath);else if(extname(entry.name)===".ts"){let text=await Bun.file(fullPath).text();if(oldName==="root")text=text.replace(new RegExp(`(['"])#${oldName}/((?!(env|app|database(?:/|$))).*?)(['"])`,"g"),`$1#${name}/$2$4`);else text=text.replace(new RegExp(`(['"])#${oldName}/`,"g"),`$1#${name}/`);text=text.replace(new RegExp(`(['"])#${oldName}/main\\.module(['"])/g`,"g"),`$1#${name}/${name}.module$2`),text=text.replace(new RegExp(`(['"])#${oldName}/main\\.module\\.ts(['"])?/g`,"g"),`$1#${name}/${name}.module$2`),await Bun.write(fullPath,text)}}};await rewriteImports(root)}};try{await(await resolveAppEntry(getProjectPath())).start()}catch(error){if(error instanceof ElysiumError2)console.error(error.message),process.exit(1);throw error}