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

[Cleanup] Optimize theme typescript build #524

Merged
merged 4 commits into from
Mar 24, 2023
Merged

Conversation

sserrata
Copy link
Member

Description

Previously, our theme tsc build step used babel to transpile to both esm and cjs. With node 16+ this step is unnecessary. Furthermore, emitting to both lib and lib-next can sometimes lead to unexpected behavior at runtime.

Motivation and Context

From docusaurus maintainer:

Also latest Docusaurus is on Node 16.14 with ESM support, you may not need 2 theme outputs (esm+cjs) now. We removed cjs recently from the classic theme

I mean you don't need to compile the theme in esm + cjs, like we used to
"babel:lib": "cross-env BABEL_ENV=lib babel src -d lib --extensions ".tsx,.ts" --ignore "/.d.ts" --copy-files",
"babel:lib-next": "cross-env BABEL_ENV=lib-next babel src -d lib-next --extensions ".tsx,.ts" --ignore "/
.d.ts" --copy-files",

How Has This Been Tested?

Tested locally. Deploy preview will test prod deployment. Further testing will be needed using standalone docusaurus site.

@github-actions
Copy link

Visit the preview URL for this PR (updated for commit aa4e048):

https://docusaurus-openapi-36b86--pr524-g8cq301q.web.app

(expires Sun, 23 Apr 2023 17:11:05 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

@blindaa121 blindaa121 mentioned this pull request Mar 24, 2023
12 tasks
@sserrata sserrata merged commit 5927f36 into v2.0.0 Mar 24, 2023
@sserrata sserrata deleted the theme/optimize-esm-output branch March 24, 2023 17:54
renovate bot referenced this pull request in Unleash/unleash May 13, 2023
…-beta.3 (#3765)

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[docusaurus-plugin-openapi-docs](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs)
| [`2.0.0-beta.2` ->
`2.0.0-beta.3`](https://renovatebot.com/diffs/npm/docusaurus-plugin-openapi-docs/2.0.0-beta.2/2.0.0-beta.3)
|
[![age](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/2.0.0-beta.3/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/2.0.0-beta.3/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/2.0.0-beta.3/compatibility-slim/2.0.0-beta.2)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/2.0.0-beta.3/confidence-slim/2.0.0-beta.2)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>PaloAltoNetworks/docusaurus-openapi-docs</summary>

###
[`v2.0.0-beta.3`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/releases/tag/v2.0.0-beta.3)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v2.0.0-beta.2...v2.0.0-beta.3)

#### What's Changed

- \[Bug] Narrow SASS loader rules to avoid conflicts with
docusaurus-plugin-sass by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/519](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/519)
- \[Bug] Patch webpack sass loader by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/521](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/521)
- \[Cleanup] Optimize theme typescript build by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/524](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/524)
- Update bash/curl logo and refactor how logo width/height are defined
by [@&#8203;sserrata](https://togithub.com/sserrata) in
[https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/525](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/525)
- \[UI Enhancement] Move authorization card to ApiItem by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/531](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/531)
- \[UI Enhancement] Move CodeTabs above Request by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/533](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/533)
- \[UI Enhancement] Restyle schema property labels by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/534](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/534)
- \[UI Enhancement] Add expand button to CodeBlock by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/537](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/537)
- \[UI Enhancement] Restyle details markers with caret by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/540](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/540)
- \[UI Enhancement] Response Examples: Updated styling and support for
multiple language variants by
[@&#8203;blindaa121](https://togithub.com/blindaa121) in
[https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/542](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/542)
- \[UI Enhancement] Request form validation and updated styling by
[@&#8203;blindaa121](https://togithub.com/blindaa121) in
[https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/530](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/530)
- \[UI Enhancement] Enable Expand button for Response by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/553](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/553)
- Upgrade demo to 2.4.0 and update supported range in plugin and theme
by [@&#8203;sserrata](https://togithub.com/sserrata) in
[https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/554](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/554)
- \[Bug] Improve support for additional properties, cleanup nested
`<li>`, support SchemaItem children by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/563](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/563)
- \[UI Enhancement] Updated left doc panel styling by
[@&#8203;blindaa121](https://togithub.com/blindaa121) in
[https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/557](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/557)
- \[UI Enhancement] ApiDemoPanel: Expand modal cleanup by
[@&#8203;blindaa121](https://togithub.com/blindaa121) in
[https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/566](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/566)
- Prepare release v2.0.0-beta.3 by
[@&#8203;blindaa121](https://togithub.com/blindaa121) in
[https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/570](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/570)

**Full Changelog**:
PaloAltoNetworks/docusaurus-openapi-docs@v2.0.0-beta.2...v2.0.0-beta.3

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://app.renovatebot.com/dashboard#github/Unleash/unleash).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS43OS4xIiwidXBkYXRlZEluVmVyIjoiMzUuNzkuMSIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant