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

docs: add baseUrl to example tsconfig #7884

Merged
merged 1 commit into from
Aug 3, 2022
Merged

Conversation

Foosballfan
Copy link
Contributor

Without base url, TS errors appear such as Cannot find module '@site/src/components/...

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

Test Plan

Test links

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/

Related issues/PRs

Without base url, TS errors appear such as `Cannot find module '@site/src/components/...`
@facebook-github-bot
Copy link
Contributor

Hi @Foosballfan!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@netlify
Copy link

netlify bot commented Aug 2, 2022

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 7974b3c
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/62e91be1cffe7f000932dfa0
😎 Deploy Preview https://deploy-preview-7884--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

github-actions bot commented Aug 2, 2022

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 85 🟢 98 🟢 100 🟢 100 🟠 80 Report
/docs/installation 🟠 78 🟢 100 🟢 100 🟢 100 🟢 90 Report

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Aug 2, 2022
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@Josh-Cena
Copy link
Collaborator

I would need to investigate. I definitely believe most sites work without it, but I also do believe TS requires you to set baseUrl per-project instead of inheriting it from the shared config...

@Foosballfan
Copy link
Contributor Author

When creating a typescript project from scratch using the --typescript flag it includes the base url in the tsconfig. The docs are just behind when it comes to migrating from js.

@Josh-Cena Josh-Cena changed the title tsconfig requires compiler options with base url docs: add baseUrl to example tsconfig Aug 3, 2022
@Josh-Cena Josh-Cena added the pr: documentation This PR works on the website or other text documents in the repo. label Aug 3, 2022
Copy link
Collaborator

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

Ah I see. Thanks for reminding!

@Josh-Cena Josh-Cena merged commit 01ac2e0 into facebook:main Aug 3, 2022
@Foosballfan Foosballfan deleted the patch-1 branch August 3, 2022 10:31
This was referenced Oct 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants