Expand description
ยง๐ ๏ธ Developer Guide
Dockerfile 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:
- Immutability: Uses the Green/Red Tree structure to ensure efficient sharing of syntax trees.
- Fault Tolerance: Core logic is highly inclusive of erroneous input.
- Scalability: Convenient for downstream tools to perform secondary development.
Re-exportsยง
pub use crate::ast::DockerfileRoot;pub use crate::builder::DockerfileBuilder;pub use crate::language::DockerfileLanguage;
Modulesยง
- ast
- Root node of the Dockerfile AST.
- builder
- Builder for the Dockerfile AST.
- language
- Language configuration for Dockerfile.
- lsp
- Dockerfile Lsp
Structsยง
- Dockerfile
Lexer - Lexer for Dockerfile files.
- Dockerfile
Parser - Parser for Dockerfile.
Enumsยง
- Dockerfile
Element Type - Element types for the Dockerfile parser.
- Dockerfile
Token Type - Token types for the Dockerfile lexer.