Skip to content
This repository has been archived by the owner on Dec 17, 2024. It is now read-only.

docs: Correct Case of LightBox Import Statement #92

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

satoooh
Copy link

@satoooh satoooh commented Mar 10, 2024

This PR addresses a case sensitivity issue that occurs during the build process on AWS Amplify, even though the build succeeds on local macOS machine.
The issue stems from the import statement of @julian_cataldo/astro-lightbox, where the file lightbox.astro should be correctly referenced as lightbox.astro.

While the incorrect case did not cause problems on local macOS machine, it did cause build failures on AWS Amplify, which, like many Linux-based systems, is case-sensitive. (related issue: #83 )

By correcting the case in the import statement, this PR ensures consistent build success across platforms.
It is also suggested that the documentation be updated to reflect this change and prevent similar issues in the future.

Copy link

changeset-bot bot commented Mar 10, 2024

⚠️ No Changeset found

Latest commit: 57fdfa0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@MFlisar
Copy link

MFlisar commented May 9, 2024

Should really be merged, that's something that is really hard to find as the only message github and netlify tell you is following:

Cannot find module '@julian_cataldo/astro-lightbox/Lightbox.astro' or its corresponding type declarations.

Locally everything worked on my windows laptop but I couldn't figure out why it's not working in those services until I found this issue

@cngJo
Copy link

cngJo commented Jun 10, 2024

Since index.js export defaults the Light Box component, you also could

import Lightbox from '@julian_cataldo/astro-lightbox';

And since only index.js is marked as the main entry point in package.json It's IMO cleaner to import the component directly from the package.

... or did I get something wrong here? If so, please correct me 🙏🏻

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants