deno_doc 0.53.0

doc generation for deno
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

// Copyright 2020-2022 the Deno authors. All rights reserved. MIT license.

use deno_ast::SourceRange;
use deno_ast::SourceRangedForSpanned;
use serde::Deserialize;
use serde::Serialize;

use crate::ts_type::infer_simple_ts_type_from_var_decl;
use crate::ts_type::ts_type_ann_to_def;
use crate::ts_type::TsTypeDef;
use deno_ast::ParsedSource;

#[derive(Debug, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct VariableDef {
  pub ts_type: Option<TsTypeDef>,
  pub kind: deno_ast::swc::ast::VarDeclKind,
}

pub fn get_doc_for_var_decl(
  parsed_source: &ParsedSource,
  var_decl: &deno_ast::swc::ast::VarDecl,
  previous_nodes: Vec<&crate::DocNode>,
) -> Vec<(String, VariableDef, Option<SourceRange>)> {
  assert!(!var_decl.decls.is_empty());
  let mut items = Vec::<(String, VariableDef, Option<SourceRange>)>::new();
  for var_declarator in &var_decl.decls {
    let ref_name: Option<String> =
      var_declarator.init.as_ref().and_then(|init| {
        if let deno_ast::swc::ast::Expr::Ident(ident) = &**init {
          Some(ident.sym.to_string())
        } else {
          None
        }
      });

    let maybe_ts_type_ann = match &var_declarator.name {
      deno_ast::swc::ast::Pat::Ident(ident) => ident.type_ann.as_ref(),
      deno_ast::swc::ast::Pat::Object(pat) => pat.type_ann.as_ref(),
      _ => None,
    };
    let maybe_ts_type = maybe_ts_type_ann
      .map(|def| ts_type_ann_to_def(def.as_ref()))
      .or_else(|| {
        if let Some(ref_name) = ref_name {
          previous_nodes.iter().find_map(|prev_node| {
            if prev_node.name == ref_name {
              prev_node
                .variable_def
                .as_ref()
                .and_then(|prev_def| prev_def.ts_type.clone())
            } else {
              None
            }
          })
        } else {
          None
        }
      })
      .or_else(|| {
        infer_simple_ts_type_from_var_decl(
          parsed_source,
          var_declarator,
          var_decl.kind == deno_ast::swc::ast::VarDeclKind::Const,
        )
      });

    match &var_declarator.name {
      deno_ast::swc::ast::Pat::Ident(ident) => {
        let var_name = ident.id.sym.to_string();
        let variable_def = VariableDef {
          ts_type: maybe_ts_type,
          kind: var_decl.kind,
        };
        items.push((var_name, variable_def, Some(var_declarator.range())));
      }
      deno_ast::swc::ast::Pat::Object(pat) => {
        let obj_type = maybe_ts_type.and_then(|type_def| {
          if let Some(type_def) = type_def.type_ref {
            previous_nodes.iter().find_map(|prev_node| {
              if prev_node.name == type_def.type_name {
                prev_node
                  .type_alias_def
                  .as_ref()
                  .map(|ts_alias| ts_alias.ts_type.clone())
              } else {
                None
              }
            })
          } else {
            Some(type_def)
          }
        });

        for prop in &pat.props {
          let (name, reassign_name, maybe_range) = match prop {
            deno_ast::swc::ast::ObjectPatProp::KeyValue(kv) => (
              crate::params::prop_name_to_string(None, &kv.key),
              match &*kv.value {
                deno_ast::swc::ast::Pat::Ident(ident) => {
                  Some(ident.sym.to_string())
                }
                _ => None, // TODO: properly implement
              },
              None,
            ),
            deno_ast::swc::ast::ObjectPatProp::Assign(assign) => {
              (assign.key.sym.to_string(), None, Some(assign.range()))
            }
            deno_ast::swc::ast::ObjectPatProp::Rest(_) => {
              ("".to_string(), None, None)
            } // TODO: properly implement
          };

          let ts_type = obj_type.as_ref().and_then(|ts_type| {
            ts_type.type_literal.as_ref().and_then(|type_literal| {
              type_literal.properties.iter().find_map(|property| {
                if property.name == name {
                  property.ts_type.clone()
                } else {
                  None
                }
              })
            })
          });

          let variable_def = VariableDef {
            ts_type,
            kind: var_decl.kind,
          };
          items.push((
            reassign_name.unwrap_or(name),
            variable_def,
            maybe_range,
          ));
        }
      }
      _ => (),
    }
  }

  items
}