helfy-create 0.0.5 → 0.1.0

package/README.md

@@ -1,38 +1,49 @@
-# create-helfy
-
-Create a new Helfy project with one command.
-
-## Usage
-
-```bash
-npx helfy-create my-app
-cd my-app
-npm run dev
-```
-
-Or without a project name (creates `helfy-app`):
-
-```bash
-npx helfy-create
-```
-
-**Options:**
-- `--skip-install` — create project without running `npm install` (e.g. for custom registry or offline)
-
-## Editor setup (VS Code)
-
-**Syntax highlighting.** The helfy-syntax extension is not in the Marketplace. Install manually from [GitHub](https://github.com/ikrymsaev/helfy-syntax/tree/main/dist):
-
-- Download the **archive** and extract to the extensions folder, or
-- Download the **.vsix** file and install: `Extensions` → `...` → `Install from VSIX...`
-
-**TypeScript.** Use **workspace TypeScript**: `Ctrl+Shift+P` (Windows/Linux) or `Cmd+Shift+P` (Mac) → `TypeScript: Select TypeScript Version` → `Use Workspace Version`. Required because the project includes `@helfy/helfy-ts-plugin`.
-
-## What you get
-
-- Helfy + TypeScript + Webpack setup
-- Babel preset with helfy compiler
-- Router with example pages (Home, Counter, About)
-- Basic styling
-- `npm run dev` — development server (port 3000)
-- `npm run build` — production build
+# helfy-create
+
+Create a new [Helfy](https://github.com/ikrymsaev/helfy/tree/main/packages/helfy) project with one command.
+
+## Usage
+
+```bash
+npx helfy-create my-app
+cd my-app
+npm run dev
+```
+
+Or without a project name (creates `helfy-app`):
+
+```bash
+npx helfy-create
+```
+
+**Options:**
+- `--skip-install` — create the project without running `npm install` (e.g. for a custom registry or offline)
+
+## Editor setup (VS Code / Cursor)
+
+The Helfy extension adds `.hf` template support: highlighting, type checking of template expressions, hover,
+go-to-definition, completion, diagnostics and formatting. It is not in the Marketplace — install the `.vsix` from
+[GitHub](https://github.com/ikrymsaev/helfy/tree/main/packages/vscode-extension):
+
+```bash
+code --install-extension helfy-vscode-0.1.1.vsix
+```
+
+or `Extensions` → `...` → `Install from VSIX...`.
+
+## What you get
+
+- Helfy + TypeScript + Rspack
+- Components as `.ts` classes with `.hf` templates next to them
+- Router with example pages (Home, Counter, lazily loaded About) and a custom 404 page
+- Layout with slots, a theme context, `@safe / @wait / @fail` around the router
+- `npm run dev` — development server (port 3000)
+- `npm run build` — production build
+
+```
+src/
+  App.ts / App.hf              root component
+  context/ThemeContext.ts      light / dark theme
+  pages/                       pages, routes, layout
+  widgets/                     header, sidebar, footer, 404, theme toggle
+```

package/bin/create-helfy.js

@@ -18,14 +18,22 @@ if (fs.existsSync(root)) {
 
 console.log(`Creating Helfy project in ${projectName}...\n`);
 
+// Present only when the template is installed locally (they are not in the published package).
+const SKIP = new Set(["node_modules", "dist", ".helfy"]);
+// Copied byte for byte; the rest is text with {{PROJECT_NAME}} placeholders.
+const BINARY = /\.(ico|png|jpe?g|gif|webp|woff2?)$/i;
+
 function copyDir(src, dest) {
   fs.mkdirSync(dest, { recursive: true });
   for (const name of fs.readdirSync(src)) {
+    if (SKIP.has(name)) continue;
     const srcPath = path.join(src, name);
     const destName = name === "gitignore" ? ".gitignore" : name;
     const destPath = path.join(dest, destName);
     if (fs.statSync(srcPath).isDirectory()) {
       copyDir(srcPath, destPath);
+    } else if (BINARY.test(name)) {
+      fs.copyFileSync(srcPath, destPath);
     } else {
       let content = fs.readFileSync(srcPath, "utf-8");
       content = content.replace(/\{\{PROJECT_NAME\}\}/g, projectName);

package/package.json

@@ -1,31 +1,31 @@
-{
-  "name": "helfy-create",
-  "version": "0.0.5",
-  "description": "Create a new Helfy project",
-  "bin": {
-    "helfy-create": "./bin/create-helfy.js"
-  },
-  "files": [
-    "bin",
-    "template/.babelrc",
-    "template/gitignore",
-    "template/package.json",
-    "template/package-lock.json",
-    "template/tsconfig.json",
-    "template/webpack.config.js",
-    "template/declaration.d.ts",
-    "template/src"
-  ],
-  "keywords": [
-    "helfy",
-    "scaffold",
-    "create",
-    "starter"
-  ],
-  "author": "ikrymsaev",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/ikrymsaev/helfy-create"
-  }
-}
+{
+  "name": "helfy-create",
+  "version": "0.1.0",
+  "description": "Create a new Helfy project",
+  "bin": {
+    "helfy-create": "./bin/create-helfy.js"
+  },
+  "files": [
+    "bin",
+    "template/.babelrc",
+    "template/gitignore",
+    "template/package.json",
+    "template/package-lock.json",
+    "template/tsconfig.json",
+    "template/rspack.config.js",
+    "template/declaration.d.ts",
+    "template/src"
+  ],
+  "keywords": [
+    "helfy",
+    "scaffold",
+    "create",
+    "starter"
+  ],
+  "author": "ikrymsaev",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ikrymsaev/helfy-create"
+  }
+}

package/template/declaration.d.ts

@@ -1,8 +1,10 @@
-declare module '*.scss' {
-  const content: Record<string, string>;
-  export default content;
-}
-declare module '*.css' {
-  const content: Record<string, string>;
-  export default content;
-}
+/// <reference types="@helfy/helfy/helfy-hf" />
+
+declare module '*.scss' {
+  const content: Record<string, string>;
+  export default content;
+}
+declare module '*.css' {
+  const content: Record<string, string>;
+  export default content;
+}