Cli and server versions of queryleaf

Author: rathboma

.eslintrc.js

@@ -0,0 +1,27 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+    project: ['./tsconfig.json', './packages/*/tsconfig.json'],
+  },
+  plugins: ['@typescript-eslint'],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  env: {
+    node: true,
+    jest: true,
+  },
+  rules: {
+    '@typescript-eslint/no-explicit-any': 'warn',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/no-unused-vars': ['error', { 
+      argsIgnorePattern: '^_',
+      varsIgnorePattern: '^_' 
+    }],
+  },
+  ignorePatterns: ['dist', 'node_modules', '*.js', '*.d.ts']
+};

.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+    
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x]
+    
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'yarn'
+    
+    - name: Install dependencies
+      run: yarn install --frozen-lockfile
+    
+    - name: Build
+      run: yarn build
+    
+    - name: Lint
+      run: yarn lint
+    
+    - name: Format check
+      run: yarn format:check
+    
+    - name: Typecheck
+      run: yarn typecheck
+    
+    - name: Test
+      run: yarn test

.gitignore

@@ -2,9 +2,11 @@
 /dist
 /build
 /site
+packages/*/dist
 
 # Dependencies
 /node_modules
+packages/*/node_modules
 
 # IDE and OS files
 .idea/

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "trailingComma": "es5",
+  "singleQuote": true,
+  "printWidth": 100,
+  "tabWidth": 2
+}

README-monorepo.md

@@ -0,0 +1,99 @@
+# QueryLeaf Monorepo Guidelines
+
+This repository uses a monorepo structure with Yarn workspaces to manage multiple packages.
+
+## Repository Structure
+
+- `packages/lib`: Core library for SQL to MongoDB translation
+- `packages/cli`: Command-line interface
+- `packages/server`: REST API server
+
+## Development Workflow
+
+### Installation
+
+```bash
+yarn install
+```
+
+### Building
+
+```bash
+# Build all packages
+yarn build
+
+# Build individual packages
+yarn build:lib
+yarn build:cli
+yarn build:server
+```
+
+### Testing
+
+```bash
+# Run all tests
+yarn test
+
+# Run tests for individual packages
+yarn test:lib
+yarn test:cli
+yarn test:server
+
+# Run specific test types for the lib package
+yarn test:lib:unit
+yarn test:lib:integration
+```
+
+### Code Quality
+
+```bash
+# Run TypeScript type checking
+yarn typecheck
+
+# Run linting
+yarn lint
+yarn lint:fix
+
+# Run code formatting
+yarn format
+yarn format:check
+
+# Run all validations (types, linting, tests, formatting)
+yarn validate
+```
+
+## Adding new features
+
+1. Determine which package(s) need to be modified
+2. Make changes in the appropriate package(s)
+3. Add tests in the package's `tests` directory
+4. Run `yarn validate` to ensure everything passes
+5. Submit a pull request
+
+## Dependency Management
+
+- Shared dev dependencies (TypeScript, ESLint, etc.) are in the root `package.json`
+- Package-specific dependencies are in each package's `package.json`
+- Use `yarn add <package> -W` to add a dependency to the root
+- Use `yarn workspace @queryleaf/[package] add <dependency>` to add a dependency to a specific package
+
+## Release Process
+
+Each package is versioned independently but released together.
+
+1. Update versions in each package's `package.json`
+2. Build all packages: `yarn build`
+3. Publish packages: 
+   ```
+   cd packages/lib && npm publish
+   cd ../cli && npm publish
+   cd ../server && npm publish
+   ```
+
+## Best Practices
+
+1. Keep packages focused on a single responsibility
+2. Share code through dependencies, not copy-paste
+3. Ensure all code is properly tested
+4. Maintain consistent coding style across packages using ESLint and Prettier
+5. Document all public APIs

bin/queryleaf

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../dist/cli.js');

bin/queryleaf-server

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../dist/server.js');

docs/getting-started/installation.md

@@ -13,18 +13,70 @@ Before installing QueryLeaf, make sure you have:
 
 ## Installing QueryLeaf
 
-You can install QueryLeaf using npm or yarn:
+QueryLeaf is divided into three separate packages to minimize dependencies:
+
+### Core Library
+
+Install the core library as a dependency in your project:
+
+=== "npm"
+    ```bash
+    npm install @queryleaf/lib
+    ```
+
+=== "yarn"
+    ```bash
+    yarn add @queryleaf/lib
+    ```
+
+### Command Line Interface
+
+To use the command-line interface, install the CLI package:
 
 === "npm"
     ```bash
-    npm install queryleaf
+    # As a project dependency
+    npm install @queryleaf/cli
+    
+    # Or globally
+    npm install -g @queryleaf/cli
     ```
 
 === "yarn"
     ```bash
-    yarn add queryleaf
+    # As a project dependency
+    yarn add @queryleaf/cli
+    
+    # Or globally
+    yarn global add @queryleaf/cli
     ```
 
+After installation, you'll have access to the `queryleaf` command.
+
+### Web Server
+
+To use the web server for a MongoDB SQL proxy, install the server package:
+
+=== "npm"
+    ```bash
+    # As a project dependency
+    npm install @queryleaf/server
+    
+    # Or globally
+    npm install -g @queryleaf/server
+    ```
+
+=== "yarn"
+    ```bash
+    # As a project dependency
+    yarn add @queryleaf/server
+    
+    # Or globally
+    yarn global add @queryleaf/server
+    ```
+
+After installation, you'll have access to the `queryleaf-server` command.
+
 ## TypeScript Support
 
 QueryLeaf is written in TypeScript and includes type definitions out of the box. You don't need to install any additional packages for TypeScript support.
@@ -114,4 +166,6 @@ Now that you have installed QueryLeaf, you can proceed to:
 
 - [Quick Start Guide](quickstart.md): Learn the basics of using QueryLeaf
 - [Core Concepts](../usage/core-concepts.md): Understand the architecture and principles
+- [CLI Documentation](../usage/cli.md): Learn how to use the command-line interface
+- [Server Documentation](../usage/server.md): Learn how to run and use the web server
 - [Examples](../usage/examples.md): See practical examples of using QueryLeaf