planscript 0.1.0

package/examples/house.json

@@ -0,0 +1,478 @@
+{
+  "version": "1.0.0",
+  "geometry": {
+    "footprint": {
+      "points": [
+        {
+          "x": 0,
+          "y": 0
+        },
+        {
+          "x": 20,
+          "y": 0
+        },
+        {
+          "x": 20,
+          "y": 30
+        },
+        {
+          "x": 0,
+          "y": 30
+        }
+      ]
+    },
+    "rooms": [
+      {
+        "name": "living",
+        "label": "Living Room",
+        "polygon": {
+          "points": [
+            {
+              "x": 1,
+              "y": 1
+            },
+            {
+              "x": 9,
+              "y": 1
+            },
+            {
+              "x": 9,
+              "y": 7
+            },
+            {
+              "x": 1,
+              "y": 7
+            }
+          ]
+        },
+        "area": 48
+      },
+      {
+        "name": "kitchen",
+        "label": "Kitchen",
+        "polygon": {
+          "points": [
+            {
+              "x": 9,
+              "y": 1
+            },
+            {
+              "x": 13,
+              "y": 1
+            },
+            {
+              "x": 13,
+              "y": 7
+            },
+            {
+              "x": 9,
+              "y": 7
+            }
+          ]
+        },
+        "area": 24
+      },
+      {
+        "name": "hall",
+        "label": "Hallway",
+        "polygon": {
+          "points": [
+            {
+              "x": 1,
+              "y": 7
+            },
+            {
+              "x": 13,
+              "y": 7
+            },
+            {
+              "x": 13,
+              "y": 9
+            },
+            {
+              "x": 1,
+              "y": 9
+            }
+          ]
+        },
+        "area": 24
+      },
+      {
+        "name": "bedroom",
+        "label": "Master Bedroom",
+        "polygon": {
+          "points": [
+            {
+              "x": 1,
+              "y": 9
+            },
+            {
+              "x": 4.6,
+              "y": 9
+            },
+            {
+              "x": 4.6,
+              "y": 13
+            },
+            {
+              "x": 1,
+              "y": 13
+            }
+          ]
+        },
+        "area": 14.399999999999999
+      },
+      {
+        "name": "bath",
+        "label": "Bathroom",
+        "polygon": {
+          "points": [
+            {
+              "x": 4.6,
+              "y": 10.8
+            },
+            {
+              "x": 7.199999999999999,
+              "y": 10.8
+            },
+            {
+              "x": 7.199999999999999,
+              "y": 13
+            },
+            {
+              "x": 4.6,
+              "y": 13
+            }
+          ]
+        },
+        "area": 5.720000000000006
+      }
+    ],
+    "walls": [
+      {
+        "id": "wall_0",
+        "start": {
+          "x": 9,
+          "y": 1
+        },
+        "end": {
+          "x": 9,
+          "y": 7
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "living",
+          "kitchen"
+        ]
+      },
+      {
+        "id": "wall_1",
+        "start": {
+          "x": 1,
+          "y": 7
+        },
+        "end": {
+          "x": 9,
+          "y": 7
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "living",
+          "hall"
+        ]
+      },
+      {
+        "id": "wall_2",
+        "start": {
+          "x": 9,
+          "y": 7
+        },
+        "end": {
+          "x": 13,
+          "y": 7
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "kitchen",
+          "hall"
+        ]
+      },
+      {
+        "id": "wall_3",
+        "start": {
+          "x": 1,
+          "y": 9
+        },
+        "end": {
+          "x": 4.6,
+          "y": 9
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "hall",
+          "bedroom"
+        ]
+      },
+      {
+        "id": "wall_4",
+        "start": {
+          "x": 4.6,
+          "y": 10.8
+        },
+        "end": {
+          "x": 4.6,
+          "y": 13
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "bedroom",
+          "bath"
+        ]
+      },
+      {
+        "id": "wall_5",
+        "start": {
+          "x": 1,
+          "y": 1
+        },
+        "end": {
+          "x": 9,
+          "y": 1
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "living"
+        ]
+      },
+      {
+        "id": "wall_6",
+        "start": {
+          "x": 1,
+          "y": 1
+        },
+        "end": {
+          "x": 1,
+          "y": 7
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "living"
+        ]
+      },
+      {
+        "id": "wall_7",
+        "start": {
+          "x": 9,
+          "y": 1
+        },
+        "end": {
+          "x": 13,
+          "y": 1
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "kitchen"
+        ]
+      },
+      {
+        "id": "wall_8",
+        "start": {
+          "x": 13,
+          "y": 1
+        },
+        "end": {
+          "x": 13,
+          "y": 7
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "kitchen"
+        ]
+      },
+      {
+        "id": "wall_9",
+        "start": {
+          "x": 13,
+          "y": 7
+        },
+        "end": {
+          "x": 13,
+          "y": 9
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "hall"
+        ]
+      },
+      {
+        "id": "wall_10",
+        "start": {
+          "x": 4.6,
+          "y": 9
+        },
+        "end": {
+          "x": 13,
+          "y": 9
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "hall"
+        ]
+      },
+      {
+        "id": "wall_11",
+        "start": {
+          "x": 1,
+          "y": 7
+        },
+        "end": {
+          "x": 1,
+          "y": 9
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "hall"
+        ]
+      },
+      {
+        "id": "wall_12",
+        "start": {
+          "x": 4.6,
+          "y": 9
+        },
+        "end": {
+          "x": 4.6,
+          "y": 10.8
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "bedroom"
+        ]
+      },
+      {
+        "id": "wall_13",
+        "start": {
+          "x": 1,
+          "y": 13
+        },
+        "end": {
+          "x": 4.6,
+          "y": 13
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "bedroom"
+        ]
+      },
+      {
+        "id": "wall_14",
+        "start": {
+          "x": 1,
+          "y": 9
+        },
+        "end": {
+          "x": 1,
+          "y": 13
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "bedroom"
+        ]
+      },
+      {
+        "id": "wall_15",
+        "start": {
+          "x": 4.6,
+          "y": 10.8
+        },
+        "end": {
+          "x": 7.199999999999999,
+          "y": 10.8
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "bath"
+        ]
+      },
+      {
+        "id": "wall_16",
+        "start": {
+          "x": 7.199999999999999,
+          "y": 10.8
+        },
+        "end": {
+          "x": 7.199999999999999,
+          "y": 13
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "bath"
+        ]
+      },
+      {
+        "id": "wall_17",
+        "start": {
+          "x": 4.6,
+          "y": 13
+        },
+        "end": {
+          "x": 7.199999999999999,
+          "y": 13
+        },
+        "thickness": 0.15,
+        "isExterior": false,
+        "rooms": [
+          "bath"
+        ]
+      }
+    ],
+    "openings": [
+      {
+        "id": "d1",
+        "type": "door",
+        "wallId": "wall_1",
+        "position": 4.8,
+        "width": 0.9
+      },
+      {
+        "id": "d2",
+        "type": "door",
+        "wallId": "wall_0",
+        "position": 3,
+        "width": 0.9
+      },
+      {
+        "id": "d3",
+        "type": "door",
+        "wallId": "wall_3",
+        "position": 1.7999999999999998,
+        "width": 0.9
+      },
+      {
+        "id": "w1",
+        "type": "window",
+        "wallId": "wall_5",
+        "position": 2,
+        "width": 2.4,
+        "sill": 0.9
+      }
+    ]
+  }
+}

package/examples/house.psc

@@ -0,0 +1,86 @@
+# Example House Floor Plan
+# This demonstrates the full syntax of PlanScript
+
+units m
+origin (0,0)
+
+# Default widths for doors and windows
+defaults {
+  door_width 0.9
+  window_width 2.4
+}
+
+plan "Example House" {
+  footprint rect (0,0) (20,30)
+
+  # Main living area
+  room living {
+    rect (1,1) (9,7)
+    label "Living Room"
+  }
+
+  # Kitchen attached to living room
+  room kitchen {
+    rect size (4,6)
+    attach east_of living
+    align top
+    gap 0
+    label "Kitchen"
+  }
+
+  # Hallway spanning from living to kitchen
+  room hall {
+    rect span x from living.left to kitchen.right y (7, 9)
+    label "Hallway"
+  }
+
+  # Bedroom
+  room bedroom {
+    rect at (1,9) size (3.6,4.0)
+    label "Master Bedroom"
+  }
+
+  # Bathroom attached to bedroom
+  room bath {
+    rect size (2.6,2.2)
+    attach east_of bedroom
+    align top
+    label "Bathroom"
+  }
+
+  # Door between living and hall (uses default door_width)
+  # at 60% means 60% along the shared wall
+  opening door d1 {
+    between living and hall
+    on shared_edge
+    at 60%
+  }
+
+  # Door between living and kitchen (uses default door_width)
+  # at 50% means centered on the shared wall
+  opening door d2 {
+    between living and kitchen
+    on shared_edge
+    at 50%
+  }
+
+  # Door between hallway and master bedroom (uses default door_width)
+  opening door d3 {
+    between hall and bedroom
+    on shared_edge
+    at 50%
+  }
+
+  # Window on living room south wall (uses default window_width)
+  # at 2.0 means 2.0 meters from the left edge of the wall
+  opening window w1 {
+    on living.edge south
+    at 2.0
+    sill 0.9
+  }
+
+  # Assertions for validation
+  assert no_overlap rooms
+  assert inside footprint all_rooms
+  assert min_room_area bedroom >= 12.0
+}

package/examples/house.svg

@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" width="1000" height="800" viewBox="0 0 1000 800">
+  <defs>
+    <style>
+      .room-label { font-family: Arial, sans-serif; font-weight: 500; }
+    </style>
+  </defs>
+  
+  <!-- Background -->
+  <rect width="1000" height="800" fill="#ffffff" />
+  
+  <!-- Footprint (boundary) -->
+  <path d="M 273.33 740.00 L 726.67 740.00 L 726.67 60.00 L 273.33 60.00 Z" fill="none" stroke="#7f8c8d" stroke-width="2" stroke-dasharray="8,4" />
+  
+  <!-- Rooms -->
+  <path d="M 296.00 717.33 L 477.33 717.33 L 477.33 581.33 L 296.00 581.33 Z" fill="#ecf0f1" stroke="#bdc3c7" stroke-width="1" />
+    <path d="M 477.33 717.33 L 568.00 717.33 L 568.00 581.33 L 477.33 581.33 Z" fill="#ecf0f1" stroke="#bdc3c7" stroke-width="1" />
+    <path d="M 296.00 581.33 L 568.00 581.33 L 568.00 536.00 L 296.00 536.00 Z" fill="#ecf0f1" stroke="#bdc3c7" stroke-width="1" />
+    <path d="M 296.00 536.00 L 377.60 536.00 L 377.60 445.33 L 296.00 445.33 Z" fill="#ecf0f1" stroke="#bdc3c7" stroke-width="1" />
+    <path d="M 377.60 495.20 L 436.53 495.20 L 436.53 445.33 L 377.60 445.33 Z" fill="#ecf0f1" stroke="#bdc3c7" stroke-width="1" />
+  
+  <!-- Walls -->
+  <line x1="477.33" y1="717.33" x2="477.33" y2="581.33" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+    <line x1="296.00" y1="581.33" x2="477.33" y2="581.33" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+    <line x1="477.33" y1="581.33" x2="568.00" y2="581.33" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+    <line x1="296.00" y1="536.00" x2="377.60" y2="536.00" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+    <line x1="377.60" y1="495.20" x2="377.60" y2="445.33" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+    <line x1="296.00" y1="717.33" x2="477.33" y2="717.33" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+    <line x1="296.00" y1="717.33" x2="296.00" y2="581.33" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+    <line x1="477.33" y1="717.33" x2="568.00" y2="717.33" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+    <line x1="568.00" y1="717.33" x2="568.00" y2="581.33" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+    <line x1="568.00" y1="581.33" x2="568.00" y2="536.00" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+    <line x1="377.60" y1="536.00" x2="568.00" y2="536.00" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+    <line x1="296.00" y1="581.33" x2="296.00" y2="536.00" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+    <line x1="377.60" y1="536.00" x2="377.60" y2="495.20" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+    <line x1="296.00" y1="445.33" x2="377.60" y2="445.33" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+    <line x1="296.00" y1="536.00" x2="296.00" y2="445.33" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+    <line x1="377.60" y1="495.20" x2="436.53" y2="495.20" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+    <line x1="436.53" y1="495.20" x2="436.53" y2="445.33" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+    <line x1="377.60" y1="445.33" x2="436.53" y2="445.33" stroke="#2c3e50" stroke-width="3" stroke-linecap="round" />
+  
+  <!-- Openings (doors/windows) -->
+  <line x1="394.60" y1="581.33" x2="415.00" y2="581.33" stroke="#e74c3c" stroke-width="4" stroke-linecap="round" />
+    <line x1="477.33" y1="659.53" x2="477.33" y2="639.13" stroke="#e74c3c" stroke-width="4" stroke-linecap="round" />
+    <line x1="326.60" y1="536.00" x2="347.00" y2="536.00" stroke="#e74c3c" stroke-width="4" stroke-linecap="round" />
+    <line x1="314.13" y1="717.33" x2="368.53" y2="717.33" stroke="#3498db" stroke-width="3" stroke-linecap="round" />
+  
+  <!-- Labels -->
+  <text x="386.67" y="649.33" font-size="14" fill="#2c3e50" text-anchor="middle" dominant-baseline="middle" font-family="Arial, sans-serif">Living Room</text>
+    <text x="522.67" y="649.33" font-size="14" fill="#2c3e50" text-anchor="middle" dominant-baseline="middle" font-family="Arial, sans-serif">Kitchen</text>
+    <text x="432.00" y="558.67" font-size="14" fill="#2c3e50" text-anchor="middle" dominant-baseline="middle" font-family="Arial, sans-serif">Hallway</text>
+    <text x="336.80" y="490.67" font-size="8" fill="#2c3e50" text-anchor="middle" dominant-baseline="middle" font-family="Arial, sans-serif">Master Bedroom</text>
+    <text x="407.07" y="470.27" font-size="10" fill="#2c3e50" text-anchor="middle" dominant-baseline="middle" font-family="Arial, sans-serif">Bathroom</text>
+  
+  <!-- Dimensions -->
+  
+</svg>

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "planscript",
+  "version": "0.1.0",
+  "description": "PlanScript - A DSL for defining floor plans",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "bin": {
+    "planscript": "./dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "examples",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build:grammar": "peggy --plugin ts-pegjs --extra-options-file src/parser/pegconfig.json -o src/parser/grammar.ts src/parser/grammar.pegjs",
+    "build:ts": "tsc",
+    "build": "npm run build:grammar && npm run build:ts",
+    "dev": "npm run build:grammar && tsc --watch",
+    "test": "npm run build:grammar && vitest run",
+    "test:watch": "npm run build:grammar && vitest",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "planscript",
+    "dsl",
+    "floor-plan",
+    "floorplan",
+    "architecture",
+    "blueprint",
+    "compiler",
+    "svg"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/user/planscript"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.0",
+    "peggy": "^3.0.2",
+    "ts-pegjs": "^4.2.1",
+    "typescript": "^5.3.3",
+    "vitest": "^1.2.0"
+  }
+}