Git Product home page Git Product logo

getdocs2ts's Introduction

getdocs2ts

This is a utility that transforms code documented with getdocs-style doc comments into TypeScript definition files

Usage

There is no CLI, so you must write a script, e.g.:

import getdocs2ts from 'getdocs2ts';

getdocs2ts([
    {
        name: 'prosemirror-history',
        srcFiles: './prosemirror-history/src/*.js',
        outFile: './types/prosemirror-history/index.d.ts',
        header: 
`// Type definitions for prosemirror-history 0.21
// Project: https://github.com/ProseMirror/prosemirror-history
// Definitions by: Bradley Ayers <https://github.com/bradleyayers>
//                 David Hahn <https://github.com/davidka>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.1

`
    }
], {
    Transaction: { definedIn: 'prosemirror-state' },
    Plugin: { definedIn: 'prosemirror-state' },
    EditorState: { definedIn: 'prosemirror-state' },
})

Contributing

Build and run tests:

npm run build
npm run test

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.