Solo Build

An AI-powered build system for JavaScript and TypeScript projects with advanced code analysis capabilities.

Features

• TypeScript/JavaScript Support: Build TypeScript projects with configurable output options
• AI-Powered Analysis: Get architectural insights and optimization suggestions (coming soon)
• Workflow System: GitHub Actions-like workflow system for automation
• Code Analysis: Analyze code complexity, dependencies, and detect issues
• Framework Detection: Automatically detect frameworks and apply optimized build configurations
• Extensible: Plug-in architecture for custom transformations and analyzers

Installation

npm install solo-build

Quick Start

1. Create a configuration file in your project root:

// solo-build.config.js
module.exports = {
  sourceDir: "src",
  outDir: "dist",
  target: "es2020",
  module: "commonjs",
  minify: true,
  sourceMaps: true,
  include: ["**/*.ts"],
  exclude: ["**/*.test.ts", "node_modules/**"],
};

2. Run the build command:

npx solo-build run

CLI Commands

Build

Run the build process:

npx solo-build run [options]

Options:

• --config: Path to config file (default: solo-build.config.js)
• --workflow: Workflow to run (default: default)

Initialize

Initialize a new project with Solo Build:

npx solo-build init [options]

Options:

• --template: Template to use (default: typescript)
• --name: Project name

Analyze

Analyze code without building:

npx solo-build analyze [options]

Options:

• --config: Path to config file (default: solo-build.config.js)
• --format: Output format (default: text)

Workflow

Manage workflows:

npx solo-build workflow [command] [options]

Commands:

• list: List available workflows
• create: Create a new workflow

Configuration

Build Configuration

interface BuildConfig {
  // Project settings
  projectRoot: string;
  sourceDir: string;
  outDir: string;

  // Build options
  target: string;
  module: string;
  minify: boolean;
  sourceMaps: boolean;

  // File selection
  include: string[];
  exclude: string[];

  // Tasks
  tasks: Record<string, Task>;

  // Analysis options
  analyze: {
    complexity: boolean;
    dependencies: boolean;
    duplication: boolean;
    security: boolean;
  };

  // AI options (coming soon)
  ai: {
    enabled: boolean;
    optimizationMode: string;
    analysisDepth: string;
  };
}

Task Configuration

interface Task {
  type: string;
  command?: string;
  dependencies?: string[];
  condition?: string;
}

Workflow Configuration

interface Workflow {
  name: string;
  on: Record<string, any>;
  jobs: Record<string, Job>;
}

interface Job {
  name: string;
  steps: Step[];
}

interface Step {
  name: string;
  run?: string;
  uses?: string;
  with?: Record<string, any>;
}

Examples

Basic TypeScript Project

// solo-build.config.js
module.exports = {
  sourceDir: "src",
  outDir: "dist",
  target: "es2020",
  module: "commonjs",
  minify: true,
  sourceMaps: true,
  include: ["**/*.ts"],
  exclude: ["**/*.test.ts", "node_modules/**"],
};

React Project

// solo-build.config.js
module.exports = {
  sourceDir: "src",
  outDir: "dist",
  target: "es2020",
  module: "esm",
  minify: true,
  sourceMaps: true,
  include: ["**/*.ts", "**/*.tsx"],
  exclude: ["**/*.test.ts", "**/*.test.tsx", "node_modules/**"],
  tasks: {
    "pre-build": {
      type: "command",
      command: "rimraf dist",
    },
    "post-build": {
      type: "command",
      command: "cp public/* dist/",
    },
  },
};

With Workflow

// solo-build.config.js
module.exports = {
  // ... build config
  workflows: {
    build: {
      on: {
        push: {
          branches: ["main"],
        },
      },
      jobs: {
        build: {
          steps: [
            {
              name: "Clean",
              run: "rimraf dist",
            },
            {
              name: "Build",
              run: "solo-build run",
            },
            {
              name: "Test",
              run: "jest",
            },
          ],
        },
      },
    },
  },
};

Advanced Usage

Custom Transformations

You can create custom transformations by implementing the Transformation interface:

import { Transformation } from "solo-build";

export class MyTransformation implements Transformation {
  name = "my-transformation";

  apply(ast, context) {
    // Transform the AST
    return ast;
  }
}

Custom Analyzers

You can create custom analyzers by implementing the Analyzer interface:

import { Analyzer } from "solo-build";

export class MyAnalyzer implements Analyzer {
  name = "my-analyzer";

  analyze(ast, context) {
    // Analyze the AST
    return {
      issues: [],
      metrics: {},
    };
  }
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Coming Soon / Roadmap

The following features are planned for upcoming releases:

AI Integration (High Priority)

• AI-Powered Architectural Insights: Advanced code analysis with architectural recommendations
• Optimization Suggestions: AI-generated suggestions for code optimization
• Code Quality Analysis: Intelligent detection of code smells and anti-patterns
• Dependency Management: Smart recommendations for dependency updates and security fixes

Other Planned Features

• Enhanced Minification: Integration with Terser for better code optimization
• Code Splitting: Automatic code splitting for improved performance
• More Output Formats: Support for various module formats (ESM, UMD, etc.)
• Plugin System: Extensible plugin architecture for custom build steps
• Incremental Builds: Support for faster incremental builds
• Watch Mode: Live rebuilding when files change
• Performance Profiling: Detailed performance metrics for build optimization

To Do

The following are specific tasks that need to be completed in the near term:

AI Integration Implementation

• [ ] Integrate with OpenAI API for code analysis
• [ ] Implement architectural pattern recognition
• [ ] Create AI-powered optimization suggestion engine
• [ ] Add configuration options for AI depth and focus areas
• [ ] Implement caching for AI responses to reduce API calls

Testing Improvements

• [ ] Add tests for the Transformer component
• [ ] Add tests for the Workflow Engine
• [ ] Create more comprehensive integration tests
• [ ] Add performance benchmarks

Documentation Enhancements

• [ ] Add more examples for different project types
• [ ] Create video tutorials for common workflows
• [ ] Document all configuration options in detail
• [ ] Add troubleshooting guide

Performance Optimizations

• [ ] Implement incremental builds
• [ ] Add watch mode for development
• [ ] Optimize parallel processing of files
• [ ] Reduce memory usage for large projects

License

MIT

Solo Build - Code Report Generator

Reporter Component

The Reporter component generates comprehensive reports on your codebase, including code quality, build performance, and architecture analysis.

Features

• Comprehensive reports on build process, code quality, and performance
• Multiple report formats: HTML, JSON, and Markdown
• Visualizations for complexity and dependencies
• Issue summaries and recommendations
• Performance metrics and build time analysis

CLI Usage

Generate all reports with default settings:

npx solo-build analyze --config solo-build.config.js

Specify report formats:

npx solo-build analyze --format html,json --config solo-build.config.js

Generate only specific types of reports:

npx solo-build analyze --report-type complexity,dependencies --config solo-build.config.js

Customize the output directory:

npx solo-build analyze --output-dir ./my-reports --config solo-build.config.js

Control visualizations:

npx solo-build analyze --visualizations true --config solo-build.config.js

Full example with multiple options:

npx solo-build analyze \
  --config solo-build.config.js \
  --format html,json \
  --report-type complexity,issues,dependencies \
  --output-dir ./reports \
  --visualizations true

Generate reports as part of the build process:

npx solo-build run --reports true --config solo-build.config.js

After generating reports, open them in your browser:

npx solo-build report open

To see a list of all generated reports:

npx solo-build report list

Configuration in solo-build.config.js

You can also configure reporting options in your config file:

// solo-build.config.js
module.exports = {
  sourceDir: "src",
  outDir: "dist",
  // ... other build options

  // Analysis configuration
  analyze: {
    complexity: true,
    dependencies: true,
    duplication: true,
    security: true,
  },

  // Reporting configuration
  reports: {
    enabled: true, // Set to false to disable reports
    formats: ["html", "json", "markdown"],
    types: ["complexity", "issues", "dependencies", "performance"],
    outputDir: "reports",
    includeVisualizations: true,
  },
};

Programmatic Usage

You can also use the Reporter component directly for more control:

import { Reporter } from "@solo-build/reporter";
import { Analyzer } from "@solo-build/analyzer";

// Initialize
const reporter = new Reporter(config);
const analyzer = new Analyzer(config);

// Analyze your code
const analysisResult = await analyzer.analyze("./src");

// Generate reports
const reports = await reporter.generateReports(analysisResult, {
  duration: buildDuration,
  stats: buildStats,
});

Customizing Reports

You can customize report templates by creating your own:

1. Create custom templates in a directory
2. Extend the Reporter class to use your templates

class CustomReporter extends Reporter {
  constructor(config) {
    super(config);
    this.templateDir = "./my-templates";
  }

  // Override methods to customize report generation
  async generateComplexityReport(analysis, format) {
    // Custom implementation
  }
}

Report Types

The Reporter generates several types of reports:

1. Complexity reports - Code complexity metrics
2. Issues reports - Code issues and suggestions
3. Dependencies reports - Module dependencies and relationships
4. Performance reports - Build performance metrics
5. Visualization reports - Visual representations of complexity and dependencies
6. Summary reports - Overview of all analysis with recommendations

Examples

Check the examples directory for detailed examples:

• reporter-usage.ts - Basic usage
• using-in-build-pipeline.ts - Integration with build pipeline
• customizing-reports.ts - Custom templates and report formats
• cli-usage.md - Complete CLI usage guide

License

MIT