feat: add some types to helpers.segment.ts #1

Arantiryo · 2023-01-19T11:49:01Z

No description provided.

Arantiryo · 2023-01-19T11:54:14Z

src/helpers/helpers.segment.ts

 * @private
 */
-export function _computeSegments(line, segmentOptions) {
+export function _computeSegments(line: LineElement, segmentOptions: any) {


Как типизировать SegmentOptions? @dangreen

наверное надо сначала перевести на ts helpers.config.js, так как там эта тема с контекстами

ну тогда пока просто SegmentStyle получается

Arantiryo · 2023-01-19T11:56:24Z

src/types/index.d.ts

  start: number;
  end: number;
  loop: boolean;
+  style?: AnyObject;


Segment.style - я добавил как AnyObject, но может есть вариант более конкретный? Вроде в readStyle как раз такой объект описывается, но я не уверен. @dangreen

function readStyle(options) { return { backgroundColor: options.backgroundColor, borderCapStyle: options.borderCapStyle, borderDash: options.borderDash, borderDashOffset: options.borderDashOffset, borderJoinStyle: options.borderJoinStyle, borderWidth: options.borderWidth, borderColor: options.borderColor }; }

там вот эти пропсы скорей всего

Arantiryo · 2023-01-19T11:59:39Z

src/helpers/helpers.segment.ts

 * @private
 */
-export function _boundSegments(line, bounds) {
+export function _boundSegments(line: LineElement, bounds: Bounds) {


Типы Point и PointElement, в LineElement используется первый, но из кода вроде получается, что должен быть второй. @dangreen

да, там PointElement, надо поправить

Arantiryo · 2023-01-19T12:01:27Z

И хотел спросить, как типизировать приватные поля, которые начинаются с "_", например line._loop.

Arantiryo · 2023-01-27T08:51:35Z

src/types/index.d.ts

+  _loop: boolean;
+  _fullLoop: boolean;
+  _datasetIndex: number;
+  _chart: AnyObject;


@dangreen какой здесь тип использовать для _chart, вот этот?

@Arantiryo Да

Arantiryo · 2023-01-31T08:44:23Z

src/helpers/helpers.canvas.ts

 * @private
 */
-export function _measureText(ctx, data, gc, longest, string) {
+export function _measureText(ctx: CanvasRenderingContext2D, data, gc, longest: number, string) {


@dangreen Дэн, не нашел в коде, что конкретно туда передается, можешь подсказать?

Arantiryo · 2023-01-31T08:45:28Z

src/helpers/helpers.canvas.ts

 */
-export function _longestText(ctx, font, arrayOfThings, cache) {
+// eslint-disable-next-line complexity
+export function _longestText<T>(ctx: CanvasRenderingContext2D, font, arrayOfThings: T[], cache) {


@dangreen Как лучше типизировать arrayOfThings? И с кэшем не совсем понятно, что делать.

Arantiryo · 2023-01-31T08:46:41Z

src/helpers/helpers.canvas.ts

 * @private
 */
-export function _steppedLineTo(ctx, previous, target, flip, mode) {
+export function _steppedLineTo(ctx: CanvasRenderingContext2D, previous: Point, target: Point, flip, mode) {


@dangreen flip не нашел типы для mode, подскажи, плиз

Arantiryo · 2023-01-31T08:48:04Z

src/helpers/helpers.canvas.ts

 }

-function drawBackdrop(ctx, opts) {
+function drawBackdrop(ctx: CanvasRenderingContext2D, opts: BackdropOptions) {


@dangreen вроде бы параметры типизированы корректно, но в строке ctx.fillStyle = opts.color; ошибка несоответствия типов.

Arantiryo · 2023-01-31T08:50:29Z

src/helpers/helpers.canvas.ts

 * @param {*} rect Bounding rect
 */
-export function addRoundedRectPath(ctx, rect) {
+export function addRoundedRectPath(ctx: CanvasRenderingContext2D, rect: RoundedRect) {


@dangreen Здесь вроде бы тоже с типами понятно, но ругается на тип radius, хотя должно быть все ок на первый взгляд

Property 'topLeft' does not exist on type 'CornerRadius'. Property 'topLeft' does not exist on type 'number'.ts(2339)

dangreen · 2023-01-31T09:35:58Z

@Arantiryo а зачем ты тут канвас переводишь на TS? тут же мы только segment делаем

плюс я уже сделал канвас chartjs#11100

Arantiryo · 2023-01-31T10:23:46Z

Справедливо, надо было сначала. с тобой посоветоваться, что дальше делать. Я начал helpers.config.js переписывать, но там все совсем запутано оказалось, поэтому решил канвас начать.

Тогда я откачу последний коммит. Здесь остался #1 (comment) неразрешенный только, но он завязан на helpers.config.js. Создать тогда ПР в основной репозиторий без последнего коммита? @dangreen

dangreen

сделай плиз откат канваса

dangreen · 2023-02-02T11:34:57Z

src/types/index.d.ts

+  _loop: boolean;
+  _fullLoop: boolean;
+  _datasetIndex: number;
+  _chart: Chart;
 }


они наверное private?

То есть их нужно убрать из типа? Просто тогда ТС при их использовании начинает ругаться, что такого свойства нет.

я имел в виду модифигатор private

но ладно, оставляй как есть

dangreen · 2023-02-02T11:36:52Z

src/types/index.d.ts

  start: number;
  end: number;
  loop: boolean;
+  style?: LineOptions['segment'];


вынеси это в интерфейс SegmentStyle, и его везде используй

Готово 👍

dangreen · 2023-02-02T11:43:08Z

src/helpers/helpers.segment.ts

 * @private
 */
-export function _computeSegments(line, segmentOptions) {
+export function _computeSegments(line: LineElement, segmentOptions: any) {


ну тогда пока просто SegmentStyle получается

This reverts commit 04bb3bd.

dangreen · 2023-02-06T10:26:08Z

src/helpers/helpers.segment.ts

 /**
 * @typedef { import('../elements/element.line.js').default } LineElement
 * @typedef { import('../elements/element.point.js').default } PointElement
 * @typedef {{start: number, end: number, loop: boolean, style?: any}} Segment
 */


надо тоже на ts переделать или убрать

dangreen · 2023-02-06T10:26:26Z

src/helpers/helpers.segment.ts

+interface Bounds {
+  property: string;
+  start: number;
+  end: number;
+}


перенеси в файл с типами, мб как то SegmentBounds назвать лучше

Готово

dangreen · 2023-02-06T11:10:30Z

src/types/index.d.ts

+  backgroundColor: Scriptable<Color|undefined, ScriptableLineSegmentContext>,
+  borderColor: Scriptable<Color|undefined, ScriptableLineSegmentContext>,
+  borderCapStyle: Scriptable<CanvasLineCap|undefined, ScriptableLineSegmentContext>;
+  borderDash: Scriptable<number[]|undefined, ScriptableLineSegmentContext>;
+  borderDashOffset: Scriptable<number|undefined, ScriptableLineSegmentContext>;
+  borderJoinStyle: Scriptable<CanvasLineJoin|undefined, ScriptableLineSegmentContext>;
+  borderWidth: Scriptable<number|undefined, ScriptableLineSegmentContext>;


Suggested change

backgroundColor: Scriptable<Color|undefined, ScriptableLineSegmentContext>,

borderColor: Scriptable<Color|undefined, ScriptableLineSegmentContext>,

borderCapStyle: Scriptable<CanvasLineCap|undefined, ScriptableLineSegmentContext>;

borderDash: Scriptable<number[]|undefined, ScriptableLineSegmentContext>;

borderDashOffset: Scriptable<number|undefined, ScriptableLineSegmentContext>;

borderJoinStyle: Scriptable<CanvasLineJoin|undefined, ScriptableLineSegmentContext>;

borderWidth: Scriptable<number|undefined, ScriptableLineSegmentContext>;

backgroundColor: Scriptable<Color | undefined, ScriptableLineSegmentContext>,

borderColor: Scriptable<Color | undefined, ScriptableLineSegmentContext>,

borderCapStyle: Scriptable<CanvasLineCap | undefined, ScriptableLineSegmentContext>;

borderDash: Scriptable<number[] | undefined, ScriptableLineSegmentContext>;

borderDashOffset: Scriptable<number | undefined, ScriptableLineSegmentContext>;

borderJoinStyle: Scriptable<CanvasLineJoin | undefined, ScriptableLineSegmentContext>;

borderWidth: Scriptable<number | undefined, ScriptableLineSegmentContext>;

Поправил

Arantiryo · 2023-02-06T12:21:53Z

@dangreen Дэн, еще есть ошибка 'readStyle' was used before it was defined. eslint[@typescript-eslint/no-use-before-define] для нескольких функций, нужно поправить ее?

dangreen · 2023-02-06T17:31:19Z

@Arantiryo для всего файла правило отключи

dangreen · 2023-02-06T21:24:17Z

src/helpers/helpers.segment.ts

 * @param {object} [bounds]
 * @param {string} bounds.property - the property of a `PointElement` we are bounding. `x`, `y` or `angle`.
 * @param {number} bounds.start - start value of the property
 * @param {number} bounds.end - end value of the property


из jsdoc надо типы убрать кстати

@dangreen убрал типы, оставил только описания

This reverts commit a6ea376.

dangreen · 2023-02-07T10:52:44Z

src/helpers/helpers.segment.ts

- * @param {object} segment
- * @param {number} segment.start - start index of the segment, referring the points array
- * @param {number} segment.end - end index of the segment, referring the points array
- * @param {boolean} segment.loop - indicates that the segment is a loop
- * @param {object} [segment.style] - segment style
- * @param {PointElement[]} points - the points that this segment refers to
- * @param {object} [bounds]
- * @param {string} bounds.property - the property of a `PointElement` we are bounding. `x`, `y` or `angle`.
- * @param {number} bounds.start - start value of the property
- * @param {number} bounds.end - end value of the property
- * @private


нужно было удалить только типы, описания аргументов нужно оставить

dangreen · 2023-02-07T11:12:03Z

src/helpers/helpers.segment.ts

- * @return {Segment[]}
+ * @param line
+ * @param segmentOptions
+ * @return Segment[]


тут и ниже видимо ошибся, просто удали строчки "@return Segment[]" раз там описания нет

и можешь делать пр

@dangreen Сделал, спасибо!

feat: add some types to helpers.segment.ts

eb23570

Arantiryo commented Jan 19, 2023

View reviewed changes

feat: add more types

011dbea

Arantiryo commented Jan 27, 2023

View reviewed changes

Arantiryo added 3 commits January 30, 2023 16:42

fix: _chart type

03f001d

feat: add getContext() type

5019c3f

feat: add types to helpers.canvas.ts

04bb3bd

Arantiryo commented Jan 31, 2023

View reviewed changes

dangreen suggested changes Feb 2, 2023

View reviewed changes

Arantiryo added 2 commits February 3, 2023 11:25

Revert "feat: add types to helpers.canvas.ts"

288a525

This reverts commit 04bb3bd.

refactor: move SegmentStyle into a separate interface

22a87c8

dangreen suggested changes Feb 6, 2023

View reviewed changes

refactor: move 'Bounds' to the types file, rename to 'SegmentBounds'

71e1bc1

dangreen reviewed Feb 6, 2023

View reviewed changes

Arantiryo added 2 commits February 7, 2023 11:49

refactor: remove jsdoc types

a6ea376

Revert "refactor: remove jsdoc types"

ff37d78

This reverts commit a6ea376.

dangreen reviewed Feb 7, 2023

View reviewed changes

refactor: remove jsdoc types but keep the descriptions

e220519

dangreen reviewed Feb 7, 2023

View reviewed changes

Arantiryo added 2 commits February 7, 2023 15:47

refactor: remove jsdoc return types for Segment

88f12c2

fix: lint errors

f515365

feat: add some types to helpers.segment.ts #1

Are you sure you want to change the base?

feat: add some types to helpers.segment.ts #1

Uh oh!

Conversation

Arantiryo commented Jan 19, 2023

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!

Arantiryo commented Jan 19, 2023

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!

dangreen commented Jan 31, 2023

Uh oh!

Arantiryo commented Jan 31, 2023

Uh oh!

dangreen left a comment

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!

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!

Arantiryo commented Feb 6, 2023

Uh oh!

dangreen commented Feb 6, 2023

Uh oh!

dangreen Feb 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dangreen Feb 6, 2023 •

edited

Loading