https://github.com/teppeis/closure-ts

Generates TypeScript declarations(d.ts) from Closure Library JSDoc annotations
https://github.com/teppeis/closure-ts

Last synced: 3 months ago
JSON representation

Generates TypeScript declarations(d.ts) from Closure Library JSDoc annotations

• Host: GitHub
• URL: https://github.com/teppeis/closure-ts
• Owner: teppeis
• Created: 2014-04-14T04:05:09.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-06-22T05:26:22.000Z (over 2 years ago)
• Last Synced: 2023-04-09T21:59:19.086Z (almost 2 years ago)
• Language: TypeScript
• Homepage:
• Size: 659 KB
• Stars: 65
• Watchers: 3
• Forks: 5
• Open Issues: 15
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# closure-ts

[![npm Version][npm-image]][npm-url]

![Node.js Version Support][node-version]

[![Build Status](https://travis-ci.org/teppeis/closure-ts.svg?branch=master)](https://travis-ci.org/teppeis/closure-ts)

[![Dependency Status][deps-image]][deps-url]

![License][license]

> Generates TypeScript declaration files (.d.ts) from [Closure Library JSDoc annotations](https://developers.google.com/closure/compiler/docs/js-for-compiler).

The result is [closure-library.d.ts](https://github.com/teppeis/closure-library.d.ts 'teppeis/closure-library.d.ts').

## Example

From this JavaScript code with annotations,

```javascript

/**

 * Truncates a string to a certain length.

 * @param {string} str

 * @param {number} chars

 * @param {boolean=} opt_protectEscapedCharacters

 * @return {string}

 */

goog.string.truncate = function(str, chars, opt_protectEscapedCharacters) {

  // ...

};

```

closure-ts generates this declaration file (.d.ts).

```javascript

declare module goog.string {

    /**

     * Truncates a string to a certain length.

     * @param {string} str

     * @param {number} chars

     * @param {boolean=} opt_protectEscapedCharacters

     * @return {string}

     */

    function truncate(str: string, chars: number, opt_protectEscapedCharacters?: boolean): string;

}

```

## Usage

```bash

$ closurets some-jsdoced-code.js

$ ls

some-jsdoced-code.d.ts

some-jsdoced-code.js

```

## Project status

Just PoC

### Implemented

- Variable with `@type`

- Function with `@param` and `@return`

- Namespace to TypeScript `module`

- Classes (`@constructor` and `@extends`)

- Enum with `@enum` to TypeScrip type alias and variables

- Convert `*` and `?` to `any`

- Generic type like `Array`

- Generic classes and function with `@template`

- Union type

- Record type

- Rest parameters in `@param` and FunctionType

- Optional parameters

- Exclude `@private` definitions

- Convert `@typedef` to `type`

- Convert `@record` to `interface`

- Convert `Object` to `{[index: string]: Foo}`

- Ignore features TypeScript doesn't have

  - `@this`, `this:` and `new:` of function type

  - Nullable, Non-Nullable

### TODO

- `@lends`

- Dependencies of Closure Library files

- One stop build system with Grunt or Gulp

[npm-image]: https://img.shields.io/npm/v/closure-ts.svg

[npm-url]: https://npmjs.org/package/closure-ts

[npm-downloads-image]: https://img.shields.io/npm/dm/closure-ts.svg

[deps-image]: https://img.shields.io/david/teppeis/closure-ts.svg

[deps-url]: https://david-dm.org/teppeis/closure-ts

[node-version]: https://img.shields.io/badge/Node.js%20support-v8,v10,v11-brightgreen.svg

[license]: https://img.shields.io/npm/l/closure-ts.svg