Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: emit modern.config.json when distPath.root is absolute path #4649

Merged
merged 2 commits into from
Sep 14, 2023

Conversation

chenjiahan
Copy link
Member

@chenjiahan chenjiahan commented Sep 14, 2023

Summary

Fix failed to emit modern.config.json when distPath.root is absolute path.

🤖 Generated by Copilot at 0306ca9

This pull request fixes a bug that prevented the modern.config.json file from being emitted when the distPath.root option was set to an absolute path in the app configuration. It also adds a utility function to resolve absolute paths, updates the documentation and the changeset for the affected packages, and adds a new integration test case for the custom distPath.root scenario.

Details

🤖 Generated by Copilot at 0306ca9

  • Add a changeset file to document the patch updates and the bug fix for the issue of failing to emit modern.config.json when the distPath.root is an absolute path (link)
  • Import and use the ensureAbsolutePath utility function from @modern-js/utils to resolve the absolute path of the modern.config.json file in the @modern-js/prod-server and @modern-js/app-tools packages (link, link, link, link)
  • Add a new section to the English and Chinese documentation of the distPath configuration option to explain the meaning and usage of the root property and clarify that other properties under distPath can only be relative paths (link, link)
  • Add a new integration test case for the custom-dist-path scenario, which sets the distPath.root to an absolute path and verifies that the modern.config.json and the index.html files are correctly output to the custom path (link, link, link, link, link)

Related Issue

Checklist

  • I have added changeset via pnpm run change.
  • I have updated the documentation.
  • I have added tests to cover my changes.

@changeset-bot
Copy link

changeset-bot bot commented Sep 14, 2023

🦋 Changeset detected

Latest commit: 0306ca9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 254 packages
Name Type
@modern-js/app-tools Patch
@modern-js/prod-server Patch
@modern-js/plugin-bff Patch
@modern-js/plugin-ssg Patch
@modern-js/plugin-swc Patch
@modern-js/plugin-tailwindcss Patch
@modern-js/devtools-client Patch
@modern-js/devtools-kit Patch
@modern-js/devtools-mount Patch
@modern-js/plugin-devtools Patch
@modern-js/plugin-garfish Patch
@modern-js/plugin-router-v5 Patch
@modern-js/runtime Patch
@modern-js/plugin-express Patch
@modern-js/plugin-koa Patch
@modern-js/plugin-polyfill Patch
@modern-js/plugin-server Patch
@modern-js/plugin-worker Patch
tests Patch
@integration-test/alias-set Patch
api-service-koa Patch
app-docmuent Patch
integration-asset-prefix Patch
async-entry-test Patch
tmp Patch
bff-express Patch
bff-koa Patch
integration-builder-plugins Patch
integration-clean-dist-path Patch
integration-compatibility Patch
integration-copy-assets Patch
integration-custom-dist-path Patch
integration-custom-render Patch
integration-custom-template Patch
dev-server Patch
@integration-test/devtools Patch
integration-disable-html Patch
esbuild-transform-and-minify Patch
integration-config-async-config-test Patch
integration-basic-local-config Patch
integration-config-function-params Patch
integration-local-config-function Patch
main-entry-name Patch
nonce Patch
routes Patch
file-based-router Patch
use-loader Patch
select-mul-entry-test Patch
select-one-entry-test Patch
server-config Patch
server-middleware Patch
server-hook-reqeust Patch
server-hook-response Patch
server-hook-router Patch
@integration-test/server-hook-reqeust Patch
server-prod Patch
@source-code-build/app-ts-loader Patch
@source-code-build/app Patch
ssg-fixtures-nested-routes Patch
ssg-fixtures-simple Patch
ssg-fixtures-web-server Patch
ssr-base-json-test Patch
ssr-base-test Patch
ssr-base-fallback-test Patch
init Patch
ssr-preload Patch
ssr-streaming-test Patch
swc-minify-css Patch
swc-minify-js Patch
transform-fail Patch
integration-tailwindcss-v2 Patch
integration-tailwindcss-v3-js-config Patch
integration-tailwindcss-v3-merge-config Patch
integration-tailwindcss-v3-ts-config Patch
integration-tailwindcss-v3 Patch
twin-macro-v2 Patch
twin-macro-v3 Patch
tmp-dir Patch
write-to-dist Patch
@e2e/garfish-dashboard-router-v6 Patch
@e2e/garfish-dashboard Patch
@e2e/garfish-main-router-v6 Patch
@e2e/garfish-main Patch
@e2e/garfish-table Patch
@modern-js/plugin-testing Patch
@modern-js/server Patch
@modern-js/builder-shared Patch
@modern-js/builder-rspack-provider Patch
@modern-js/builder-webpack-provider Patch
@modern-js/core Patch
@modern-js/plugin-storybook Patch
@modern-js/builder Patch
@modern-js/friendly-errors-webpack-plugin Patch
@modern-js/builder-plugin-esbuild Patch
@modern-js/builder-plugin-node-polyfill Patch
@modern-js/builder-plugin-stylus Patch
@modern-js/builder-plugin-swc Patch
@modern-js/builder-plugin-vue Patch
@modern-js/builder-plugin-vue2 Patch
@e2e/builder Patch
@e2e/builder-cli-rspack Patch
@e2e/builder-cli-vue Patch
@modern-js/builder-plugin-image-compress Patch
@modern-js/module-tools Patch
@e2e/builder-cli-webpack Patch
@modern-js/builder-cli Patch
@modern-js/babel-preset-app Patch
@modern-js/babel-preset-base Patch
@modern-js/doc-plugin-auto-sidebar Patch
@modern-js/plugin-changeset Patch
@modern-js/plugin-data-loader Patch
@modern-js/plugin-i18n Patch
@modern-js/plugin-lint Patch
@modern-js/plugin-proxy Patch
@modern-js/builder-doc Patch
@modern-js/main-doc Patch
@modern-js/module-tools-docs Patch
@modern-js/new-action Patch
@modern-js/sandpack-react Patch
@modern-js-app/eslint-config Patch
@modern-js/eslint-config Patch
@modern-js/tsconfig Patch
@modern-js/babel-plugin-module-resolver Patch
@modern-js/bff-core Patch
@modern-js/bff-runtime Patch
@modern-js/server-core Patch
@modern-js/create-request Patch
@modern-js/server-utils Patch
@modern-js/libuild Patch
@modern-js/libuild-plugin-babel Patch
@modern-js/libuild-plugin-node-polyfill Patch
@modern-js/libuild-plugin-svgr Patch
@modern-js/libuild-plugin-swc Patch
@modern-js/libuild-utils Patch
@modern-js/plugin-module-babel Patch
@modern-js/plugin-module-banner Patch
@modern-js/plugin-module-import Patch
@modern-js/plugin-module-main-fields Patch
@modern-js/plugin-module-node-polyfill Patch
@modern-js/plugin-module-polyfill Patch
@modern-js/plugin-module-target Patch
@modern-js/monorepo-tools Patch
@modern-js/create Patch
@modern-js/e2e Patch
@modern-js/monorepo-utils Patch
@modern-js/node-bundle-require Patch
@modern-js/plugin Patch
@modern-js/types Patch
@modern-js/upgrade Patch
@modern-js/utils Patch
@modern-js/babel-compiler Patch
@scripts/build Patch
@scripts/check-changeset Patch
@scripts/jest-config Patch
@scripts/lint-package-json Patch
@scripts/prebundle Patch
@scripts/update-codesmith Patch
@scripts/update-rspress Patch
@scripts/vitest-config Patch
esbuild-integration Patch
browser-test Patch
lib1 Patch
lib2 Patch
lib3 Patch
antd-mobile Patch
mylib Patch
libuild-test Patch
integration-load-config Patch
integration-module-tools Patch
alias-js-test Patch
alias-ts-test Patch
asset-path-test Patch
auto-external-test Patch
build-platform-test Patch
build-preset-error-test Patch
build-preset-function-test Patch
build-preset-test Patch
build-preset-string-test Patch
build-type-test Patch
copy-test Patch
decorator-test Patch
design-system-test Patch
dev-test Patch
dts-test Patch
entry-test Patch
esbuild-options-test Patch
external-test Patch
format-cjs-test Patch
format-esm-test Patch
format-iife-test Patch
format-umd-test Patch
global-vars-js-test Patch
global-vars-ts-test Patch
input-filter-test Patch
jsx-test Patch
metafile-test Patch
minify-test Patch
platform-test Patch
redirect-test Patch
module-tools-side-effects-test Patch
source-dir-test Patch
sourcemap-test Patch
splitting-test Patch
svgr-test Patch
target-test Patch
tools-test Patch
transform-lodash Patch
umdGlobals-test Patch
get-module-id-test Patch
builder-test Patch
build-watch-test Patch
runtime Patch
entry Patch
@source-code-build/common Patch
@source-code-build/components Patch
@source-code-build/utils Patch
ssg Patch
ssr Patch
swc-integration Patch
tailwindcss-integration-test Patch
@e2e/webpack-builder-import-antd-v4 Patch
@e2e/webpack-builder-import-antd-v5 Patch
@e2e/webpack-builder-import-arco Patch
@e2e/webpack-builder-test-moment Patch
@e2e/builder-remove-prop-types Patch
@e2e/webpack-builder-source-map Patch
@e2e/builder-vue3 Patch
@e2e/builder-vue2 Patch
@e2e/garfish Patch
@modern-js/generator-common Patch
@modern-js/generator-plugin Patch
@modern-js/generator-utils Patch
@modern-js/bff-generator Patch
@modern-js/dependence-generator Patch
@modern-js/entry-generator Patch
@modern-js/generator-generator Patch
@modern-js/module-generator Patch
@modern-js/module-test-generator Patch
@modern-js/monorepo-generator Patch
@modern-js/mwa-generator Patch
@modern-js/router-v5-generator Patch
@modern-js/rspack-generator Patch
@modern-js/ssg-generator Patch
@modern-js/storybook-generator Patch
@modern-js/test-generator Patch
@modern-js/upgrade-generator Patch
@modern-js/generator-plugin-plugin Patch
@modern-js/repo-generator Patch
@modern-js/generator-cases Patch
@modern-js/base-generator Patch
@modern-js/changeset-generator Patch
@modern-js/packages-generator Patch
@modern-js/server-generator Patch
@modern-js/tailwindcss-generator Patch

Not sure what this means? Click here to learn what changesets are.

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

@codecov
Copy link

codecov bot commented Sep 14, 2023

Codecov Report

Patch coverage has no change and project coverage change: -4.02% ⚠️

Comparison is base (99693f0) 57.59% compared to head (0306ca9) 53.58%.
Report is 1159 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4649      +/-   ##
==========================================
- Coverage   57.59%   53.58%   -4.02%     
==========================================
  Files         672      665       -7     
  Lines       17794    18123     +329     
  Branches     3876     4157     +281     
==========================================
- Hits        10249     9711     -538     
- Misses       6934     7754     +820     
- Partials      611      658      +47     

see 468 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@chenjiahan chenjiahan merged commit 0db5680 into web-infra-dev:main Sep 14, 2023
9 checks passed
@chenjiahan chenjiahan deleted the dist_path_root_0914 branch September 14, 2023 09:30
@caohuilin caohuilin mentioned this pull request Sep 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants