artdecocode / typal Goto Github PK

View Code? Open in Web Editor NEW

4.0 3.0 0.0 2.44 MB

Keeps JSDoc types in XML files and converts them to JavaScript, Markdown and Closure Externs.

Home Page: https://typedef.page

License: GNU Affero General Public License v3.0

JavaScript 96.14% HTML 1.03% CSS 2.84%

google-closure-compiler closure-compiler externs jsdoc types markdown documentation gcc

typal's People

Stargazers

Watchers

typal's Issues

Write props inside args

Allow to write types inside functions' årguments

When parsed as a function, write types using @param in externs

Type any in * was not found.

Type Object was not found.

Default value of optional args

filter out primitives from warnings

Type number not found
Type string not found
Type Array<string> not found
Type string not found
Type string? not found
Type Array<string> not found
Type Array<string> not found
Detected type marker: types/compile.xml
Detected type marker: types/index.xml
Detected type marker: types/options.xml
Type Array<string> not found
Type (string):string not found
Type string not found
Type Array<string> not found
Type boolean not found
Type Array<_staticAnalysis.Detection> not found
Detected type marker: types/index.xml
Type Array<string> not found
Type Array<string> not found
Type Array<!_staticAnalysis.Detection> not found
Type Array<string> not found

embed types

embed by directive in XML rather than having to manually type what to commit

Extract from TypeScript

examples indent typedef

fix the order when extending

the root class should come before super

the text moves

after embedding the types the text moves so that warnings will have incorrect line numbers

if constructor fn is not defined, the constructor method will have void return

Reconcile typedefs with type/closure and closure mode

when printing to typedefs files for use in vs code, we can print the type attribute, however the closure mode's parameters such as full namespace usage should be kept.

prevent escapes in types' descriptions in code blocks

Create separate `import` class

Port bin and extract / generate APIs from Documentary

parse and link types inside of type attribute of a type

function(new: _contextTesting.Context) _contextTesting.ContextConstructor: The constructor class of a context.

Cannot extract

/**

@typedef {Object} users.address.getInfo
@prop {number} id ID of the address.
@typedef Address
@prop {number} AddressID A unique integer value that represents the address profile.
@prop {number} AddressName The name of the address profile.
@prop {boolean} IsDefault Whether it is a default address.
*/

description of the method after args

Use typeof for aliases

print new line for jsdoc

if the property description has a new line, include it properly in jsdoc

write externs as classes

Types in functions.

Parse types inside of functions.

multiple typal markers on windows

self-closing args

linking for extends between pages

Implement linking for extends between pages

wrap return with pipe of method

<method name="ÀLaModeReplacer" return="(string|!Promise<string>)">

maintain links database

Provide API to get links to types.

write parser for jsdoc

Change from a RegExp to a parser
2 problems ATM:

Can't check the record type in @param
```
/** @param {{ record }} param
```

Matching the param name which starts the same as one of the previous params

/**
 * @param {(Type | _ns.MissingType | _ns.Type)} union
 * @param {Type | MissingType} unionWithoutParenthesis

Could not parse !Function

expand all classes when using &

Detect imported types to disable warnings

introduce the constructor property

For constructors, types and interfaces, there needs to be an extra field called constructor to declare the type of the constructor method.

empty prop in typedef doesn't render to proper table

<prop string name="gravatar_id"></prop>

allow comments in types

escape @ when printing types to js

Implement inheritance

<type name="Message" desc="A TypeScript Server message">
    <prop number name="seq">
      Sequence number of the message
    </prop>
    <prop name="type" type="'request'|'response'|'event'">
      One of "request", "response", or "event"
    </prop>
  </type>
<type name="Event" desc="Server-initiated event message" extends="Message">
    <prop name="type" type="'event'" />
    <prop string name="event">
      Name of event
    </prop>
    <prop opt name="body">
      Event-specific information
    </prop>
  </type>

automatically create constructor jsdoc in template

const { _Cookies, connect, express, _Keygrip } = require('./cookies')

/**
 * The interface for Cookies: signed and unsigned cookies based on Keygrip.
 * @type {new (req: !http.IncomingMessage, res: !http.ServerResponse, opts: !_goa.CookiesOptions) => Cookies}
 */
const $Cookies = _Cookies

/**
 * Signing and verifying data (such as cookies or URLs) through a rotating credential system.
 * @type {new (keys: !Array<string>, algorithm?: string, encoding?: string) => Keygrip}
 */
const $Keygrip = _Keygrip

document aliases

async method output in typedef

no promise is printed right now

<method async name="askSingle" return="string">
    <arg type="(string|!_reloquent.Question)" name="question">
      The question to present to the user.
    </arg>
    <arg type="number" name="timeout" opt>
      How long to wait before rejecting the promise. Waits forever by default.
    </arg>
    Ask user a question via the CLI. Returns the answer to the question. 
    If a timeout is passed, the promise will expire after the specified 
    number of milliseconds if the answer was not given.
  </method>

static methods in props

ignore props

for example, we want to override a property with NO PROPERTY, like here we want to ignore session

/* typal node_modules/@idio/github/types/index.xml namespace ignore:_goa.Middleware,_idio.Context */
/**
 * @typedef {_idio.GithubOAuthConfig} GithubOAuthConfig `＠record` Options for the program.
 * @typedef {Object} _idio.GithubOAuthConfig `＠record` Options for the program.
 * @prop {string} client_id The app's client id.
 * @prop {string} client_secret The app's client secret.
 * @prop {string} [path="/auth/github"] The server path to start the login flaw at and use for redirect (`${path}/redirect`). Default `/auth/github`.
 * @prop {string} [scope] The scope to ask permissions for. No scope by default.
 * @prop {!_goa.Middleware} [session] The configured session middleware in case the `session` property is not globally available on the context.
 * @prop {(ctx: _idio.Context, token: string, scope: string, user: !_idio.GithubUser, next: function()) => !Promise} [finish="setSession; redirect;"] The function to complete the authentication that receives the token and the data about the user, such as name and id. The default function redirects to `/`. Default `setSession; redirect;`.
 * @prop {(ctx: !_idio.Context, error: string, description: string, next: function()) => !Promise} [error="throw;"] The function to be called in case of error. If not specified, the middleware will throw an internal server error. Default `throw;`.
 */

artdecocode / typal Goto Github PK

typal's People

Stargazers

Watchers

typal's Issues

Recommend Projects

Recommend Topics

Recommend Org