Skip to main content

Crate oak_django

Crate oak_django 

Source
Expand description

ยง๐Ÿ› ๏ธ Developer Guide

Django support for the Oak language framework.

This directory contains the core logic implementation of the project. Below are instructions for a quick start.

ยง๐Ÿšฆ Quick Start

ยงCore API Usage

// Example: Basic calling workflow
fn main() {
    // 1. Initialization
    // 2. Execute core logic
    // 3. Handle returned results
}

ยง๐Ÿ” Module Description

  • lib.rs: Exports public interfaces and core traits.
  • parser/ (if exists): Implements specific syntax parsing logic.
  • ast/ (if exists): Defines the syntax tree structure.

ยง๐Ÿ—๏ธ Architecture Design

The project follows the general architectural specifications of the Oak ecosystem, emphasizing:

  1. Immutability: Uses the Green/Red Tree structure to ensure efficient sharing of syntax trees.
  2. Fault Tolerance: Core logic is highly inclusive of erroneous input.
  3. Scalability: Convenient for downstream tools to perform secondary development.

Re-exportsยง

pub use crate::lsp::highlighter::DjangoHighlighter;
pub use crate::ast::DjangoRoot;

Modulesยง

ast
Django Ast
lsp
Django Lsp

Structsยง

DjangoLanguage
Django template language configuration
DjangoLexer
Lexer for Django template source code.
DjangoParser
Parser for Django templates.

Enumsยง

DjangoElementType
Element types for Django templates.
DjangoTokenType
Token types for the Django template lexer.