feat(*): add params information to func proptypes where possible by Heymdall · Pull Request #79 · alfa-laboratory/library-utils

Heymdall · 2018-06-14T12:40:40Z

Добавил возможность генерировать более подробные типы для проптайпов-функций.
Получая на вход:

class Swipable extends React.Component {
  static propTypes = {
    /**
     * Функция запускаемая по свайпу.
     * @param {string} direction
     */
    onSwipe: Type.func
  };
}

будет генерироваться такое:

export interface SwipeableProps {
    readonly onSwipe: (direction?: any /*string*/) => any /*void*/;
}

Типы проставляются как any, так как полностью верить jsdoc-ам все же нельзя

stepancar · 2018-06-14T12:47:46Z

@Heymdall если jsdoc не верить - то кому верить? Давай так:
если смогли определить примитивный тип - то его и ставим?

stepancar · 2018-06-14T12:51:36Z

typings/stringify-component-definition.js

+        }
+
+        const paramsTypes = parsedDoc.params
+            .map(p => `${p.name}?: any /*${p.type ? p.type.name : 'any'}*/`);


Я бы тут вызывал stringifyType

stepancar · 2018-06-14T12:52:36Z

typings/stringify-component-definition.js


+function stringifyFunc(type, componentName, propName, description) {
+    try {
+        if (!description) {


можно вынести вверх за try

stepancar · 2018-06-14T12:55:39Z

typings/stringify-component-definition.js


        ${stringifyDescription(info.description, info.docblock)}
-        export default class ${info.displayName} extends Component<${propsInterfaceName}, any> {
+        export default class ${info.displayName} extends Component<${propsInterfaceName}> {


@Kokatsuna видимо придется обновить реакт дефинишены

Heymdall · 2018-06-14T16:18:53Z

@stepancar согласен. Поменял немного все, теперь типы делаются из jsdoc-а так же, как и во всех остальных кейсах.

stepancar · 2018-06-15T22:09:27Z

typings/__tests__/__snapshots__/index.tests.js.snap

+
+
+export interface AProps {
+    readonly optionalArray?: ReadonlyArray<any>;


@Heymdall
Если все поля readonly и поднята версия typescript - то не грех и generic утилитой Readonly воспользоваться чтоб читаемым было

Или даже может стоить рискнуть и написать что-нибудь типа
type DeepReadonly = Readonly<{ [P in keyof T]: T[P] extends Array ? ReadonlyArray<DeepReadonly<T[P][0]>> : DeepReadonly<T[P]> }>;
Правда я думаю, что это еще не совсем корректно работает

Было бы ништяк еслиб это работало
type DeepReadonly = T extends Array ? ReadonlyArray<DeepReadonly<T[0]>> : Readonly<{ [P in keyof T]: DeepReadonly<T[P]> }>

https://www.typescriptlang.org/play/index.html#src=export%20type%20primitive%20%3D%20string%20%7C%20number%20%7C%20boolean%20%7C%20undefined%20%7C%20null%0D%0Aexport%20type%20DeepReadonly%3CT%3E%20%3D%0D%0A%20%20T%20extends%20primitive%20%3F%20T%20%3A%0D%0A%20%20T%20extends%20Array%3Cinfer%20U%3E%20%3F%20DeepReadonlyArray%3CU%3E%20%3A%0D%0A%20%20DeepReadonlyObject%3CT%3E%0D%0A%0D%0Aexport%20interface%20DeepReadonlyArray%3CT%3E%20extends%20ReadonlyArray%3CDeepReadonly%3CT%3E%3E%20%7B%7D%0D%0A%0D%0Aexport%20type%20DeepReadonlyObject%3CT%3E%20%3D%20%7B%0D%0A%20%20readonly%20%5BP%20in%20keyof%20T%5D%3A%20DeepReadonly%3CT%5BP%5D%3E%0D%0A%7D%0D%0Atype%20test%20%3D%20%7B%0D%0A%20%20%20%20a%3A%20number%3B%0D%0A%20%20%20%20b%3A%20Array%3C%7B%20c%3A%20number%3B%20d%3A%20Array%3C%7B%20e%20%7D%3E%7D%3E%0D%0A%7D%0D%0Atype%20o%20%3D%20DeepReadonlyObject%3Ctest%3E%3B%0D%0Avar%20t%3A%20o%3B%0D%0At.a%20%3D%20null%3B%0D%0At.b%20%3D%20null%3B%0D%0At.b%5B0%5D.c%20%3D%20null%3B%0D%0At.b%5B0%5D.d%5B0%5D.e%20%3D%20null%3B

@Heymdall Вот этой штукой попробуй обернуть пропс интерфейс.
Вроде работает. Нашел тут
microsoft/TypeScript#13923

@Heymdall, я тут подумал, что сам интерфейс компонента лучше не делать readonly. Потому что ты можешь ведь динамически набивать проемы, перед тем как передать их компоненту ( не всегда ты можешь хорошо стипизировать литерал). Поэтому важно чтобы только this.props было deepreadonly.

Фишка в том, что там, где ожидается ридонли можно кинуть обычный, а наоборот - нет.
Ридонли же по сути сабсет обычных типов.
Начал приделывать это изначально именно из-за того что пришлось кастовать ридонли типы из редакс стейта до обычных, когда кидал их в наши компоненты.
Поэтому и захотелось сделать интерфейс компонента ридонли

А про DeepReadonly согласен, обновил

stepancar · 2018-06-19T07:25:19Z

typings/stringify-component-definition.js

 }

+const DEPP_READONLY_TYPES = `
+type Primitive = string | number | boolean | undefined | null;


Мне кажется что это можно куда-то засунуть и импортить

Ну оно как бы можно, но сильно усложняет весь этот процесс. Либо выносить это в отдельную либу, но тогда непонятно как это как зависимость делать. Мы же не привязываемся к конкретной библиотеке тут. Этот код вообще даже не знает куда все это будет записано, надо либо мучаться с относительными импортами тут, либо заставлять пользователей библиотеки ставить как зависимость что-то, что экспортами этот тип. А вот профита от этого никакого нету

@Heymdall согласен. Может воткнут этот хэлпер в ts.core.

feat(*): add params information to func proptypes where possible

c9d0a19

ziimir approved these changes Jun 14, 2018

View reviewed changes

stepancar reviewed Jun 14, 2018

View reviewed changes

feat(typings): create correct typings from jsdoc

6136e90

Heymdall added 5 commits June 15, 2018 13:34

fix(typings): do not override existing d.ts

da0fe47

feat(typings): accept all HTML and React types as valid ts types

e939da8

feat(*): add tests, move props jsdoc parser to react-docgen handler

eb2a629

fix(typings): remove unused params

eaa70ec

chore(travis): add test command

8fcc5a8

stepancar reviewed Jun 15, 2018

View reviewed changes

feat(typings): use DeepReadonly generic

17c6f8b

stepancar reviewed Jun 19, 2018

View reviewed changes

stepancar approved these changes Jun 19, 2018

View reviewed changes

Heymdall merged commit f1e2aae into master Jun 19, 2018



		export interface AProps {
		readonly optionalArray?: ReadonlyArray<any>;

Conversation

Heymdall commented Jun 14, 2018

Uh oh!

stepancar commented Jun 14, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Heymdall commented Jun 14, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants