feat(storybook): upgrade story book to support mdx files #210

I checked an the issue in the PR checks is specific to this PR and connected to some storybook package upgrade, not a general issue.
@oyo is checking it out further

oyo · 2024-06-18T08:51:25Z

I checked an the issue in the PR checks is specific to this PR and connected to some storybook package upgrade, not a general issue. @oyo is checking it out further

After some investigation Storybook from v8.1.0 onwards requires prettier to be added as a peer dependency. So I moved it from devDependencies to dependencies and the prettier check is now running.

evegufy · 2024-06-19T07:35:56Z

src/components/basic/Button/Button.mdx

+<br />
+<br />
+
+## NOTICE


@manojava-gk coming back to our discussion from yesterday, as you were asking me if an md file necessarily needs this notice footer (with this example https://github.com/catenax-ng/tx-portal-assets/blob/main/docs/user/Style-Guide/button%20load%20more.md), I was answering with yes because markdown files are considered documentation.
I realised after our discussion that you're moving the contents into mdx files, which can be considered source code, so you should change to file header like for any other source file and remove the notice footer.

evegufy · 2024-06-19T07:39:58Z

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog

+## 3.0.23
+
+- Support mdx file


I don't think this is an accurate description of what's happening, something like "Integrate style-guide documentation into shared components and enable MDX support" would be more appropriate

agree and where do we have the storybook version upgrade?

please also raise the minor version to 3.1.0, as this merits a minor change and not just a patch

…imges

evegufy · 2024-06-24T10:20:20Z

src/components/basic/SearchInput/SearchInput.mdx

@@ -0,0 +1,81 @@
+{/**\*\*\*\***\*\***\*\*\*\***\*\*\*\***\*\*\*\***\*\***\*\*\*\***\***\*\*\*\***\*\***\*\*\*\***\*\*\*\***\*\*\*\***\*\***\*\*\*\***


this is a kinda strange way to set comments are you sure about that? this comment applies to all mdx files

this is auto generated after running yarn pretty

evegufy

Please also fix failing linter https://github.com/eclipse-tractusx/portal-shared-components/actions/runs/9611276695/job/26509514085?pr=210

evegufy · 2024-06-24T10:36:39Z

IP Issues created:
A review is required for npm/npmjs/@storybook/types/8.1.10.
A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15486 .
A review is required for npm/npmjs/@vitest/utils/1.6.0.
A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15487 .
A review is required for npm/npmjs/@storybook/addon-interactions/8.1.10.
A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15483 .
A review is required for npm/npmjs/@storybook/manager/8.1.10.
A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15484 .
A review is required for npm/npmjs/@storybook/addon-onboarding/8.1.10.
A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15485 .
A review is required for npm/npmjs/-/chromatic/11.5.4.
A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15478 .
A review is required for npm/npmjs/@chromatic-com/storybook/1.5.0.
A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15479 .
A review is required for npm/npmjs/-/prettier/3.3.2.
A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15480 .
A review is required for npm/npmjs/@mui/x-data-grid/6.20.1.
A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15481 .
A review is required for npm/npmjs/-/eslint-plugin-es-x/7.7.0.
A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15482 .

…file

manojava-gk · 2024-06-25T10:21:22Z

Please also fix failing linter https://github.com/eclipse-tractusx/portal-shared-components/actions/runs/9611276695/job/26509514085?pr=210

There is no issue in the local, when I run yarn lint, but here it is failing

oyo · 2024-07-12T07:57:36Z

Please also fix failing linter https://github.com/eclipse-tractusx/portal-shared-components/actions/runs/9611276695/job/26509514085?pr=210

There is no issue in the local, when I run yarn lint, but here it is failing

For me it is also failing on local:

 portal-shared-components yarn lint
yarn run v1.22.22
$ eslint . --ext ts,tsx,js,jsx --report-unused-disable-directives --max-warnings 0
There was a problem loading formatter: /Users/q163684/work/eclipse-tractusx/portal-shared-components/node_modules/eslint/lib/cli-engine/formatters/stylish
Error: require() of ES Module /Users/q163684/work/eclipse-tractusx/portal-shared-components/node_modules/strip-ansi/index.js from /Users/q163684/work/eclipse-tractusx/portal-shared-components/node_modules/eslint/lib/cli-engine/formatters/stylish.js not supported.
Instead change the require of index.js in /Users/q163684/work/eclipse-tractusx/portal-shared-components/node_modules/eslint/lib/cli-engine/formatters/stylish.js to a dynamic import() which is available in all CommonJS modules.
error Command failed with exit code 2.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

manojava-gk · 2024-07-16T06:24:30Z

Please also fix failing linter https://github.com/eclipse-tractusx/portal-shared-components/actions/runs/9611276695/job/26509514085?pr=210

There is no issue in the local, when I run yarn lint, but here it is failing

For me it is also failing on local:

 portal-shared-components yarn lint
yarn run v1.22.22
$ eslint . --ext ts,tsx,js,jsx --report-unused-disable-directives --max-warnings 0
There was a problem loading formatter: /Users/q163684/work/eclipse-tractusx/portal-shared-components/node_modules/eslint/lib/cli-engine/formatters/stylish
Error: require() of ES Module /Users/q163684/work/eclipse-tractusx/portal-shared-components/node_modules/strip-ansi/index.js from /Users/q163684/work/eclipse-tractusx/portal-shared-components/node_modules/eslint/lib/cli-engine/formatters/stylish.js not supported.
Instead change the require of index.js in /Users/q163684/work/eclipse-tractusx/portal-shared-components/node_modules/eslint/lib/cli-engine/formatters/stylish.js to a dynamic import() which is available in all CommonJS modules.
error Command failed with exit code 2.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

@oyo I tried from my end. I do not see any error in local

manojava-gk · 2024-07-16T10:59:56Z

@evegufy Any update on Dependency file?

evegufy · 2024-07-16T11:23:35Z

IP Issues created: A review is required for npm/npmjs/@storybook/types/8.1.10. A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15486 . A review is required for npm/npmjs/@vitest/utils/1.6.0. A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15487 . A review is required for npm/npmjs/@storybook/addon-interactions/8.1.10. A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15483 . A review is required for npm/npmjs/@storybook/manager/8.1.10. A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15484 . A review is required for npm/npmjs/@storybook/addon-onboarding/8.1.10. A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15485 . A review is required for npm/npmjs/-/chromatic/11.5.4. A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15478 . A review is required for npm/npmjs/@chromatic-com/storybook/1.5.0. A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15479 . A review is required for npm/npmjs/-/prettier/3.3.2. A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15480 . A review is required for npm/npmjs/@mui/x-data-grid/6.20.1. A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15481 . A review is required for npm/npmjs/-/eslint-plugin-es-x/7.7.0. A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15482 .

@manojava-gk I created those I issues and they appear to be closed, did you change the versions? If so, change them back.

manojava-gk · 2024-07-17T05:46:19Z

https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15486

@evegufy I have not added any new packages here. I cleaned up my local and generated new yarn.lock file by running yarn install. pr checks used to get failed with the older version but now it is fixed

@oyo you want to add anything here?

evegufy · 2024-07-17T06:30:28Z

https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15486

@evegufy I have not added any new packages here. I cleaned up my local and generated new yarn.lock file by running yarn install. pr checks used to get failed with the older version but now it is fixed

@oyo you want to add anything here?

You did change the versions of the packages very evidently from 7323404 - which is when I created the IP issues - to f9891d8, what made the created IP issues useless for this pull request.

I had to create now new IP issues:
A review is required for npm/npmjs/@chromatic-com/storybook/1.6.1.
A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15710
A review is required for npm/npmjs/@mui/icons-material/5.16.2.
A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15711
A review is required for npm/npmjs/-/eslint-plugin-es-x/7.8.0.
A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15712
A review is required for npm/npmjs/-/esquery/1.6.0.
A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15713
A review is required for npm/npmjs/@mui/material/5.16.2.
A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15714
A review is required for npm/npmjs/@mui/system/5.16.2.
A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15715
A review is required for npm/npmjs/@mui/utils/5.16.2.
A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15716
A review is required for npm/npmjs/@mui/private-theming/5.16.2.
A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15717
A review is required for npm/npmjs/@mui/styled-engine/5.16.2.
A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15718
A review is required for npm/npmjs/@testing-library/dom/10.1.0.
A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15719
A review is required for npm/npmjs/@mui/x-data-grid/6.20.3.
A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15720
A review is required for npm/npmjs/@storybook/core/8.2.4.
A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15721

I assume some of them will ran again in a manual review, so expect a wait time from at leat two weeks.

evegufy

Change title of pull request, it doesn't summarise the contents well

manojava-gk · 2024-07-17T07:28:37Z

https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15486

@evegufy I have not added any new packages here. I cleaned up my local and generated new yarn.lock file by running yarn install. pr checks used to get failed with the older version but now it is fixed
@oyo you want to add anything here?

You did change the versions of the packages very evidently from 7323404 - which is when I created the IP issues - to f9891d8, what made the created IP issues useless for this pull request.

I had to create now new IP issues: A review is required for npm/npmjs/@chromatic-com/storybook/1.6.1. A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15710 A review is required for npm/npmjs/@mui/icons-material/5.16.2. A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15711 A review is required for npm/npmjs/-/eslint-plugin-es-x/7.8.0. A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15712 A review is required for npm/npmjs/-/esquery/1.6.0. A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15713 A review is required for npm/npmjs/@mui/material/5.16.2. A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15714 A review is required for npm/npmjs/@mui/system/5.16.2. A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15715 A review is required for npm/npmjs/@mui/utils/5.16.2. A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15716 A review is required for npm/npmjs/@mui/private-theming/5.16.2. A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15717 A review is required for npm/npmjs/@mui/styled-engine/5.16.2. A review request was created https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15718 A review is required for npm/npmjs/@testing-library/dom/10.1.0. A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15719 A review is required for npm/npmjs/@mui/x-data-grid/6.20.3. A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15720 A review is required for npm/npmjs/@storybook/core/8.2.4. A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15721

I assume some of them will ran again in a manual review, so expect a wait time from at leat two weeks.

we do not manually change the yarn.lock file. It is auto generated based on package.json and currently available version from the internet. It got changed as the new version is available in the internet.

… files

evegufy · 2024-07-30T05:33:31Z

IP issues currently still under review:
npm/npmjs/@mui/x-data-grid/6.20.3
https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15720
npm/npmjs/@storybook/core/8.2.4
https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/15721

sonarcloud · 2024-08-05T12:47:11Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

evegufy · 2024-08-05T13:35:21Z

Hi @manojava-gk as the catenax-ng GitHub org was recreated, I was able to reopen the PR... please reopen the PR as soon as possible from your own fork as the catenax-ng GitHub org will be deleted again.
could it be possible to contribute this change in multiple pull requests? this one got quite huge
BTW, IP issues are all approved now.

manojava-gk added 5 commits June 13, 2024 16:39

feat(storybook): support mdx files in story book

3f7d3d1

feat(storybook): add component specific mdx files

3fda3fc

Merge branch 'main' into feat/issues-115-mdx

e55df48

fix(chor): update package version

0d9c7a1

fix(chor): fix pr checks

f13ee2f

manojava-gk added 3 commits June 18, 2024 11:27

Merge branch 'main' into feat/issues-115-mdx

45414f6

fix(chor): remove lint:staged

65f0577

fix(chor): add npx for prettier command

2732d96

fix(prettier): add prettier as peer dependency

3e5afcd

evegufy requested changes Jun 19, 2024

View reviewed changes

manojava-gk added 8 commits June 19, 2024 23:47

Merge branch 'main' into feat/issues-115-mdx

98a9b89

fix(mdx): version upgrade

cefbc27

fix(mdx): delete unwanted files. and use react components instead of …

b64a10b

…imges

fix(mdx): remove image tag and use component directly

170c46f

fix(chor): fix pr checks issue

cf58e43

fix(mdx): use react components and remove image tag

7f452c6

Merge branch 'main' into feat/issues-115-mdx

d2fbd6b

fix(chor): update yran.lock

7323404

evegufy requested changes Jun 24, 2024

View reviewed changes

fix(mdx): remove .md files and include the details in respective mdx …

e22bc38

…file

manojava-gk added 2 commits June 25, 2024 15:58

fix(mdx): update yarn.lock file

f9891d8

fix(mdx): update vaersion

bc69e97

manojava-gk requested a review from oyo June 28, 2024 09:14

manojava-gk marked this pull request as ready for review June 28, 2024 11:30

manojava-gk and others added 2 commits July 8, 2024 14:09

feat(mdx): add new table mdx file

628a309

fix(prettier): add mdx to pre-commit prettier

d24ca4b

Merge branch 'main' into feat/issues-115-mdx

668c134

manojava-gk requested a review from evegufy July 16, 2024 11:15

evegufy requested changes Jul 17, 2024

View reviewed changes

manojava-gk changed the title ~~feat(storybook): support mdx~~ feat(storybook): upgrade story book to support mdx files Jul 17, 2024

evegufy self-requested a review July 17, 2024 07:12

fix(mdx): remove prettify on mdx files. format template header in mdx…

cf80f1d

… files

catenax-ng closed this by deleting the head repository Jul 31, 2024

evegufy reopened this Aug 5, 2024

manojava-gk mentioned this pull request Aug 12, 2024

feat(storybook): upgrade story book to support mdx files #264

Merged

8 tasks

oyo merged commit cf80f1d into eclipse-tractusx:main Aug 12, 2024
8 of 9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(storybook): upgrade story book to support mdx files #210

feat(storybook): upgrade story book to support mdx files #210

manojava-gk commented Jun 13, 2024 •

edited

Loading

sonarcloud bot commented Jun 13, 2024

manojava-gk commented Jun 18, 2024

evegufy commented Jun 18, 2024

oyo commented Jun 18, 2024

evegufy Jun 19, 2024 •

edited

Loading

evegufy Jun 19, 2024 •

edited

Loading

jjeroch Jun 19, 2024

evegufy Jun 24, 2024

evegufy Jun 24, 2024

manojava-gk Jun 25, 2024

evegufy left a comment

evegufy commented Jun 24, 2024

manojava-gk commented Jun 25, 2024 •

edited

Loading

oyo commented Jul 12, 2024

manojava-gk commented Jul 16, 2024

manojava-gk commented Jul 16, 2024

evegufy commented Jul 16, 2024

manojava-gk commented Jul 17, 2024 •

edited

Loading

evegufy commented Jul 17, 2024 •

edited

Loading

evegufy left a comment

manojava-gk commented Jul 17, 2024

evegufy commented Jul 30, 2024

sonarcloud bot commented Aug 5, 2024

evegufy commented Aug 5, 2024

		@@ -0,0 +1,81 @@
		{/*\\\\**\\**\\\\**\\\\**\\\\**\\**\\\\*\\\\\**\\**\\\\**\\\\**\\\\**\\**\\\\***

feat(storybook): upgrade story book to support mdx files #210

feat(storybook): upgrade story book to support mdx files #210

Conversation

manojava-gk commented Jun 13, 2024 • edited Loading

Description

Why

Issue

Checklist

sonarcloud bot commented Jun 13, 2024

Quality Gate passed

manojava-gk commented Jun 18, 2024

evegufy commented Jun 18, 2024

oyo commented Jun 18, 2024

evegufy Jun 19, 2024 • edited Loading

Choose a reason for hiding this comment

evegufy Jun 19, 2024 • edited Loading

Choose a reason for hiding this comment

jjeroch Jun 19, 2024

Choose a reason for hiding this comment

evegufy Jun 24, 2024

Choose a reason for hiding this comment

evegufy Jun 24, 2024

Choose a reason for hiding this comment

manojava-gk Jun 25, 2024

Choose a reason for hiding this comment

evegufy left a comment

Choose a reason for hiding this comment

evegufy commented Jun 24, 2024

manojava-gk commented Jun 25, 2024 • edited Loading

oyo commented Jul 12, 2024

manojava-gk commented Jul 16, 2024

manojava-gk commented Jul 16, 2024

evegufy commented Jul 16, 2024

manojava-gk commented Jul 17, 2024 • edited Loading

evegufy commented Jul 17, 2024 • edited Loading

evegufy left a comment

Choose a reason for hiding this comment

manojava-gk commented Jul 17, 2024

evegufy commented Jul 30, 2024

sonarcloud bot commented Aug 5, 2024

Quality Gate passed

evegufy commented Aug 5, 2024

manojava-gk commented Jun 13, 2024 •

edited

Loading

evegufy Jun 19, 2024 •

edited

Loading

evegufy Jun 19, 2024 •

edited

Loading

manojava-gk commented Jun 25, 2024 •

edited

Loading

manojava-gk commented Jul 17, 2024 •

edited

Loading

evegufy commented Jul 17, 2024 •

edited

Loading