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.

Sign up for GitHub

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

Jump to bottom

feat(ApiTable): Add ability to specify function type #485

Merged
merged 7 commits into from
Mar 1, 2022
Merged

feat(ApiTable): Add ability to specify function type #485

merged 7 commits into from
Mar 1, 2022

Conversation

jpveooys
Copy link
Contributor

@jpveooys jpveooys commented Feb 28, 2022 •
edited
Loading

Related issue

Royal-Navy/design-system#3097

Overview

This:

  • adds the ability to override the 'Function' text in ApiTable
  • fixes various problems preventing Storybook from working
  • removes outdated addons and dependency on the legacy CSS Framework from Storybook
  • resolves security alerts from yarn audit
  • tidies up a couple of other small bits

Link to preview

https://timeline-v3-docs.netlify.app/timeline

Reason

Get everything working again and make Timeline docs more accurate.

Work carried out

  • Fix Storybook build
  • Remove dependency on CSS Framework from Storybook
  • Remove redundant Storybook add-ons
  • Fix end-to-end tests
  • Enhance ApiTable
  • Resolve yarn audit security warnings
  • Tidy up

Screenshot

Note the monospace font that gets used varies by OS (the Ubuntu one is a bit ugly):

Before

image

After

image

Developer notes

Can consider any other tweaks to improve the Timeline docs for the render props.

@jpveooys jpveooys force-pushed the feature/timeline-v3 branch 6 times, most recently from d475800 to dbecd6e Compare February 28, 2022 15:06
jpveooys
jpveooys commented Feb 28, 2022
View reviewed changes
components/layouts/Framework/Framework.tsx
<Head>
<title>{title}</title>
<meta charSet="utf-8" />
<meta name="viewport" content="initial-scale=1.0, width=device-width" />
<script type="text/javascript" src="/static/newrelic.js" />
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These were generating a warning: https://nextjs.org/docs/messages/no-script-tags-in-head-component

@jpveooys jpveooys force-pushed the feature/timeline-v3 branch from dbecd6e to a1abdb1 Compare February 28, 2022 15:50
jpveooys
jpveooys commented Feb 28, 2022
View reviewed changes
tsconfig.json
@@ -21,7 +21,8 @@
"jest",
"@testing-library/jest-dom"
],
"skipLibCheck": true
"skipLibCheck": true,
"incremental": true
Copy link
Contributor Author

Choose a reason for hiding this comment

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

next was adding this automatically.

jpveooys
jpveooys commented Feb 28, 2022
View reviewed changes
package.json
"sass-loader": "^12.4.0",
"semantic-release": "^17.4.2",
"typescript": "^4.5.4"
"semantic-release": "^19.0.2",
Copy link
Contributor Author

@jpveooys jpveooys Feb 28, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Updated this to resolve security alerts – the breaking changes were dropping support for Node 15 and Node <14.17.

jpveooys
jpveooys commented Feb 28, 2022
View reviewed changes
package.json
@@ -16,9 +16,6 @@
"codegen": "gql-gen --config codegen.yml",
"audit": "./scripts/audit/audit.sh"
},
"jest": {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Was causing a warning from Jest that that is was ignoring this as there is a jest.config.js (it's not needed also as the GitHub Actions workflow specifies --testResultsProcessor).

jpveooys
jpveooys commented Feb 28, 2022
View reviewed changes
next-env.d.ts
@@ -1,5 +1,4 @@
/// <reference types="next" />
/// <reference types="next/types/global" />
Copy link
Contributor Author

Choose a reason for hiding this comment

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

next was changing this automatically.

@jpveooys jpveooys marked this pull request as ready for review February 28, 2022 16:05
@jpveooys
build(Storybook): Remove dependency on CSS Framework
7f5e186 
This removes the dependency of Storybook on the legacy CSS Framework and removes unneeded Storybook add-ons.

(Note that Next.js has its own PostCSS config bulit-in.)
@jpveooys
test(Jest): Remove redundant configuration in package.json
54b143a 
This was causing a warning and isn't needed as the `testResultsProcessor` is specified in the GitHub Actions workflow.
@jpveooys
chore(Security): Resolve yarn audit warnings
49a578b 
Also resolves this warning from Next.js: https://nextjs.org/docs/messages/no-script-tags-in-head-component
@jpveooys
test(E2E): Fix failing tests after Contentful updates
afa812a 
This remove tests for the component pages as these have been removed, and updates a masthead test.
@jpveooys
feat(ApiTable): Add ability to specify function type
a76fb00
@jpveooys jpveooys force-pushed the feature/timeline-v3 branch from a1abdb1 to a76fb00 Compare February 28, 2022 16:08
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

83.3% 83.3% Coverage
0.0% 0.0% Duplication

m7kvqbe1
m7kvqbe1 approved these changes Mar 1, 2022
View reviewed changes
Copy link
Collaborator

@m7kvqbe1 m7kvqbe1 left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@jpveooys jpveooys merged commit 09ab12f into master Mar 1, 2022
@jpveooys jpveooys deleted the feature/timeline-v3 branch March 1, 2022 09:25
@jpveooys jpveooys self-assigned this Mar 1, 2022
@jpveooys jpveooys added Type: Dependencies Issues that relate to a dependency Type: Development Related to a design system component labels Mar 1, 2022
@jpveooys jpveooys added Type: Enhancement New feature or request Type: Techdebt Requires or will require rework labels Mar 1, 2022
@github-actions
Copy link

github-actions bot commented Mar 2, 2022

🎉 This PR is included in version 1.10.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@m7kvqbe1 m7kvqbe1 m7kvqbe1 approved these changes

@thyhjwb6 thyhjwb6 Awaiting requested review from thyhjwb6

Assignees

@jpveooys jpveooys

Labels
released Type: Dependencies Issues that relate to a dependency Type: Development Related to a design system component Type: Enhancement New feature or request Type: Techdebt Requires or will require rework
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jpveooys @m7kvqbe1