https://github.com/gostrafx/lua-file-creator
Quickly create Lua or Luau files with your preferred file extension and optional Knit framework support.
https://github.com/gostrafx/lua-file-creator
knit knit-roblox lua luau roblox roblox-lsp vscode vscode-extension
Last synced: 8 months ago
JSON representation
Quickly create Lua or Luau files with your preferred file extension and optional Knit framework support.
- Host: GitHub
- URL: https://github.com/gostrafx/lua-file-creator
- Owner: gostrafx
- Created: 2025-08-05T21:40:08.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2025-08-08T05:09:05.000Z (8 months ago)
- Last Synced: 2025-08-08T05:28:25.986Z (8 months ago)
- Topics: knit, knit-roblox, lua, luau, roblox, roblox-lsp, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=gostrafx.lua-file-creator
- Size: 1.28 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Lua File Creator
**Lua File Creator** is a Visual Studio Code extension that helps you quickly scaffold Lua and Luau files, including support for the Roblox Knit framework. With configurable file types and naming conventions, this tool boosts productivity when working with Roblox Lua projects.
---
## 🚀 Features
- Quickly create common Lua file types:
- `ModuleScript`
- `Script` (Server)
- `LocalScript` (Client)
- Optional support for [Knit](https://github.com/Sleitnick/Knit) framework:
- `Controller`
- `Service`
- Intelligent filename suggestions and validation
- Automatic incrementing if file already exists
- Simple templates included for quick file creation
- Works with `.lua`, `.luau`, or any custom extension
---
## ⚙️ Requirements
- VS Code 1.60.0 or newer
- A workspace folder must be open in VS Code to create files
---
## 🛠 Extension Settings
This extension contributes the following settings under `Settings` in your `settings.json`:
| Setting | Type | Description |
|--------------------------------|----------|------------------------------------------------|
| `luafilecreator.Settings.type` | `string` | File extension to use (e.g., `.lua`, `.luau`) |
| `luafilecreator.Settings.Knit` | `boolean`| Enable/disable Knit-specific file types |
Example:
```json
{
"luafilecreator.Settings": {
"type": ".luau",
"Knit": true
}
}
```
---
## 📂 Commands
You can trigger these commands via the Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`):
- `Lua File Creator: Create ModuleScript`
- `Lua File Creator: Create Client Script`
- `Lua File Creator: Create Server Script`
- `Lua File Creator: Create Knit Controller`
- `Lua File Creator: Create Knit Service`
> Context menus for file creation are also available in the Explorer pane when enabled.
---
## 🧠 Known Issues
- Template contents are currently minimal; customizable templates are not yet supported
- Filename validation is strict and may block some edge cases
---
## 📦 Release Notes
### 1.0.0
- Initial release with basic Lua file creation
- Fixed bug with file extension handling
- Improved validation for Knit file names
- Added intelligent file naming and incrementing
- Enabled setting changes to take effect live
---
## ✨ Enjoy Using Lua File Creator?
Leave a ⭐ on the [GitHub repo](https://github.com/gostrafx/lua-file-creator) (if public) or share it with fellow Lua developers!
## ☕ Support the Project
If you find this extension helpful and want to support its development, you can [**Buy Me a Coffee**](https://streamelements.com/gostrafx/tip) — every bit of support helps keep the updates coming!