fix: failing test (currently: 27 passing 15 failing)

Author: CodeMeAPixel

.eslintrc.js

@@ -14,7 +14,7 @@ module.exports = {
     sourceType: 'module'
   },
   rules: {
-    '@typescript-eslint/no-unused-vars': 'error',
+    '@typescript-eslint/no-unused-vars': 'warn',
     '@typescript-eslint/explicit-function-return-type': 'warn',
     '@typescript-eslint/no-explicit-any': 'warn',
     'prefer-const': 'error',

.github/workflows/docs.yml .github/workflows/github-pages.yml.github/workflows/docs.yml renamed to .github/workflows/github-pages.yml

@@ -2,9 +2,7 @@ name: Deploy GitHub Pages
 
 on:
     push:
-        branches:
-          - master
-        paths: ['docs/**']
+        branches: [main, master]
     workflow_dispatch:
 
 permissions:

.github/workflows/test-build.yml

@@ -0,0 +1,27 @@
+name: Test & Build
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  test-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Bun
+        uses: oven-sh/setup-bun@v1
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Build library
+        run: bun run build
+
+      - name: Run tests
+        run: bun test

FAILING_TESTS.md

@@ -0,0 +1,32 @@
+# FAILING_TESTS
+
+## Type Generator
+- [ ] Convert function types: Function return type is `any` instead of the correct type (should be `boolean`, `number`, etc.).
+- [ ] Convert method types: Method signatures are not correctly omitting `self` and/or return type is not correct.
+- [ ] Comment Preservation: Single-line and multi-line comments are not preserved in the generated TypeScript.
+- [ ] Advanced Type Conversion: Union types with object literals are not handled correctly.
+- [ ] Advanced Type Conversion: Functions with multiple parameters are not handled correctly.
+- [ ] Type Generator Options: `useUnknown` does not output `unknown` as expected.
+- [ ] Type Generator Options: `interfacePrefix` does not prefix interface names as expected.
+- [ ] Type Generator Options: `semicolons` option does not control semicolon output as expected.
+
+## Error Handling
+- [ ] Syntax errors are not always detected (test expects errors, but none are reported).
+
+## Snapshot Tests
+- [ ] Game types snapshot does not match expected output (likely due to comment or type conversion issues).
+
+## CLI Tools
+- [ ] Convert a single file: Output file is not generated or does not contain expected content.
+- [ ] Convert a directory: Output files are not generated or do not contain expected content.
+- [ ] Validate a file: CLI does not validate file as expected.
+- [ ] Use config file: CLI does not respect config file options.
+
+## Plugins
+- [ ] Plugin system: Plugin transforms are not applied as expected (e.g., type transforms, added fields).
+
+---
+**Note:**  
+- Some failures are due to missing or incomplete features (e.g., plugin system, comment preservation).
+- Some failures are due to incorrect or missing type conversions (especially for function and method types).
+- Some failures are due to CLI not being fully implemented or not matching test expectations.

README.md

@@ -31,6 +31,9 @@
 
 LuaTS bridges the gap between Lua/Luau and TypeScript ecosystems, allowing developers to leverage type safety while working with Lua codebases. Whether you're developing Roblox games, working with embedded Lua, or maintaining legacy Lua code, LuaTS helps you generate accurate TypeScript definitions for better IDE support, type checking, and developer experience.
 
+> [!CAUTION]
+> This lib is still a work in progress, as such you WILL NOT find it on NPM yet!
+
 ## ✨ Features
 
 - 🔁 **Converts Lua/Luau type declarations into TypeScript interfaces**
@@ -114,6 +117,43 @@ Visit **[luats.codemeapixel.dev](https://luats.codemeapixel.dev)** for comprehen
 - [Examples](https://luats.codemeapixel.dev/examples)
 - [Contributing Guide](https://luats.codemeapixel.dev/contributing)
 
+## 🛠 CLI Usage
+
+The CLI supports converting files and directories:
+
+```bash
+npx luats convert src/file.lua -o src/file.d.ts
+npx luats dir src/lua -o src/types
+```
+
+### CLI Options
+
+| Option         | Alias | Description                       |
+| -------------- | ----- | --------------------------------- |
+| --input        | -i    | Input file or directory           |
+| --output       | -o    | Output file or directory          |
+| --config       | -c    | Path to config file               |
+| --silent       | -s    | Suppress output messages          |
+| --verbose      | -v    | Verbose output                    |
+| --watch        | -w    | Watch for file changes            |
+
+### Configuration File
+
+You can use a `luats.config.json` or `.luatsrc.json` file to specify options:
+
+```json
+{
+  "outDir": "./types",
+  "include": ["**/*.lua", "**/*.luau"],
+  "exclude": ["**/node_modules/**", "**/dist/**"],
+  "plugins": [],
+  "typeGeneratorOptions": {
+    "exportTypes": true,
+    "generateComments": true
+  }
+}
+```
+
 ## 🤝 Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.

TODO.md

@@ -0,0 +1,50 @@
+# TODO Checklist
+
+- [x] **Fix all TypeScript build errors and warnings**
+  - [x] Remove duplicate/unused functions and variables
+  - [x] Correct all type/interface issues (especially optional properties)
+  - [x] Ensure all imports are correct and used
+- [x] **Implement real Lua/Luau parsing in `generateTypeScript`**
+  - [x] Integrate or stub a parser for Lua/Luau AST generation
+- [x] **Add proper plugin loading and application in CLI processor**
+  - [x] Remove duplicate `applyPlugins` and implement dynamic plugin loading
+- [x] **Expand CLI validation logic beyond placeholder**
+  - [x] Add real validation for Lua/Luau files
+- [ ] **Write unit tests for CLI and processor modules**
+  - [ ] Cover CLI commands and processor logic
+- [ ] **Improve error handling and user feedback in CLI**
+  - [ ] Make CLI output clear and actionable
+- [x] **Document configuration options and CLI usage**
+  - [x] Add README and CLI help improvements
+- [ ] **Add support for more CLI commands (e.g., format, lint)**
+- [ ] **Ensure cross-platform compatibility (Windows, Linux, macOS)**
+  - [ ] Replace `rm -rf` with cross-platform alternatives (e.g., `rimraf`)
+- [ ] **Set up CI for automated builds and tests**
+  - [ ] Add GitHub Actions or similar workflow
+
+---
+
+## Additional Ideas & Improvements
+
+- [ ] **Publish TypeScript declaration files (`.d.ts`) for all public APIs**
+- [ ] **Add ESM and CJS dual support with proper `"exports"` field**
+- [ ] **Provide a VSCode extension for Lua/Luau → TypeScript conversion**
+- [ ] **Add support for custom output templates (e.g., for JSDoc, TSDoc, etc.)**
+- [ ] **Enable incremental builds for large codebases**
+- [ ] **Support for Lua 5.4 and future Luau features**
+- [ ] **Add a web playground (REPL) for live conversion and preview**
+- [ ] **Add a `luats init` command to scaffold config and example files**
+- [ ] **Support for YAML config files in addition to JSON**
+- [ ] **Add CLI auto-completion scripts for bash/zsh/fish**
+- [ ] **Improve error messages with code frames and suggestions**
+- [ ] **Add a `luats watch` mode for live conversion in dev workflows**
+- [ ] **Provide migration guides for legacy Lua codebases**
+- [ ] **Add benchmarking and performance tests**
+- [ ] **Support for sourcemaps or code mapping back to Lua**
+- [ ] **Add a logo/banner to npm and GitHub README**
+- [ ] **Add badges for test coverage, bundle size, etc.**
+- [ ] **Publish example projects and templates**
+- [ ] **Add a `luats doctor` command for troubleshooting environment/config issues**
+- [ ] **Support for monorepo setups and workspace-aware config**
+- [ ] **Add support for extern types/classes (typically ending in a .d.lua file)**
+- [ ] **Add ability to reverse logic (ie: transform typescript into lua)**

docs/_includes/head_custom.html

@@ -9,14 +9,14 @@
 <meta property="og:title" content="LuaTS - TypeScript Library for Lua and Luau" />
 <meta property="og:description" content="A comprehensive TypeScript library for parsing, formatting, analyzing, and transforming Lua and Luau code with robust type interfaces and AST manipulation" />
 <meta property="og:type" content="website" />
-<meta property="og:url" content="https://codemeapixel.github.io/luats" />
-<meta property="og:image" content="https://codemeapixel.github.io/luats/assets/assets/banner.png" />
+<meta property="og:url" content="https://luats.codemeapixel.dev" />
+<meta property="og:image" content="/assets/banner.png" />
 
 <!-- Twitter Card -->
 <meta name="twitter:card" content="summary_large_image" />
 <meta name="twitter:title" content="LuaTS - TypeScript Library for Lua and Luau" />
 <meta name="twitter:description" content="A comprehensive TypeScript library for parsing, formatting, analyzing, and transforming Lua and Luau code with robust type interfaces and AST manipulation" />
-<meta name="twitter:image" content="https://codemeapixel.github.io/luats/assets/banner.png" />
+<meta name="twitter:image" content="/assets/banner.png" />
 <meta name="twitter:site" content="@CodeMeAPixel" />
 <meta name="twitter:creator" content="@CodeMeAPixel" />
 

examples/plugin-demo.ts

@@ -1,7 +1,7 @@
 import { parseLuau, generateTypes, generateTypesWithPlugins } from '../src/index';
 import ReadonlyPlugin from './readonly-plugin';
 import { loadPlugins, applyPlugins } from '../src/plugins/plugin-system';
-import { TypeGenerator } from '../src/generators/typescript';
+import { TypeGenerator } from '../src/generators';
 
 // Example Luau code with type definitions
 const luauCode = `
@@ -33,8 +33,7 @@ type GameEvent = {
 async function runDemo() {
   console.log('=== Parsing Luau Code ===');
   try {
-    const parser = new parseLuau();
-    const ast = parser.parse(luauCode);
+    const ast = parseLuau(luauCode);
     console.log('✅ Successfully parsed AST');
     console.log(`Found ${ast.body.length} top-level statements`);
   } catch (error) {
@@ -56,21 +55,20 @@ async function runDemo() {
     const typesWithPlugin = await generateTypesWithPlugins(
       luauCode,
       { useUnknown: true },
-      ['./examples/readonly-plugin.js'] // This would work if the plugin is compiled to JS
+      ['./examples/readonly-plugin.js']
     );
 
     // Method 2: Manual plugin application (for demonstration)
-    const parser = new parseLuau();
+    const ast = parseLuau(luauCode);
     const generator = new TypeGenerator({ generateComments: true });
-    const ast = parser.parse(luauCode);
 
     // Apply the plugin directly
     applyPlugins(generator, [ReadonlyPlugin], {
       typeGeneratorOptions: { generateComments: true },
       config: { preserveComments: true, commentStyle: 'jsdoc' }
     });
 
-    const typesWithManualPlugin = generator.generateFromLuauAST(ast);
+    const typesWithManualPlugin = generator.generateTypeScript(ast);
 
     console.log('✅ Generated TypeScript interfaces with readonly plugin:');
     console.log(typesWithManualPlugin);

src/cli/config.ts

@@ -42,6 +42,7 @@ export interface LuatsConfig {
 
   // Logging options
   verbose?: boolean;
+  silent?: boolean;
 }
 
 /**
@@ -74,7 +75,8 @@ export const defaultConfig: LuatsConfig = {
 
   plugins: [],
 
-  verbose: false
+  verbose: false,
+  silent: false
 };
 
 /**