Skip to content

Releases: zjp-CN/term-rustdoc

0.2.0 - 2024-03-16

16 Mar 07:14
Compare
Choose a tag to compare

Release Notes

🚀 Features

  • Add ItemInnerKind for Navi
  • Render NaviOutline
  • Update_outline from NaviOutline for InnerItem
  • Highlight_current_line on NaviOutline
  • Impl_tree on DModule for displaying ITABImpls
  • Always able to jump back to module tree
  • DImplInner; sort by name in DImpl and DImplInner
  • Merge inherent items
  • Sort associated items by name in Traits
  • Don't restore terminal when error happens
  • Recompile outdated doc cache when opening the doc
  • Tab keystroke for switching between NaviAction
  • NaviAction::TraitAssociated and TraitImplementors tree view
  • Set_previous_action on Left or h keystroke
  • Jkl keystroke alias
  • Display fields_tree for NaviAction::StructInner
  • Display fields_tree for NaviAction::StructInner on Union
  • Add DataItemKind::Module to jump into a module on NaviAction
  • Struct item string
  • Display item Declaration on content panel

🐛 Bug Fixes

  • Remove trailing whitespace in rendering markdown lines
  • Get_item_inner by searching in recursive modules
  • NaviOutline kind for reexport items
  • Use visible_lines in get_line_on_screen
  • Render width and max_width for Outline
  • Show implementor on inherent block
  • DImplInner show fn; update snapshots
  • Add NaviAction::Item; fix navi interaction bugs
  • Pin the width of navi
  • NaviOutline and cursor behavior
  • Reset cursor position when init setu
  • Parenthesized_type for borrow_ref on DynTrait
  • Method self receiver on borrow_ref
  • Lifetime contains the tick, so don't need to format it
  • Add fn keyword back in fn_item
  • Hrtb in wher bound
  • Don't need argument names for fn_pointer
  • Use IDMap to dive into fields
  • Keep colon in where bound
  • Carefully handle format for named structs
  • None field in a tuple struct is a placeholder, thus not hide them

🚜 Refactor

  • Mv Page to own module
  • Rm CrateDoc from NaviOutline; add Scroll area for it
  • Outline with OutlineInner
  • Mv DataItemKind to lib; search after the kind is known
  • Use RPITIT trick to reduce parameter passing
  • Type_name returns XString without Option any more
  • Generic_*_for_slice returns Option if empty
  • Parse trait in decl

📚 Documentation

  • Add github release badget
  • Update Help for outline
  • Immature module inner action
  • Typename; don't expose fn_header fn_decl as public items
  • Item_str; make Parse public
  • Enhancement note for rust_code

🧪 Testing

  • Update snapshots
  • Update snapshots
  • Apply DisplaySlice instead of Debug for slice

⚙️ Miscellaneous Tasks

  • Mv Navi to own module
  • Don't make fields in Navigation public
  • NaviOutline owns CrateDoc, thus only need to pass selected ID
  • Set_item_inner return Option
  • Add inner_item for Outline
  • Add render: OutlineKind in Outline
  • ScrollTreeLines for NaviOutline
  • Render NaviOutline
  • Leave enough space for NaviOutline
  • Compute height and width for NaviOutline
  • Use NaviAction to pass action to Outline from Navi
  • Reset_navi_outline; back_to_home
  • Default for DocTree
  • Log path for empty InnerItem TreeLines
  • Rm doc arg for rendering inner_item
  • Rename InnerItem in Outline to Setu
  • Const first in display order, then type alias, finally fn
  • Warn bad state with names in DTrait::new
  • Slim icons for associated items
  • Adjust TOC width; add right padding for md
  • Help md padding
  • Display fields_tree without node tag
  • Names_node iter case & doc; expand/fold only for Module tree
  • Add Changelog
  • Mv type_name to own module
  • Cranelift backend for dev profile
  • Support BorrowedRef on type_name
  • Support Self receiver in methods
  • Short_type_name for fn_item
  • Mv fn_item to own module
  • Handle DynTrait in type_name; split type_name into long and short
  • Don't filter out None from type_name in resolve_path
  • TypeName & ResolvedPath use FnOnce + Copy bound
  • Primitive for type_name
  • Add Primitive for type_name; update tests
  • Add array slice tuple for type_name
  • Add generics i.e (generics_def, where_bounds) on fn_item
  • Fill in RawPointer FunctionPointer ImplTrait branch in typename
  • Fill in QualifiedPath in typename
  • Rename Parse trait to Format
  • Rm item and item_str from Format
  • Use IDMap to look into field type; add tests for structs
  • Newline and ident for where bound
  • Multiline args in fn items
  • Put most likely cases first in struct formating
  • Rm Blocks field from MarkdownArea
  • Rename page::decl to page::content
  • Add border for Declaration
  • Update_area even if no valid id; add spacing for decl and md
  • Private fields display in structs
  • Prepare for release

Download term-rustdoc 0.2.0

File Platform Checksum
term-rustdoc-aarch64-apple-darwin.tar.xz Apple Silicon macOS checksum
term-rustdoc-x86_64-apple-darwin.tar.xz Intel macOS checksum
term-rustdoc-x86_64-pc-windows-msvc.zip x64 Windows checksum
term-rustdoc-x86_64-unknown-linux-gnu.tar.xz x64 Linux checksum
term-rustdoc-x86_64-unknown-linux-musl.tar.xz x64 MUSL Linux checksum

v0.1.1

02 Mar 15:26
Compare
Choose a tag to compare