Skip to content

Library node docs #273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 12 commits into from
Jun 19, 2025
Merged

Library node docs #273

merged 12 commits into from
Jun 19, 2025

Conversation

jeparlefrancais
Copy link
Contributor

@jeparlefrancais jeparlefrancais commented Jun 19, 2025 •
edited
Loading

Related #150

These changes add documentation for the Rust docs site.

This also fixes the new clippy lints that came up with Rust 1.87. It involved boxing a few structs in some AST node enums to reduce the size between variants.

The wasm build for the site was failing so that is fixed too!

  • add entry to the changelog

@github-actions GitHub Actions
Copy link

Coverage after merging library-node-docs into main will be

86.75%

Coverage Report for Changed Files
FileStmtsBranchesFuncsLinesUncovered Lines
src
   ast_converter.rs88.80%100%90.99%88.70%1013, 1037, 1057–1059, 1080, 1118, 1122–1125, 1158, 1178, 1193, 1218, 1256, 1275–1277, 1322, 1356, 1371, 1387–1389, 1399, 1404–1406, 1421, 1441, 1572–1574, 1635–1637, 1688–1690, 1714–1717, 1752–1754, 1782–1784, 1788–1790, 1851–1852, 1878–1880, 1887–1889, 1907–1909, 1933–1935, 2005, 2010–2012, 2032, 2038–2040, 2045–2047, 2072–2074, 2094, 2151–2153, 2177–2179, 218, 2180, 219–220, 2210–2212, 2218–2220, 2223–2225, 2287–2289, 2301–2303, 2307–2309, 2323, 2330, 2345, 235–237, 2374, 2457–2459, 2487–2489, 2510–2512, 2542–2544, 2560, 2564, 2588–2590, 2602–2604, 2624–2626, 265–267, 2681–2683, 2715, 3054–3061, 3063–3070, 3072–3083, 3092, 3094–3099, 3101–3106, 3109, 3135–3137, 3148–3150, 3168–3170, 488–490, 494–496, 604, 619–621, 656–658, 666, 680, 695–697, 701–703, 718–720, 724, 733–735, 776, 787–789, 795–797, 840, 927, 931–933
   parser.rs87.23%100%94.12%86.29%23–24, 31–32, 528–534, 73–77, 89
src/cli
   mod.rs84%100%80%85%18, 26–27
src/frontend
   configuration.rs88.28%100%83.67%88.99%142–159, 201–205, 257, 26, 59–61, 72–75
   error.rs71.92%100%68.75%72.28%113–118, 124–126, 128–130, 169, 177, 183, 190, 217–221, 232–235, 237, 241–246, 259–264, 268–273, 277–282, 286–291, 303–304, 317–318, 320–321, 338, 347, 380, 382, 387–388, 406–410, 413–418
   mod.rs100%100%100%100%
   options.rs83.33%100%83.33%83.33%51–54, 59–62
   resources.rs77%100%73.17%77.64%112–118, 120, 128–131, 153, 155–160, 164–167, 180–183, 190–193, 275–277, 290–292, 294–299, 57–58, 77
   worker_tree.rs50%100%43.33%50.63%108–112, 114–118, 126–127, 137, 165, 176–177, 180, 184–185, 191–192, 194, 198, 208–210, 213, 265, 275, 282–286, 289–294, 297–298, 300–309, 311–313, 316–317, 319–324, 326–329, 332–333, 335–344, 346–349, 351–356, 358, 360, 362–368, 372–373, 376–379, 382–385, 387–392, 411–412, 414–424, 426, 428, 49–52, 60–63, 75–80
src/generator
   mod.rs98.65%100%100%98.55%354, 370, 374
src/nodes
   arguments.rs87.93%100%91.30%87.10%128–129, 171–174, 176, 74–76, 97–98
   block.rs97.50%100%96.72%97.61%230–232, 279–284, 92
   function_body.rs100%100%100%100%
   function_call.rs90.80%100%88.24%91.43%109–111, 121–123
   identifier.rs94.29%100%91.67%94.83%76–78
   mod.rs100%100%100%100%100–101, 110–111, 62–63
   token.rs93.13%100%94.12%92.96%110, 234–236, 26–29, 298, 30–31, 83, 95
   typed_identifier.rs100%100%100%100%
   variable.rs100%100%100%100%
src/nodes/expressions
   binary.rs94.44%100%100%93.92%108, 315, 74, 76, 84–86, 88–90, 94–99
   field.rs100%100%100%100%
   function.rs91.76%100%91.18%91.91%117, 167–169, 239–241, 55–58
   if_expression.rs93.08%100%92.31%93.27%116–118, 32–35
   index.rs100%100%100%100%
   interpolated_string.rs88.29%100%90%87.88%173–176, 178, 206–208, 312–317, 59–61
   mod.rs78.76%100%78.38%78.85%115–120, 160–162, 166–168, 172–174, 178–180, 184–186, 190–192, 208–210, 214–216, 292, 346
   number.rs90.62%100%90.54%90.63%258–262, 264, 276–280, 282–283, 339–343, 345, 388, 391–396, 398, 451
   parenthese.rs88.89%100%87.50%89.29%70–72
   prefix.rs71.43%100%77.78%69.70%34–37, 70–72, 88–90
   string.rs95.73%100%92.11%96.43%116–118, 63, 65
   string_utils.rs84.71%100%84.62%84.71%100–101, 16, 169, 17–19, 197, 21–22, 25, 29–35, 92–95, 98–99
   table.rs90.74%100%92.68%90.29%185–189, 227–231, 233, 332–334, 54–56
   type_cast.rs84.62%100%81.82%85.37%29–31, 44–46
   unary.rs100%100%100%100%
src/nodes/statements
   assign.rs100%100%100%100%
   compound_assign.rs94.59%100%91.67%95.16%127–129
   do_statement.rs100%100%100%100%
   function.rs96.88%100%96%97.09%119–121, 372–374
   generic_for.rs95%100%94.12%95.24%115–117
   if_statement.rs81.10%100%84.38%80.30%184–189, 191–193, 195–196, 212–214, 224–227, 35–41
   last_statement.rs100%100%100%100%
   local_assign.rs97.34%100%97.30%97.35%208, 91–94
   local_function.rs95.31%100%95.12%95.35%117–121, 260–262
   mod.rs100%100%100%100%
   numeric_for.rs95.40%100%94.12%95.71%144–146
   repeat_statement.rs100%100%100%100%
   type_declaration.rs65.15%100%86.36%62.50%145–151, 153–161, 163–166, 169–170, 173–179, 181–189, 191–194, 197–198, 254–260, 262–270, 272–275, 278–279
   while_statement.rs100%100%100%100%
src/nodes/types
   array.rs100%100%100%100%
   expression_type.rs100%100%100%100%
   function.rs91.95%100%94.59%91.24%195–203, 60–62
   function_variadic_type.rs100%100%100%100%
   generics.rs86.60%100%86.90%86.53%130–132, 140–142, 150–152, 318–320, 35–37, 435, 453–455, 457, 468, 482–484, 486, 533–535, 566–568, 572–574, 578–580, 584–586, 774–778, 781–782, 784–790
   intersection.rs87.50%100%84.21%88.24%105–110, 72–74
   mod.rs90.63%100%93.33%89.80%92–95, 97
   optional.rs100%100%100%100%
   parenthese.rs88.89%100%87.50%89.29%59–61
   string_type.rs56.86%100%58.33%56.41%16–20, 55–57, 61–63, 67–69, 73–75
   table.rs78.49%100%80.85%77.94%109–111, 196–198, 222–226, 228, 231–235, 237, 255–259, 261,

@jeparlefrancais jeparlefrancais merged commit bac1f20 into main Jun 19, 2025
6 checks passed
@jeparlefrancais jeparlefrancais deleted the library-node-docs branch June 19, 2025 19:26
@jeparlefrancais jeparlefrancais mentioned this pull request Aug 11, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@jeparlefrancais