fix(js): .swcrc path option should follow existing conventions

[djgrant]

Current Behavior

While testing #10118 locally, I noticed a couple of potential issues that should perhaps be addressed before release:

• swcrcPath is not named consistently with other options e.g. tsConfig, packageJson
• swcrcPath is resolved relative to the project roots, whereas tsConfig and packageJson are resolved relative to the workspace root

Expected Behavior

The implementation follows the same approach as the main option – the option is resolved relative to the project path if the project path is not in the string.

Update: swcrc path is alway resolved relative to the workspace root.

{
  "targets": {
    "build": {
      "executor": "@nrwl/js:swc",
      "options": {
         // path relative to project root",
-        "swcrcPath": "config/swcrc.json"
         // path relative to workspace root (consistent with `tsConfig` and `packageJson`
+        "swcrc": "/packages/my-package/config/swcrc.json",
      }
    }
  }
}

The reason for following this implentation is that the default value defined in schema.json is static so cannot include the relative project path (unless we introduce some kind of string replacement e.g. $projectRoot/.lib.swcrc). This is not an issue withtsConfig and packageJson as they are required options.

Related Issue(s)

#10058

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 9c20834. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 12 targets

• nx affected --target=build --base=c9e28a183e8bb3334a9791a20da17fba77be3d57 --head=9c2083416a493f8abc8066c4a239eede9d40542b --parallel=3
• nx affected --target=e2e --base=c9e28a183e8bb3334a9791a20da17fba77be3d57 --head=9c2083416a493f8abc8066c4a239eede9d40542b --exclude=e2e-detox,e2e-js,e2e-next,e2e-workspace-create,e2e-workspace-integrations,e2e-workspace-core,e2e-react,e2e-web,e2e-angular-extensions,e2e-angular-core,e2e-cli,e2e-nx-plugin,e2e-cypress,e2e-node,e2e-linter,e2e-jest,e2e-a...
• nx affected --target=e2e --base=c9e28a183e8bb3334a9791a20da17fba77be3d57 --head=9c2083416a493f8abc8066c4a239eede9d40542b --exclude=e2e-storybook,e2e-react-native,e2e-detox --parallel=1
• nx affected --target=lint --base=c9e28a183e8bb3334a9791a20da17fba77be3d57 --head=9c2083416a493f8abc8066c4a239eede9d40542b --parallel=3
• nx affected --target=test --base=c9e28a183e8bb3334a9791a20da17fba77be3d57 --head=9c2083416a493f8abc8066c4a239eede9d40542b --parallel=1
• nx build typedoc-theme
• nx-cloud record -- yarn check-commit
• nx-cloud record -- yarn check-imports
• nx-cloud record -- yarn depcheck
• nx-cloud record -- yarn documentation
• nx-cloud record -- yarn nx format:check --base=c9e28a183e8bb3334a9791a20da17fba77be3d57 --head=9c2083416a493f8abc8066c4a239eede9d40542b
• nx-cloud record -- yarn nx workspace-lint

---

Sent with 💌 from NxCloud.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Updated
nx-dev	⬜️ Ignored (Inspect)		May 6, 2022 at 4:08PM (UTC)

[djgrant]

@AgentEnder, I noticed a couple of issues with #10118, which I've PRd a fix for here. I don't think this is the right solution because the behaviour is now unpredictable (i.e. it looks like you can provide a path relative to the workspace root, but it always resolves ot the package root) but wanted to put something out there to get the ball rolling.

If having a default value in schema.json is a fixed constraint could we do one of the following:

• support string substitution e.g. "default": "$projectRoot/.lib.swcrc"
• support a default flag e.g. "default": true, and define the default value in swc.impl.ts

I appreciate there are different types of misdirection from each of these solutions.

[AgentEnder]

@djgrant, I see where you are coming from on this, and it's probably a good thing to standardize them. We are looking at supporting the <projectRoot> token in paths set inside project.json, but we don't have that to use just yet.

I'd recommend holding off on string replacement for that reason.

Additionally, this has already been released as of this morning since 14.1.0 was pushed out. We can still change this, but it'll require a migration now in case anyone has already taken it up. If you feel comfortable writing a migration, here's how I'd imagine the implementation:

• swcrc is an optional property in schema.json and schema.d.ts
• schema.json includes a description for the swcrc property that includes the default value, despite it not having an actual default set.
• If options.swcrc is null, fall back on default value inside the implementation file
• Migrator setup to run on version 14.1.1-beta.0
  • set options.swcrc if options.swcrcPath exists, should be joinPathFragments(project.root, options.swcrcPath)
  • should use forEachExecutorOptions

[djgrant]

@AgentEnder thanks for the guidance on this. I've had a crack at it and tested locally. Let me know if there's anything I've missed.

[AgentEnder]

This looks good, do you care to update the migration version and we can get it merged?

[AgentEnder]

14.1.1 has been released already, can you bump this to 14.1.5-beta.0?

[djgrant]

Done 👍

[github-actions]

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.