fix(js): mimic the behavior of tsc compilation for runTypeCheck

[nartc]

ISSUES CLOSED: #9203

Current Behavior

On Windows, the runTypeCheck with emitDeclarationOnly emits the type definitions to the wrong output directory.

Expected Behavior

runTypeCheck now mimics the behavior of compilationTypescript (from nrwl/workspace which nrwl/js:tsc is utilizing) to ensure the behavior is consistent across different executors on different OS's

Related Issue(s)

Fixes #9203

[nx-cloud]

☁️ Nx Cloud Report

CI ran the following commands for commit 41d8b18. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 7 targets

• nx affected --target=build --base=9261105630f96a59d5e2dd01d12a360bcbae7d16 --head=41d8b18840cef3dc85b0b9752e29c3fd20b516aa --parallel=3
• nx affected --target=e2e --base=9261105630f96a59d5e2dd01d12a360bcbae7d16 --head=41d8b18840cef3dc85b0b9752e29c3fd20b516aa --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=9261105630f96a59d5e2dd01d12a360bcbae7d16 --head=41d8b18840cef3dc85b0b9752e29c3fd20b516aa --exclude=e2e-storybook,e2e-react-native,e2e-detox --parallel=1
• nx affected --target=lint --base=9261105630f96a59d5e2dd01d12a360bcbae7d16 --head=41d8b18840cef3dc85b0b9752e29c3fd20b516aa --parallel=3
• nx affected --target=test --base=9261105630f96a59d5e2dd01d12a360bcbae7d16 --head=41d8b18840cef3dc85b0b9752e29c3fd20b516aa --parallel=1
• nx build typedoc-theme
• nx run-many --target=build --all --parallel=8 --exclude=docs,nx-dev-data-access-documents,nx-dev-e2e,nx-dev,nx-dev-feature-analytics,nx-dev-feature-conf,nx-dev-feature-doc-viewer,nx-dev-feature-search,nx-dev-feature-storage,nx-dev-feature-versions-and-flavors,nx-dev-ui-commands,nx-dev-ui-common,nx-dev-ui-home,nx-dev-ui-member-card,nx-dev-ui-sponsor...

---

Sent with 💌 from NxCloud.

[vercel]

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/nrwl/nx-dev/GNmX4QVGiGqs2Wy1REJJt835PFg5
✅ Preview: Canceled

[Deployment for 41d8b18 canceled]

[thecodeboss]

I ran into this issue myself in an Ubuntu environment. I pulled and tested with this branch locally, and my builds are no longer failing (they were unable to resolve imports due to types being outputted to the wrong place).

This change looks solid to me, I'm not sure there is ever a case where outputPath.replace(`/${projectRoot}`, '') made any sense. Users could simply change the value of the outputPath if they didn't want the projectRoot included in it.

[thecodeboss]

Actually I did some more thinking on this, and I could see one alternative here.

Imagine I have these settings in the project.json:

{
  projectRoot: "libs/mylibrary",
  sourceRoot: "libs/mylibrary/src",
  outputPath: "dist/libs/mylibrary"
}

With this PR as it is, running nx build mylibrary would output .js and .d.ts files as follows:

dist/libs/mylibrary/src/index.js
dist/libs/mylibrary/index.d.ts

Perhaps a more logical layout might be

dist/libs/mylibrary/src/index.js
dist/libs/mylibrary/src/index.d.ts

which could be accomplished with outputPath.replace(`/${projectRoot}`, `/${sourceRoot}`).

Just some food for thought

[nartc]

@thecodeboss thank you for testing it. I'm not seeing the behavior you're seeing though

{
  "root": "packages/buildable-lib",
  "sourceRoot": "packages/buildable-lib/src",
  "targets": {
    "build": {
      "executor": "@nrwl/js:swc",
      "outputs": ["{options.outputPath}"],
      "options": {
        "outputPath": "dist/packages/buildable-lib",
        "main": "packages/buildable-lib/src/index.ts",
        "tsConfig": "packages/buildable-lib/tsconfig.lib.json",
        "assets": ["packages/buildable-lib/*.md"]
      }
    },
  }
}

So with this project.json, I have:

{
   projectRoot: "packages/buildable-lib",
   outputPath: "dist/packages/buildable-lib",
   sourceRoot: "packages/buildable-lib/src"
}

and running nx build buildable-lib yields the following:

dist/packages
└── buildable-lib
    ├── README.md
    ├── package.json
    └── src
        ├── index.d.ts
        ├── index.js
        ├── index.js.map
        └── lib
            ├── buildable-lib.d.ts
            ├── buildable-lib.js
            └── buildable-lib.js.map

Can you double check the configuration for your case?

[jaysoo]

LGTM. Can you also add a check for type defs location to existing e2e tests?

[thecodeboss]

@nartc I was using an older version of nx@13.4.6 where I patched your changes onto it, so I just tested again on nx@13.9.3 and I get the expected behavior now. Sorry for the false alarm, thanks for checking!

[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.