feat(vite): add generatePackageJson option to vite executor (#16042)

[jensbodal]

• moves getExtraDependencies helper from esbuild package to js package

Current Behavior

No ability to generate package.json when building with vite executor

Expected Behavior

Allow ability to generate package.json using vite executor

Related Issue(s)

• @nrwl/vite:build add generatePackageJson option #16042

Example

    "build": {
      "executor": "@nrwl/vite:build",
      "outputs": ["{options.outputPath}"],
      "defaultConfiguration": "production",
      "options": {
        "outputPath": "dist/apps/api",
        "ssr": true
      },
      "configurations": {
        "development": {
          "mode": "development"
        },
        "production": {
          "generatePackageJson": true,
          "main": "apps/api/src/main.ts",
          "tsConfig": "apps/api/tsconfig.app.json",
          "mode": "production"
        }
      }
    },

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
nx-dev	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 3, 2023 6:50am

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 8dcbf27. 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 8 targets

• nx run-many -t e2e-macos --parallel=1 --exclude=e2e-detox
• nx affected --target=e2e --base=6ba60a0d2f9c46cf7167aa9f3b11f538dceeec49 --head=8dcbf277b706342f1a9e901b480ae665e7af5093 --parallel=1
• nx affected --target=test --base=6ba60a0d2f9c46cf7167aa9f3b11f538dceeec49 --head=8dcbf277b706342f1a9e901b480ae665e7af5093 --parallel=1
• nx affected --target=build --base=6ba60a0d2f9c46cf7167aa9f3b11f538dceeec49 --head=8dcbf277b706342f1a9e901b480ae665e7af5093 --parallel=3
• nx run-many -t root-lint check-imports check-commit check-lock-files depcheck --parallel=1 --no-dte
• nx affected --target=lint --base=6ba60a0d2f9c46cf7167aa9f3b11f538dceeec49 --head=8dcbf277b706342f1a9e901b480ae665e7af5093 --parallel=3
• nx-cloud record -- nx format:check --base=6ba60a0d2f9c46cf7167aa9f3b11f538dceeec49 --head=8dcbf277b706342f1a9e901b480ae665e7af5093
• nx documentation --no-dte

---

Sent with 💌 from NxCloud.

[jaysoo]

@jensbodal Thanks for the PR. I think the idea makes sense (--generatePackageJson option), but the approach is wrong because we're pulling in other options that don't affect the build (besides package.json generation).

We might have some time to look into this after Nx 16 release, which is in a few weeks.

The workaround for now is to maintain the dependencies manually. Let us know if you have any concerns.

[jensbodal]

but the approach is wrong because we're pulling in other options that don't affect the build (besides package.json generation).

I just want to call out that that's what the esbuild executor does for two of the options. I had wanted to just put these options in a nested object that were specific to generatePackageJson but I didn't because I didn't want to diverge from existing implementations, and they might have some other purpose for the general build later and it would be messy to later require moving main and tsconfig to the root build options.

esbuild executor

• main
• tsConfig
• format
• external

The above are used for both generatePackageJson and esbuild.build (esbuild.build options)

• thirdParty
  • if not set determines if updateBuildableProjectDepsInPackageJson flag is set when calling updatePackageJson
  • sets excludeLibsInPackageJson which is used for generating the package.json
  • determines additional logic for generating the package.json
• dependenciesFieldType
  • not currently in use but I would imagine this is only related to the generate of the packageJson

---

If preferred I could just remove the allowed overrides that I provided and just set them statically instead of being defaults

      buildableProjectDepsInPackageJsonType = 'dependencies',
      excludeLibsInPackageJson = true,
      format = 'esm',
      generateLockfile = true,

This would just leave setting main, tsconfig, and generatePackageJson. Possibly there's a way to pull main and tsconfig from the vite configuration.

I'd like to work with you to make whatever changes in order to get this in since it's something I'd very much like to use.

[jensbodal]

I can remove the tsconfig option and just generate that from ${buildConfig.root}/tsconfig.json

main is a little trickier since it's really only used to make the generated package.json "valid". I could either

1. default this to ./src/index.js and someone could override the setting by having an existing package.json in their directory with the main field populated
2. make generatePackageJson a string option and provide it there
3. make generatePackageJson an object and require setting the value (and other overrides there)
4. require having a package.json with the value set to use generatePackageJson

[jensbodal]

I think I have a better idea now than continuously adding this feature to different executors: #16042 (comment)

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