dan/oxc
1
0
Fork 0
mirror of https://github.com/danbulant/oxc synced 2026-05-19 12:19:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(oxc): add submodule documentation (#5984)

Browse source
This commit is contained in:
DonIsaac 2024-09-23 01:25:35 +00:00
parent acc2d16b41
commit bacfbb85c7
1 changed files with 38 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
crates/oxc/src/lib.rs
View file

@ -9,6 +9,9 @@ mod compiler;
pub use compiler::{Compiler, CompilerInterface};
pub mod allocator {
//! Memory arena allocator used by all other submodules.
//!
//! See the [`oxc_allocator` module-level documentation](oxc_allocator) for more information.
#[doc(inline)]
pub use oxc_allocator::*;
}
@ -19,16 +22,25 @@ pub mod ast {
}
pub mod diagnostics {
//! Error data types and utilities for handling/reporting them.
//!
//! See the [`oxc_diagnostics` module-level documentation](oxc_diagnostics) for more information.
#[doc(inline)]
pub use oxc_diagnostics::*;
}
pub mod index {
//! A Vec with newtype indexing.
//!
//! See the [`oxc_index` module-level documentation](oxc_index) for more information.
#[doc(inline)]
pub use oxc_index::*;
}
pub mod parser {
//! JavaScript/TypeScript parser.
//!
//! See the [`oxc_parser` module-level documentation](oxc_parser) for more information.
#[doc(inline)]
pub use oxc_parser::*;
}
@ -39,29 +51,45 @@ pub mod regular_expression {
}
pub mod span {
//! Source text Span and string types.
//!
//! See the [`oxc_span` module-level documentation](oxc_span) for more information.
#[doc(inline)]
pub use oxc_span::*;
}
pub mod syntax {
//! Common code for JavaScript Syntax
//!
//! See the [`oxc_syntax` module-level documentation](oxc_syntax) for more information.
#[doc(inline)]
pub use oxc_syntax::*;
}
#[cfg(feature = "semantic")]
pub mod semantic {
//! Semantic analysis of a JavaScript/TypeScript program.
//!
//! See the [`oxc_semantic` module-level documentation](oxc_semantic) for more information.
#[doc(inline)]
pub use oxc_semantic::*;
}
#[cfg(feature = "transformer")]
pub mod transformer {
//! Transformer/Transpiler
//!
//! See the [`oxc_transformer` module-level documentation](oxc_transformer) for more
//! information.
#[doc(inline)]
pub use oxc_transformer::*;
}
#[cfg(feature = "minifier")]
pub mod minifier {
//! Source code minifier.
//!
//! See the [`oxc_minifier` module-level documentation](oxc_minifier) for more information.
#[doc(inline)]
pub use oxc_minifier::*;
}
@ -74,18 +102,28 @@ pub mod mangler {
#[cfg(feature = "codegen")]
pub mod codegen {
//! AST code printer
//!
//! See the [`oxc_codegen` module-level documentation](oxc_codegen) for more information.
#[doc(inline)]
pub use oxc_codegen::*;
}
#[cfg(feature = "isolated_declarations")]
pub mod isolated_declarations {
//! `.d.ts` emit for Isolated Declarations.
//!
//! See the [`oxc_isolated_declarations` module-level documentation](oxc_isolated_declarations)
//! for more information.
#[doc(inline)]
pub use oxc_isolated_declarations::*;
}
#[cfg(feature = "sourcemap")]
pub mod sourcemap {
//! Source Maps
//!
//! See the [`oxc_sourcemap` module-level documentation](oxc_sourcemap) for more information.
#[doc(inline)]
pub use oxc_sourcemap::*;
}