korlix 0.1.0 → 0.1.1

package/README.md

@@ -1,39 +1,523 @@
-# Korlix
+<div align="center">
 
-Korlix is a frontend-first language that compiles .klx files into HTML, CSS, and JavaScript.
+<img src="https://raw.githubusercontent.com/korlix-lang/korlix/main/assets/korlix-logo.svg" alt="Korlix Logo" width="80" height="80" />
 
-Create a new app:
+# korlix
 
+**Create a new Korlix app in seconds.**
+
+[![npm version](https://img.shields.io/npm/v/create-korlix?color=%236366f1\&label=npm\&style=flat-square)](https://www.npmjs.com/package/create-korlix)
+[![npm downloads](https://img.shields.io/npm/dm/create-korlix?color=%2310b981\&style=flat-square)](https://www.npmjs.com/package/create-korlix)
+[![license](https://img.shields.io/npm/l/create-korlix?color=%23f59e0b\&style=flat-square)](https://github.com/korlix-lang/korlix/blob/main/LICENSE)
+[![GitHub stars](https://img.shields.io/github/stars/korlix-lang/korlix?color=%236366f1\&style=flat-square)](https://github.com/korlix-lang/korlix)
+
+**Korlix = Kor + Lix = The Core Matrix**
+
+Build frontend apps with a clean `.klx` language — no React setup, no router setup, no Tailwind setup, no heavy framework boilerplate.
+
+[Documentation](https://github.com/korlix-lang/korlix/tree/main/docs) · [Examples](https://github.com/korlix-lang/korlix/tree/main/examples) · [Report Bug](https://github.com/korlix-lang/korlix/issues) · [NPM Package](https://www.npmjs.com/package/create-korlix)
+
+</div>
+
+---
+
+## What is Korlix?
+
+**Korlix** is a frontend-first programming language that compiles `.klx` source files into optimized **HTML**, **CSS**, and **JavaScript**.
+
+It is designed for developers who want a simpler frontend workflow without manually wiring together React, Vite, React Router, Tailwind, toast libraries, modal libraries, and state boilerplate.
+
+```text
+Korlix = syntax + compiler + styling engine + component system + frontend runtime
+```
+
+With Korlix, you write clean `.klx` files and the compiler generates the frontend output for you.
+
+---
+
+## Why create-korlix?
+
+`create-korlix` is the official project scaffolder for Korlix.
+
+It gives you a React/Vite-like project creation flow:
+
+```bash
+npm create korlix@latest my-app
+```
+
+or, without a folder name:
+
+```bash
+npm create korlix@latest
+```
+
+If no folder name is provided, Korlix asks:
+
+```text
+Project name (my-korlix-app):
+```
+
+After that, it automatically:
+
+```text
+creates the project
+sets SPA mode
+installs dependencies
+starts the dev server
+```
+
+No extra setup is required.
+
+---
+
+## Quick Start
+
+### Create with a folder name
+
+```bash
 npm create korlix@latest my-app
+```
+
+The creator will scaffold the project, install dependencies, and start the dev server.
+
+Open:
+
+```text
+http://localhost:3000
+```
 
-Or:
+---
 
+### Create without a folder name
+
+```bash
 npm create korlix@latest
+```
+
+Korlix will ask for the project name:
+
+```text
+Project name (my-korlix-app):
+```
+
+Then it creates the project, installs dependencies, and starts the dev server.
+
+---
+
+## Other package managers
+
+```bash
+# npm
+npm create korlix@latest my-app
+
+# yarn
+yarn create korlix my-app
+
+# pnpm
+pnpm create korlix my-app
+
+# bun
+bun create korlix my-app
+```
+
+---
+
+## What gets created?
+
+Running:
+
+```bash
+npm create korlix@latest my-app
+```
+
+creates a ready-to-run Korlix project:
+
+```text
+my-app/
+├── korlix.config.json
+├── package.json
+├── public/
+│   └── index.html
+├── src/
+│   ├── main.klx
+│   ├── app.klx
+│   ├── pages/
+│   │   └── index.klx
+│   └── theme/
+│       └── tokens.klx
+└── dist/
+```
+
+The project is created in **SPA mode by default**.
+
+---
+
+## Generated npm scripts
 
-CLI:
+Inside the generated project:
 
-```sh
-korlix new my-app
+```bash
+npm run dev
+npm run build
+npm run preview
+npm run check
+```
+
+These map to the Korlix CLI:
+
+```bash
 korlix dev
 korlix build
+korlix preview
 korlix check
+```
+
+---
+
+## Example Korlix syntax
+
+```klx
+page home route "/":
+
+  state count: int = 0
+
+  section .min-h-screen .center .bg-dark:
+
+    h1 .text-6xl .font-black .text-primary count
+
+    div .flex .gap-4:
+
+      btn .primary "+" on:click:
+        count = count + 1
+        toast success "Updated"
+
+      btn .danger "Reset" on:click:
+        count = 0
+```
+
+This defines a complete interactive page with:
+
+```text
+routing
+state
+events
+buttons
+toast interaction
+utility styling
+```
+
+No JSX. No `useState`. No external router setup.
+
+---
+
+## Korlix language features
+
+Korlix is built around a simple frontend syntax.
+
+### Pages and routing
+
+```klx
+page about route "/about":
+
+  meta:
+    title "About"
+    description "About this app"
+
+  section .py-20 .px-8:
+    h1 .text-4xl .font-bold "About"
+```
+
+### State and events
+
+```klx
+page counter route "/counter":
+
+  state count: int = 0
+
+  btn .primary "Increment" on:click:
+    count = count + 1
+
+  p "Count: " count
+```
+
+### Components
+
+```klx
+component feature-card:
+
+  prop title: string
+  prop description: string
+
+  card .p-6 .rounded-xl .bg-surface:
+    h3 .text-xl .font-bold title
+    p .text-muted description
+```
+
+### Layout-ready structure
+
+```klx
+layout main:
+
+  navbar:
+    link href="/" "Home"
+    link href="/about" "About"
+
+  slot
+
+  footer:
+    p "Built with Korlix"
+```
+
+---
+
+## Built-in frontend workflow
+
+Korlix is designed to reduce repeated frontend setup.
+
+| Need         | Traditional setup     | Korlix approach            |
+| ------------ | --------------------- | -------------------------- |
+| App creation | Vite/React setup      | `npm create korlix@latest` |
+| Routing      | Router package        | Korlix pages/routes        |
+| Styling      | Tailwind setup/config | Built-in utility classes   |
+| State        | Hooks/boilerplate     | `state count: int = 0`     |
+| Toasts       | Toast library         | `toast success "Saved"`    |
+| Modals       | Modal library         | Built-in modal syntax      |
+| Build        | Bundler config        | `korlix build`             |
+| Dev server   | Tooling setup         | `korlix dev`               |
+
+---
+
+## Styling system
+
+Korlix includes a utility-first styling system.
+
+Example:
+
+```klx
+section .min-h-screen .bg-background .text-foreground .flex .items-center .justify-center:
+
+  div .max-w-5xl .text-center:
+    h1 .text-6xl .font-black .text-primary "Hello Korlix"
+    p .text-xl .text-muted "Build faster with less setup."
+```
+
+Common utility groups include:
+
+```text
+layout
+spacing
+typography
+colors
+borders
+radius
+shadow
+responsive variants
+hover/focus states
+dark mode utilities
+```
+
+---
+
+## Hot Drop development
+
+The Korlix dev server supports fast local development.
+
+```bash
+npm run dev
+```
+
+or:
+
+```bash
+korlix dev
+```
+
+The dev server starts at:
+
+```text
+http://localhost:3000
+```
+
+During development, Korlix watches your `.klx` files and updates the browser.
+
+---
+
+## Platform support
+
+The Korlix npm package currently includes binaries for:
+
+```text
+Linux x64
+Windows x64
+```
+
+macOS support is planned.
+
+---
+
+## Requirements
+
+For `create-korlix`:
+
+```text
+Node.js 18+
+npm, yarn, pnpm, or bun
+```
+
+You do **not** need to install Rust separately when using the npm package.
+
+The Rust compiler binary is included through the `korlix` npm package.
+
+---
+
+## CLI reference
+
+After the project is created, you can use:
+
+```bash
+korlix dev
+korlix build
 korlix preview
+korlix check
 ```
 
-Publish:
+Or through npm scripts:
 
-```sh
+```bash
+npm run dev
+npm run build
+npm run preview
+npm run check
+```
+
+---
+
+## Project creation flow
+
+With name:
+
+```bash
+npm create korlix@latest my-app
+```
+
+Without name:
+
+```bash
+npm create korlix@latest
+```
+
+Korlix asks for the project name, creates the app, installs dependencies, and starts the dev server.
+
+---
+
+## Why Korlix?
+
+Korlix is for developers who want:
+
+```text
+a frontend-first language
+less boilerplate
+built-in routing
+built-in styling
+built-in UI interactions
+simple state syntax
+fast app creation
+clean HTML/CSS/JS output
+a lightweight alternative to heavy frontend setup
+```
+
+It is not trying to be React with different syntax. It is a compiler-first frontend language.
+
+---
+
+## Publishing notes for maintainers
+
+Publish the main compiler package first:
+
+```bash
 cd npm/korlix
-npm login
-npm run publish:dry
-npm run publish:public
+npm publish
+```
+
+Then publish the creator package:
+
+```bash
+cd npm/create-korlix
+npm publish
+```
+
+Reason:
+
+```text
+create-korlix depends on korlix
+```
+
+If a version is already published, bump the version before publishing again.
+
+Example:
+
+```text
+0.1.0 → 0.1.1
+```
+
+---
+
+## Contributing
+
+Contributions are welcome.
+
+```bash
+git clone https://github.com/korlix-lang/korlix
+cd korlix
+cargo build --release
+```
+
+Project areas:
+
+```text
+compiler
+lexer
+parser
+codegen
+style engine
+runtime
+CLI
+dev server
+templates
+documentation
 ```
 
-If your npm account has two-factor authentication enabled, pass the current
-6-digit authenticator code:
+Open issues and pull requests on GitHub:
 
-```sh
-npm run publish:public -- --otp=123456
+```text
+https://github.com/korlix-lang/korlix
 ```
 
-Publish this package before publishing `create-korlix`.
+---
+
+## Roadmap
+
+Current direction:
+
+```text
+Phase 1: Compiler core, SPA mode, starter app, dev server
+Phase 2: More diagnostics, stronger validation, macOS binary support
+Phase 3: VS Code extension, docs website, templates
+Phase 4: Stable language spec
+```
+
+---
+
+## License
+
+MIT
+
+---
+
+<div align="center">
+
+**Korlix = Kor + Lix = The Core Matrix**
+
+*Build the frontend. Without the complexity.*
+
+</div>

package/bin/korlix.js

@@ -5,21 +5,16 @@ const path = require("path");
 const fs = require("fs");
 
 function getBinaryName() {
-  const platform = process.platform;
-  const arch = process.arch;
-
-  if (platform === "linux" && arch === "x64") {
+  if (process.platform === "linux" && process.arch === "x64") {
     return "korlix-linux-x64";
   }
 
-  if (platform === "win32" && arch === "x64") {
+  if (process.platform === "win32" && process.arch === "x64") {
     return "korlix-win32-x64.exe";
   }
 
-  console.error(`Unsupported platform: ${platform}-${arch}`);
-  console.error("Supported platforms:");
-  console.error("  linux-x64");
-  console.error("  win32-x64");
+  console.error(`Unsupported platform: ${process.platform}-${process.arch}`);
+  console.error("Supported platforms: linux-x64, win32-x64");
   process.exit(1);
 }
 
@@ -32,7 +27,8 @@ if (!fs.existsSync(binaryPath)) {
 }
 
 const result = spawnSync(binaryPath, process.argv.slice(2), {
-  stdio: "inherit"
+  stdio: "inherit",
+  shell: false
 });
 
 process.exit(result.status ?? 1);

package/package.json

@@ -1,27 +1,24 @@
 {
   "name": "korlix",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Korlix frontend-first language compiler and CLI",
   "license": "MIT",
   "type": "commonjs",
   "bin": {
-    "korlix": "bin/korlix.js"
-  },
-  "scripts": {
-    "build:linux": "cargo build --release -p korlix-cli --manifest-path ../../Cargo.toml && cp ../../target/release/korlix ./bin/korlix-linux-x64.tmp && cp ../../target/release/korlix ./bin/korlix.tmp && mv ./bin/korlix-linux-x64.tmp ./bin/korlix-linux-x64 && mv ./bin/korlix.tmp ./bin/korlix && chmod +x ./bin/korlix ./bin/korlix-linux-x64 ./bin/korlix.js",
-    "verify": "node --check ./bin/korlix.js && node ./bin/korlix.js --help",
-    "prepack": "npm run build:linux && npm run verify",
-    "pack:dry": "npm pack --dry-run",
-    "publish:dry": "npm publish --dry-run --access public",
-    "publish:public": "npm publish --access public"
-  },
-  "publishConfig": {
-    "access": "public"
+    "korlix": "./bin/korlix.js"
   },
   "files": [
-    "bin",
+    "bin/korlix.js",
+    "bin/korlix-linux-x64",
+    "bin/korlix-win32-x64.exe",
     "README.md"
   ],
+  "scripts": {
+    "build:linux": "cargo build --release -p korlix-cli --manifest-path ../../Cargo.toml && cp ../../target/release/korlix ./bin/korlix-linux-x64 && chmod +x ./bin/korlix-linux-x64 ./bin/korlix.js",
+    "build:windows": "cargo build --release -p korlix-cli --manifest-path ../../Cargo.toml --target x86_64-pc-windows-gnu && cp ../../target/x86_64-pc-windows-gnu/release/korlix.exe ./bin/korlix-win32-x64.exe",
+    "verify": "node --check ./bin/korlix.js && node ./bin/korlix.js --help",
+    "prepack": "npm run build:linux && npm run build:windows && npm run verify"
+  },
   "engines": {
     "node": ">=18"
   },
@@ -33,4 +30,4 @@
     "language",
     "spa"
   ]
-}
+}