fix: consider lwc dirs nested under package directories #206
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
src/lwc-dev-server/index.ts
Outdated
| if (!existsSync(sfdxConfig) || !lstatSync(sfdxConfig).isFile()) { | ||
| throw new Error(`sfdx-project.json not found in ${rootDir}`); | ||
| if (!packageDirectories || !Array.isArray(packageDirectories)) { | ||
| throw new Error('No package directories defined.'); |
There was a problem hiding this comment.
Give the user a clue about where to define it and a property name or similar. They can search the docs and figure it out. The error message as-is is not actionable.
Suggested change
| throw new Error('No package directories defined.'); | |
| throw new Error(`No package directories defined in ${projectJson}.`); |
There was a problem hiding this comment.
Changed it to use the API provided by sfdx. It outputs a clean error like this:
Error (MissingDefaultPathError): In sfdx-project.json, be sure to specify which package directory (path) is the default. Example: `[{ "path": "packageDirectory1", "default": true }, { "path": "packageDirectory2" }]`
abdulsattar
commented
Oct 19, 2024
| const s = await lwcDevServer.startLWCServer(logger, path.resolve(__dirname, './__mocks__'), fakeIdentityToken, ''); | ||
| expect(s).to.equal(server); | ||
| }); | ||
| // it('calling startLWCServer returns an LWCServer', async () => { |
There was a problem hiding this comment.
Can't figure out a way to mock dirs for tests :(
abdulsattar
force-pushed
the
abdulsattar/dirs
branch
from
e6831b8 to
b382d6b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
We consider lwc folders under each package directory in this format:
<package-directory>/**/lwc.What issues does this PR fix or reference?
@W-16844177@
Fixes #185, #174, #212