neutronium 3.3.8 → 3.4.0

package/README.md

@@ -1,65 +1,75 @@
-# ⚛️ Neutronium v3.3.8
+# ⚛️ Neutronium v3.4.0
 
 **Ultra-dense JavaScript framework – maximum performance, minimal overhead**
 
-[![npm](https://img.shields.io/badge/Downloads-3.2k-CB3837?logo=npm&logoColor=CB3837&style=flat-square)](https://www.npmjs.com/package/neutronium)
-[![License: MIT](https://img.shields.io/npm/l/neutronium?style=flat-square)](https://opensource.org/licenses/MIT)
+[![npm](https://img.shields.io/npm/dw/neutronium?style=flat-square&logo=npm)](https://www.npmjs.com/package/neutronium)
 [![Version](https://img.shields.io/npm/v/neutronium?style=flat-square)](https://www.npmjs.com/package/neutronium)
-[![Website](https://img.shields.io/badge/Neutronium_Website-online-0bff03?logo=GoogleChrome&logoColor=d4d2d2&style=flat-square)](https://neutronium-website.onrender.com)
-[![Playground](https://img.shields.io/badge/Online_Playground-0368ff?logo=stackblitz&style=flat-square)](https://neutronium-website.onrender.com/Playground/)
-[![Documentation](https://img.shields.io/badge/Documentation-3d3c3b?logo=readthedocs&style=flat-square)](https://neutronium-website.onrender.com/Docuemntation/)
+[![License](https://img.shields.io/npm/l/neutronium?style=flat-square)](https://opensource.org/licenses/MIT)
+[![Website](https://img.shields.io/badge/Website-Online-0bff03?logo=googlechrome&style=flat-square&logoColor=d4d2d2)](https://neutronium-website.onrender.com)
+[![Playground](https://img.shields.io/badge/Playground-Online-0368ff?logo=stackblitz&style=flat-square)](https://neutronium-website.onrender.com/Playground/)
+[![Documentation](https://img.shields.io/badge/Documentation-3d3c3b?logo=readthedocs&style=flat-square)](https://neutronium-website.onrender.com/Documentation/)
+
 ---
 
-## 🎉 What's new?
-- ⚡ Faster compilation for complex projects
-- ✨ useState, and useEffect
-- ⚛️ React like syntax for easier switching
-- 🌐 browser-safe Neutronium code compilation using /sandbox.mjs
-- 🖼️ Apply favicon to your site
+## 🎉 What’s new in v3.4.0
+
+- ⚡ Faster compilation for complex projects  
+- ✨ `useState` and `useEffect` hooks  
+- ⚛️ React-like JSX syntax for easier switching  
+- 🌐 **Browser-safe compilation** via `/sandbox.mjs`  
+- 🖼️ Apply favicon programmatically  
+- 📦 Massive package size reduction using `.npmignore`
+
 ---
 
 ## ℹ️ About
 
-**Neutronium** is a lightweight, efficient JavaScript framework designed for building modern web applications with **React-like simplicity** but **minimal overhead**.
+**Neutronium** is a lightweight, high-performance JavaScript framework built for developers who want **explicit control**, **predictable behavior**, and **zero unnecessary abstractions**.
 
-> Ultra-fast ⚡️. Tiny footprint 📦. No build tools 🛠️. Pure JavaScript ✨.
+It offers **React-like ergonomics** without a virtual DOM, build step, or heavy runtime.
+
+> Ultra-fast ⚡ · Tiny footprint 📦 · No build tools 🛠️ · Pure JavaScript ✨
 
 ---
 
 ## ✨ Features
 
-- ⚡️ **Blazing fast rendering**
-- 🧠 **Simple component logic**
-- 🔌 **No dependencies or virtual DOM**
-- 📦 **Small size (~184kB unpacked)**
-- 🛠️ **Works out of the box**
-- 🔁 **Easy JSX-style structure**
+- ⚡ **Blazing fast rendering**
+- 🧠 **Simple, predictable component logic**
+- 🔌 **No dependencies and no virtual DOM**
+- 📦 **Tiny footprint (~57.7 kB unpacked)**
+- 🧩 **TypeScript types (~4.35 kB)**
+- 🛠️ **Works directly in the browser**
+- 🔁 **JSX-style component structure**
+- 🌐 **Sandboxed browser compiler**
 
 ---
 
 ## 📦 Installation
 
+Install the Neutronium runtime:
+
 ```bash
-npm i neutronium@latest -g
+npm install neutronium
 ```
-
----
-
-## 🛠️ Setup
-
+Install the CLI globally(optional, recommended):
+```bash
+npm install neutronium -g
 ```
+---
+## 🛠️ Create a Project
+```bash
 neu-cli create-app my-app
+cd my-app
 ```
-
 ---
-
-## Usage Example
+## 🚀 Usage Example
 ```jsx
 // App.js
-import { createApp } from 'neutronium' // or ts-neutronium for ts devs
+import { createApp } from 'neutronium' // or ts-neutronium for TypeScript
 
-function Greeting(props) {
-  return <h2>Hello, {props.name}!</h2>;
+function Greeting({ name }) {
+  return <h2>Hello, {name}!</h2>;
 }
 
 export default function App() {
@@ -74,16 +84,41 @@ export default function App() {
 createApp(App).mount('body');
 ```
 
-## Result:
-![Results](https://raw.githubusercontent.com/PFMCODES/neutronium/main/results.png)
+---
+
+## 🧪 Result
+![Result](https://raw.githubusercontent.com/PFMCODES/neutronium/main/results.png)
+
+## Browser Sandbox
+Neutronium provides a **browser-safe compiler** for live environments such as playgrounds:
+```javascript
+import { compile } from "neutronium/sandbox.mjs";
+
+const result = compile(code);
+```
+This allows Neutronium code to be compiled without Node.js, making it ideal for online editors and sandboxes.
+
+---
+
+## 📚 Documentation & Links
+- 🌐 Website: https://neutronium-website.onrender.com/
+- 📖 Docs: https://neutronium-website.onrender.com/Documentation/
+- 🧪 Playground: https://neutronium-website.onrender.com/Playground/
+- 🧠 GitHub: https://github.com/PFMCODES/neutronium
+- 📦 NPM: https://www.npmjs.com/package/neutronium
 
 ---
 
-## NPM Packages using Neutronium
-### [@neuhq/alert](https://www.npmjs.com/package/@neuhq/alert)
-### [neutronium-alert](https://npmjs.org/package/neutronium-alert)
+## 📦 Packages Built with Neutronium
+- [@neuhq/alert](https://www.npmjs.com/package/@neuhq/alert)
+- [neutronium-alert](https://www.npmjs.com/package/neutronium-alert)
 
 ---
 
-## Found a bug or a problem?
-### Report [here.](https://github.com/PFMCODES/neutronium/issues/new)
+## 🐞 Found a Bug or Issue?
+Please report it here:
+👉 https://github.com/PFMCODES/neutronium/issues/new
+
+---
+## License
+MIT © PFMCODES

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neutronium",
-  "version": "3.3.8",
+  "version": "3.4.0",
   "description": "Ultra-dense JavaScript framework – maximum performance, minimal overhead",
   "main": "src/index.js",
   "type": "commonjs",

package/sandbox.mjs

@@ -1,7 +1,7 @@
 import * as Babel from "https://esm.sh/@babel/standalone@7.28.6/es2022/standalone.mjs";
 import { basehtml } from "./template.js";
 
-export function compileAndReturnOutput(source) {
+export function compile(source) {
   try {
     console.log("⚙️ Babel transforming");
 

package/ts-neutronium/index.d.ts

@@ -1,146 +0,0 @@
-// src/index.ts
-
-type EffectFunction = () => void;
-type StateGetter<T> = () => T;
-type StateSetter<T> = (newVal: T) => void;
-type StateEntry<T> = [StateGetter<T>, StateSetter<T>];
-
-let globalState: StateEntry<any>[] = [];
-let stateIndex = 0;
-
-function resetStateIndex(): void {
-  stateIndex = 0;
-}
-
-let currentEffect: EffectFunction | null = null;
-
-function useEffect(fn: EffectFunction): void {
-  currentEffect = fn;
-  fn(); // run once to collect dependencies
-  currentEffect = null;
-}
-
-function useState<T>(initialValue: T): StateEntry<T> {
-  const index = stateIndex;
-
-  if (!globalState[index]) {
-    let value = initialValue;
-    const subs = new Set<EffectFunction>();
-
-    function get(): T {
-      if (currentEffect) subs.add(currentEffect);
-      return value;
-    }
-
-    function set(newVal: T): void {
-      if (value !== newVal) {
-        value = newVal;
-        subs.forEach(fn => fn()); // re-run effects
-        if (typeof (window as any).__NEUTRONIUM_RENDER_FN__ === 'function') {
-          (window as any).__NEUTRONIUM_RENDER_FN__();
-        }
-      }
-    }
-
-    globalState[index] = [get, set];
-  }
-
-  const result = globalState[index] as StateEntry<T>;
-  stateIndex++;
-  return result;
-}
-
-type VNode = Node;
-type Child = VNode | string | number | null | undefined;
-type Children = Child | Child[];
-
-interface Props {
-  children?: Children;
-  ref?: (el: HTMLElement) => void;
-  [key: string]: any;
-}
-
-type ComponentFunction = (props: Props) => VNode;
-type ElementType = string | ComponentFunction;
-
-function h(type: ElementType, props: Props | null = {}, ...children: Child[]): VNode {
-  props = props || {};
-  props.children = (props.children ? (Array.isArray(props.children) ? props.children : [props.children]) : [])
-    .concat(children)
-    .flat();
-
-  if (typeof type === 'function') {
-    return type(props);
-  }
-
-  const el = document.createElement(type);
-
-  for (const [key, value] of Object.entries(props || {})) {
-    if (key === 'children') continue; // skip
-    if (key.startsWith('on') && typeof value === 'function') {
-      el.addEventListener(key.slice(2).toLowerCase(), value);
-    } else if (key === 'ref' && typeof value === 'function') {
-      value(el);
-    } else {
-      el.setAttribute(key, String(value));
-    }
-  }
-
-  props.children.forEach((child: Child) => {
-    if (typeof child === 'string' || typeof child === 'number') {
-      el.appendChild(document.createTextNode(String(child)));
-    } else if (child instanceof Node) {
-      el.appendChild(child);
-    }
-  });
-
-  return el;
-}
-
-interface App {
-  mount(selector: string | HTMLElement): HTMLElement | null;
-}
-
-function createApp(component: () => VNode): App {
-  return {
-    mount(selector: string | HTMLElement): HTMLElement | null {
-      const root = typeof selector === 'string' ? document.querySelector<HTMLElement>(selector) : selector;
-      if (!root) {
-        console.error(`❌ Root element '${selector}' not found`);
-        return null;
-      }
-
-      (window as any).__NEUTRONIUM_ROOT__ = root;
-
-      function render(): void {
-        resetStateIndex();
-        const vnode = component();
-        root.innerHTML = '';
-        root.appendChild(vnode);
-      }
-
-      (window as any).__NEUTRONIUM_RENDER_FN__ = render;
-      render();
-
-      return root;
-    }
-  };
-}
-
-function Fragment(props: Props = {}): DocumentFragment {
-  const frag = document.createDocumentFragment();
-  const children = props.children || [];
-
-  (Array.isArray(children) ? children : [children]).forEach((child: Child) => {
-    if (typeof child === 'string' || typeof child === 'number') {
-      frag.appendChild(document.createTextNode(String(child)));
-    } else if (child instanceof Node) {
-      frag.appendChild(child);
-    }
-  });
-
-  return frag;
-}
-
-export { h, createApp, Fragment, useState, useEffect, resetStateIndex };
-export type { Props, VNode, Child, Children, ComponentFunction, ElementType, StateEntry, EffectFunction };

package/ts-neutronium/package.json

@@ -1,14 +0,0 @@
-{
-  "name": "ts-neutronium",
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.ts",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "type": "module",
-  "types": "./index.d.ts"
-}