Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BD-46] feat: defined types for Paragon exports #2177

Conversation

PKulkoRaccoonGang
Copy link
Contributor

@PKulkoRaccoonGang PKulkoRaccoonGang commented Apr 5, 2023

Description

  • Define types for Paragon exports

Issue: #1964

Merge Checklist

  • If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Netlify deploy preview, if applicable.
  • Does your change adhere to the documented style conventions?
  • Do any prop types have missing descriptions in the Props API tables in the documentation site (check deploy preview)?
  • Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?
  • Were your changes tested in the example app?
  • Is there adequate test coverage for your changes?
  • Consider whether this change needs to reviewed/QA'ed for accessibility (a11y). If so, please add wittjeff and adamstankiewicz as reviewers on this PR.

Post-merge Checklist

  • Verify your changes were released to NPM at the expected version.
  • If you'd like, share your contribution in #show-and-tell.
  • 🎉 🙌 Celebrate! Thanks for your contribution.

@openedx-webhooks openedx-webhooks added the blended PR is managed through 2U's blended developmnt program label Apr 5, 2023
@openedx-webhooks
Copy link

openedx-webhooks commented Apr 5, 2023

Thanks for the pull request, @PKulkoRaccoonGang!

When this pull request is ready, tag your edX technical lead.

@netlify
Copy link

netlify bot commented Apr 5, 2023

Deploy Preview for paragon-openedx failed.

Built without sensitive environment variables

Name Link
🔨 Latest commit 9797403
🔍 Latest deploy log https://app.netlify.com/sites/paragon-openedx/deploys/64df5134698e940008e3211b

@codecov
Copy link

codecov bot commented Apr 5, 2023

Codecov Report

Patch coverage: 75.00% and project coverage change: -0.01% ⚠️

Comparison is base (7e5b37d) 91.65% compared to head (9797403) 91.64%.
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2177      +/-   ##
==========================================
- Coverage   91.65%   91.64%   -0.01%     
==========================================
  Files         236      236              
  Lines        4195     4203       +8     
  Branches     1012     1013       +1     
==========================================
+ Hits         3845     3852       +7     
- Misses        346      347       +1     
  Partials        4        4              
Files Changed Coverage Δ
src/Breadcrumb/index.jsx 100.00% <ø> (ø)
src/Card/CardStatus.jsx 100.00% <ø> (ø)
src/ChipCarousel/index.tsx 84.84% <ø> (ø)
src/ActionRow/index.tsx 93.33% <75.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/define-types-for-Paragon-exports branch 13 times, most recently from bf4cc60 to 996bc0d Compare April 10, 2023 17:15
@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/define-types-for-Paragon-exports branch 4 times, most recently from c774131 to aae4443 Compare April 12, 2023 19:43
@viktorrusakov viktorrusakov linked an issue Apr 24, 2023 that may be closed by this pull request
src/DataTable/CardView.d.ts Outdated Show resolved Hide resolved
src/DataTable/index.d.ts Outdated Show resolved Hide resolved
src/DataTable/TableRow.d.ts Outdated Show resolved Hide resolved
src/Dropzone/index.d.ts Outdated Show resolved Hide resolved
src/Dropzone/index.d.ts Outdated Show resolved Hide resolved
src/hooks/useWindowSize.d.ts Outdated Show resolved Hide resolved
src/Icon/index.d.ts Outdated Show resolved Hide resolved
src/IconButtonToggle/index.d.ts Outdated Show resolved Hide resolved
src/Modal/ModalLayer.d.ts Outdated Show resolved Hide resolved
src/Overlay/index.d.ts Outdated Show resolved Hide resolved
@PKulkoRaccoonGang PKulkoRaccoonGang changed the title [BD-46] DRAFT: defined types for Paragon exports [BD-46] feat: defined types for Paragon exports May 2, 2023
@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/define-types-for-Paragon-exports branch from 48a0248 to 597bb37 Compare May 15, 2023 06:06
@@ -2,17 +2,25 @@ import React from 'react';
import PropTypes from 'prop-types';
import classNames from 'classnames';

export interface ActionRowProps {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[clarification] Can you expand on why the ActionRowProps interface is defined in both this index.tsx file and the index.d.ts file?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed .d.ts for ActionRow since it has .tsx

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@monteri [clarification] So, the introduction of the .d.ts files are only necessary if the component is not already written in .tsx? I imagine we would eventually intend to migrate our other components' .jsx files to .tsx files. If we do that, what would happen to the .d.ts files? Would they remain, or get moved into the migrated .tsx files?

I guess I'm just wondering about consistency around where we define types across components (i.e., always included in the .d.ts, always included in the .tsx, or similar).

@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/define-types-for-Paragon-exports branch from dfdf4d0 to 8efc2a8 Compare August 18, 2023 09:40
@monteri monteri force-pushed the Peter_Kulko/define-types-for-Paragon-exports branch from e0f50d2 to 15d08f6 Compare August 18, 2023 10:49
@openedx-webhooks
Copy link

@PKulkoRaccoonGang Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blended PR is managed through 2U's blended developmnt program raccoon-gang
Projects
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

Define types for Paragon exports
4 participants