nene-lang 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 kimuracoki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,220 @@
-# Temporary Holding Version
+# Nene
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**Simple rules. Beautiful structures.**
+
+Nene（ネネ）は、Haskell の書き心地と JSX の見やすさを両立させる、UI 向けの関数型言語。少ない規則で書き、タグを見れば画面の形が分かる。
+
+> **ステータス: v0.1。** 言語仕様、コンパイラ、ランタイム、`nene` コマンド、Vite プラグイン、公式の部品集 [nene-ui](ui/README.md)、nvim 用のハイライトと言語サーバーがある。
+
+```haskell
+view :: Model -> Html Msg
+view n =
+  <Column gap={M} align={Center} class={css.page}>
+    <h1>カウンター</h1>
+    <p class={count}>{show n}</p>
+    <Row gap={S}>
+      <Button onClick={Decrement} disabled={atZero}>-</Button>
+      <Button onClick={Increment}>+</Button>
+    </Row>
+  </Column>
+  where
+    atZero = n == 0
+
+    count
+      | n >= 10   = classes [css.count, css.big]
+      | otherwise = css.count
+
+
+style
+  .page { padding: var(--space-xl); }
+  .count {
+    font-size: 2.5rem;
+    font-weight: 700;
+  }
+  .big { color: crimson; }
+```
+
+## 原則
+
+1. **タグを見れば、画面に何がどう並ぶかが分かる。** 並び方は `<Row>` `<Column>` `<Grid>` `<Stack>` で書く。
+2. **タグには名前だけを書く。** 計算・分岐は `where` に、見た目はファイル末尾の `style` ブロックに普通の CSS で書く。JSX の `{}` に演算子や `if` を書くとコンパイルエラーになる。
+3. **書き方は一つ。** `case` `if` `let` ラムダはなく、等式のパターンマッチ・ガード・`where` で書く。CSS の当て方も `class={css.名前}` だけ。
+4. **型が通れば、実行時エラーは起きない。** 静的型、行多相のレコード、パターンの網羅性チェック（漏れはエラー）。
+
+## 構成
+
+| 層 | 中身 | パッケージ |
+| --- | --- | --- |
+| 言語 | コンパイラ、ランタイム、`nene` コマンド、標準ライブラリ（ルーティング・HTTP・JSON など） | `nene-lang` |
+| 部品集 | ボタン・入力欄・ダイアログなど 16 の部品 | [`nene-ui`](ui/README.md) |
+
+標準ライブラリは差し替えられない（ルーティングも HTTP も一通りだけ）。部品集は別のパッケージで、使わなくてもよい。出力には、アプリが使っている標準モジュールとランタイムの部分だけが入る。
+
+## ドキュメント
+
+| | 内容 |
+| --- | --- |
+| [docs/guide.md](docs/guide.md) | **入門。** 最初に読むもの。画面を作りながら書き方を一通り見る |
+| [docs/spec.md](docs/spec.md) | 言語仕様。すべての規則を正確に書いた参照用 |
+| [docs/design.md](docs/design.md) | 設計の考え方。なぜこういう言語なのか、何を入れなかったのか |
+
+## 動機
+
+Elm でサンプルアプリを作ってみて感じた不満から始まっている。
+
+| 不満 | Nene での方針 |
+| --- | --- |
+| `case` と `let ... in` しかなく冗長 | Haskell と同じく、複数等式による関数定義・ガード・`where` を使える |
+| view が `div [ ... ] [ ... ]` で、UI の形が読み取りにくい | JSX を式としてそのまま書ける |
+| 横並び・縦並びが CSS に隠れていて、マークアップを見てもレイアウトが分からない | 並び方はタグで書く。見た目は同じファイルの `style` ブロックに CSS で書く |
+| マークアップの中に分岐や計算が混ざると読みにくい | JSX の `{}` には名前だけを書ける。処理は `where` に書く |
+| コンポーネントの省略可能な引数がなく、呼び出しが長い | props レコードにデフォルト値を持たせられる |
+| 型の安全性・実行時エラーの少なさは手放したくない | 静的型・ADT・網羅性チェックは維持する |
+
+## はじめる
+
+Node.js 20.19 以上が必要。
+
+```sh
+npm create nene-lang my-app
+cd my-app
+npm install
+npm run dev        # http://localhost:5173/ 。保存すると自動で再読み込み
+```
+
+設定ファイルはいらない。
+
+```
+my-app/
+  package.json
+  index.html       <script type="module" src="/src/Main.nn"> が入口
+  src/Main.nn
+  public/          画像など。そのままの名前で配信される
+  CLAUDE.md        Claude Code 向けの Nene の書き方（nene-ui の部品も）
+  .claude/         .nn を編集したら型検査して、エラーを Claude に伝えるフック
+```
+
+| コマンド | 内容 |
+| --- | --- |
+| `npm run dev`（`nene dev`） | 開発サーバー。コンパイルエラーはブラウザに場所つきで出る |
+| `npm run build`（`nene build`） | `dist/` に出力する。そのまま静的ホスティングに置ける。`--base /repo/` でサブディレクトリにも置ける |
+| `npm run preview`（`nene preview`） | `dist/` を手元で動かして確かめる |
+| `npm run check`（`nene check`） | 型検査だけ。エラーは該当する行つきで出る |
+
+`dev`・`build`・`preview` は内部で Vite を使う。複数ページなど特別なことをしたいときだけ、普通の `vite.config.ts` を置けば読み込まれる（例: `examples/vite.config.ts`）。
+
+### npm に公開する前に、手元で試す
+
+`npm create nene-lang` の代わりに、このリポジトリを `npm link` する。
+
+```sh
+cd /path/to/nene
+npm install
+npm link                  # nene コマンドが使えるようになる
+
+cd ~/どこか
+nene new my-app           # 手元のリポジトリを使うプロジェクトとして作られる
+cd my-app
+npm install
+npm run dev
+```
+
+手元のリポジトリから作ったプロジェクトは、`package.json` の依存先が `file:/path/to/nene` になる。コンパイラを直すと、そのまま反映される（ビルドは不要）。やめるときは `npm unlink -g nene-lang`。
+
+### 公開する
+
+`nene build` は、`/todos/3` のような URL を直接開いても表示されるように、`404.html`（GitHub Pages など）と `_redirects`（Netlify・Cloudflare Pages）も出力する。ホスティングごとの手順は、作ったプロジェクトの `README.md` に書いてある。
+
+### パッケージを作る
+
+`package.json` に `"nene": { "source": "src" }` と書いた npm パッケージは、`src/` の `.nn` を `import` で使える（`nene-ui` もこの形）。モジュール名は、ほかとぶつからないように頭を揃える（`Ui.Button` など）。同じ名前のモジュールが 2 か所にあるとエラーになる。
+
+### 既存の Vite プロジェクトに入れる
+
+```ts
+// vite.config.ts
+import nene from "nene-lang/vite";
+
+export default { plugins: [nene()] };
+```
+
+## nvim
+
+nvim 0.11 以上。プラグインを入れて `setup()` を呼ぶだけ。言語サーバーは、プロジェクトの `node_modules` にある `nene` を自動で使う。
+
+```lua
+-- lazy.nvim
+{
+  "kimuracoki/nene",
+  config = function(plugin)
+    vim.opt.rtp:append(plugin.dir .. "/editors/nvim")
+    require("nene").setup()
+  end,
+}
+
+-- 手元のリポジトリを使う場合
+vim.opt.rtp:append("/path/to/nene/editors/nvim")
+require("nene").setup()
+```
+
+- `.nn` のハイライト。言語サーバーが動いているときは、その解析結果で色を分ける（部品と HTML 要素、コンストラクタ、フィールド、引数など）
+- 入力中のエラー表示（1 ファイルのエラーをまとめて表示）
+- `K` で型を表示、`gd` で定義へ移動（`<Button>` から `Button.nn` へも飛べる）
+- 補完
+  - `<But` → `<Button onClick={…}>…</Button>`（必須の属性と閉じタグまで入る）
+  - タグの中で属性名（まだ書いていないもの。必須のものが先）
+  - `import ` の後でプロジェクトのモジュール名、`List.` の後でその中の名前、`model.` の後でフィールド名
+
+補完は、nvim-cmp や blink.cmp が入っていればそちらに出て、なければ nvim 標準の補完を使う。
+
+## この言語自体を開発する
+
+```sh
+npm install
+npm test                  # テスト
+npm run dev               # examples/ を開く
+npm run build:package     # 配布用の JavaScript を build/ に出力する（npm publish の前に自動で実行される）
+npm pack                  # 配布するパッケージを手元で作る
+```
+
+開発中は TypeScript をビルドせずにそのまま実行する（Node.js 23.6 以上）。配布するときだけ `build/` に JavaScript を出力する。npm は `node_modules` の中の `.ts` を実行できないため。
+
+## サンプル
+
+| ファイル | 内容 |
+| --- | --- |
+| [examples/Counter.nn](examples/Counter.nn) | 最小のカウンター |
+| [examples/Todo.nn](examples/Todo.nn) | elm-sample のタスク管理画面に相当するもの |
+| [examples/Gallery.nn](examples/Gallery.nn) | アルバムごとに写真が横に続くギャラリー。開いた写真は URL に入り、戻るボタンや Esc で閉じる |
+| [examples/Stopwatch.nn](examples/Stopwatch.nn) | タイマー・キーボード・ブラウザへの保存・ダークテーマを使う例 |
+| [examples/Showcase.nn](examples/Showcase.nn) | nene-ui の部品を一通り並べた見本 |
+
+## 構成
+
+| パス | 内容 |
+| --- | --- |
+| `src/lexer.ts` | 字句解析 |
+| `src/parser.ts` | 構文解析。JSX は文字単位で読み、レイアウト（インデント）はトップレベルと `where` だけで使う |
+| `src/types.ts` | 型の表現と単一化（行多相レコード、組み込み型クラス） |
+| `src/checker.ts` | 名前解決と型推論（Hindley–Milner、束縛のまとまりごとに汎化） |
+| `src/exhaust.ts` | パターンの網羅性チェック |
+| `src/codegen.ts` | JavaScript の生成 |
+| `src/compiler.ts` | モジュールを依存順に読み込み、1 つの JavaScript にまとめる（使っている標準モジュールだけを入れる） |
+| `src/packages.ts` | `node_modules` から Nene のパッケージを探す |
+| `src/lib/*.nn` | 標準ライブラリ（Nene で書かれている） |
+| `runtime/runtime.js` | 仮想 DOM、レイアウトタグ、`style` ブロックの CSS の読み込み、URL、The Elm Architecture の実行 |
+| `runtime/http.js` | JSON との変換と HTTP（使うアプリにだけ入る） |
+| `ui/` | 公式の部品集 `nene-ui` |
+| `src/css.ts` | `style` ブロックのクラス名を取り出し、ファイルごとに区別できる名前に書き換える |
+| `src/cli.ts` / `src/vite.ts` / `src/lsp.ts` | `nene` コマンド、Vite プラグイン、言語サーバー |
+| `src/report.ts` | コンパイルエラーを、該当する行と印つきで見せる |
+| `template/` | `nene new` で作るプロジェクトのひな形 |
+| `bin/nene.js` | コマンドの入口。手元のリポジトリでは `src/` を、npm から入れたときは `build/` を使う |
+| `editors/nvim/` | nvim 用のファイル種別判定・ハイライト・設定 |
+
+## まだないもの
+
+- 部品の中だけで完結する状態（React の useState に相当するもの）
+- サーバー側での描画（SSR）と、ビルド時に HTML を作る静的生成
+- VS Code の拡張
+- Tree-sitter の文法（今は Vim の syntax ファイルと、言語サーバーによる色分け）

package/bin/nene.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+// nene コマンドの入口。
+// 手元のリポジトリ（src/ がある）から動かすときは TypeScript のソースをそのまま使い、
+// npm から入れたときはビルド済みの build/ を使う。
+import { existsSync } from "node:fs";
+
+const source = new URL("../src/cli.ts", import.meta.url);
+const canStripTypes = process.features?.typescript !== undefined && process.features.typescript !== false;
+if (existsSync(source) && canStripTypes) {
+  await import(source.href);
+} else {
+  await import(new URL("../build/cli.js", import.meta.url).href);
+}

package/build/checker.d.ts

@@ -0,0 +1,103 @@
+import { type Expr, type Module, type Pos, type ValueRef, type CtorRef } from "./syntax.ts";
+import { type Scheme, type Type } from "./types.ts";
+import { type ScopedStyle } from "./css.ts";
+export interface ValueInfo {
+    scheme: Scheme;
+    ref: ValueRef;
+    def?: Location;
+    param?: boolean;
+}
+export interface Location {
+    file: string;
+    pos: Pos;
+}
+export type SemType = "namespace" | "type" | "class" | "enumMember" | "function" | "variable" | "parameter" | "property" | "macro";
+export interface SemToken {
+    pos: Pos;
+    length: number;
+    type: SemType | (() => SemType);
+}
+export interface TagCandidate {
+    name: string;
+    detail: string;
+    fields: {
+        name: string;
+        required: boolean;
+        type: string;
+    }[];
+    children: boolean;
+}
+export interface CompletionInfo {
+    values: {
+        name: string;
+        detail: string;
+    }[];
+    quals: Map<string, {
+        name: string;
+        detail: string;
+    }[]>;
+    tags: TagCandidate[];
+}
+export interface HoverInfo {
+    pos: Pos;
+    length: number;
+    name: string;
+    type: () => string;
+    typeOf?: () => Type;
+    label?: () => string;
+    def?: Location | (() => Location | undefined);
+}
+export interface CtorInfo {
+    ref: CtorRef;
+    scheme: Scheme;
+    def?: Location;
+}
+export interface TypeInfo {
+    name: string;
+    display: string;
+    arity: number;
+    kind: "data" | "alias" | "opaque";
+    ctors: string[];
+    expand?: (args: Type[]) => Type;
+    defaults?: Set<string>;
+    defaultsKey?: string;
+    def?: Location;
+    params?: string[];
+}
+export interface ModuleIface {
+    name: string;
+    file: string;
+    pos: Pos;
+    js: string;
+    values: Map<string, ValueInfo>;
+    ctors: Map<string, CtorInfo>;
+    types: Map<string, TypeInfo>;
+}
+export declare const STD_QUALIFIED: string[];
+export declare const RESERVED_MODULES: string[];
+export declare const HTML_ELEMENTS: Set<string>;
+export declare const HTML_ATTRS: string[];
+export declare function jsName(name: string): string;
+export declare function fieldKey(name: string): string;
+export declare function moduleJs(name: string): string;
+export declare function uniqueTypeName(module: string, name: string): string;
+export interface CheckOptions {
+    deps: Map<string, ModuleIface>;
+    builtin: boolean;
+    entry: boolean;
+}
+export interface CheckResult {
+    iface: ModuleIface;
+    defaults: {
+        key: string;
+        fields: {
+            name: string;
+            expr: Expr;
+        }[];
+    }[];
+    hovers: HoverInfo[];
+    tokens: SemToken[];
+    completion: CompletionInfo;
+    style: ScopedStyle | null;
+}
+export declare function checkModule(mod: Module, file: string, opts: CheckOptions): CheckResult;