Git Product home page Git Product logo

typus's Introduction

Typus

Typus === Latin('type')

Introduction

Typus is a complete TypeScript type parser.

Typus accepts the input from source code(.ts), declarations(.d.ts) and TsDoc, and outputing a well formatted objects aka Document.

Goal

Typus should be a fundamental tooling under TypeScript anaylize based tools.

RoadMap

  • list most use cases as possible
  • fully tests for all the use cases listed
  • ...

Inspirations

I'm working on a document product which need API parsing for React Component and other TypeScript declarations.

react-docgen-typescript can not handle normal TypeScript functions well.

So I made my own.

Notes

Compiling Ts using https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API#using-the-type-checker Ts Notes: https://github.com/microsoft/TypeScript-Compiler-Notes

typus's People

Contributors

citrus327 avatar noahstepheno avatar renovate[bot] avatar

Stargazers

 avatar  avatar  avatar

typus's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/codeql-analysis.yml
  • actions/checkout v4@3df4ab11eba7bda6032a0b82a6bb43b11571feac
  • github/codeql-action v2
  • github/codeql-action v2
  • github/codeql-action v2
.github/workflows/dependency-review.yml
  • actions/checkout v4@3df4ab11eba7bda6032a0b82a6bb43b11571feac
  • actions/dependency-review-action v3
npm
package.json
  • @egoist/prettier-config 1.0.0
  • prettier 3.0.3
  • tsup 7.2.0
  • typescript 5.2.2
  • vitest 0.34.5

  • Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.