You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by "njnu-seafish (via GitHub)" <gi...@apache.org> on 2026/01/29 02:01:19 UTC

[PR] [Doc-17913] Add frontend code check section in development documentation in both Chinese and English [dolphinscheduler]

njnu-seafish opened a new pull request, #17914:
URL: https://github.com/apache/dolphinscheduler/pull/17914

   <!--Thanks very much for contributing to Apache DolphinScheduler, we are happy that you want to help us improve DolphinScheduler! -->
   
   ## Purpose of the pull request
   
   close #17913 
   
   ## Brief change log
   
   Add frontend code check section in development documentation in both Chinese and English
   
   ## Verify this pull request
   
   <!--*(Please pick either of the following options)*-->
   
   This pull request is code cleanup without any test coverage.
   
   *(or)*
   
   This pull request is already covered by existing tests, such as *(please describe tests)*.
   
   (or)
   
   This change added tests and can be verified as follows:
   
   <!--*(example:)*
   - *Added dolphinscheduler-dao tests for end-to-end.*
   - *Added CronUtilsTest to verify the change.*
   - *Manually verified the change by testing locally.* -->
   
   (or)
   
   ## Pull Request Notice
   [Pull Request Notice](https://github.com/apache/dolphinscheduler/blob/dev/docs/docs/en/contribute/join/pull-request.md)
   
   If your pull request contains incompatible change, you should also add it to `docs/docs/en/guide/upgrade/incompatible.md`
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [Doc-17913] Add frontend code check section in development documentation in both Chinese and English [dolphinscheduler]

Posted by "SbloodyS (via GitHub)" <gi...@apache.org>.
SbloodyS commented on code in PR #17914:
URL: https://github.com/apache/dolphinscheduler/pull/17914#discussion_r2739577217


##########
docs/docs/en/contribute/development-environment-setup.md:
##########
@@ -54,6 +54,27 @@ pre-commit install
 
 Now, every time you commit your code, `pre-commit` will automatically run `Spotless` to check the code style and formatting.
 
+### Frontend Code Style
+
+DolphinScheduler uses `pnpm` to check and automatically fix frontend code style and formatting issues.
+First, navigate to the frontend project directory:
+
+```shell
+cd dolphinscheduler-ui
+```
+
+Then, run `pnpm run lint` to check and fix frontend code style and formatting issues:
+
+```shell
+pnpm run lint
+```
+
+Finally, you can run `pnpm run build:prod` to perform a full TypeScript type check, ensuring that only type-safe code is committed.

Review Comment:
   ```suggestion
   ```
   
   We don't need this since `pnpm run lint` is enough.



##########
docs/docs/zh/contribute/development-environment-setup.md:
##########
@@ -51,6 +51,27 @@ pre-commit install
 
 现在，每次您提交代码时，`pre-commit`都会自动运行`Spotless`来检查代码风格和格式。
 
+### 前端代码风格
+
+DolphinScheduler使用`pnpm`检查并修复前端代码风格和格式问题。
+首先，进入前端项目文件夹：
+
+```shell
+cd dolphinscheduler-ui
+```
+
+然后，使用`pnpm run lint`检查并修复前端代码风格和格式问题。
+
+```shell
+pnpm run lint
+```
+
+最后，可以运行`pnpm run build:prod`来执行完整的 TypeScript 类型检查，确保只有类型正确的代码才能被提交。
+
+```shell
+pnpm run build:prod
+```

Review Comment:
   ```suggestion
   ```



##########
docs/docs/zh/contribute/development-environment-setup.md:
##########
@@ -51,6 +51,27 @@ pre-commit install
 
 现在，每次您提交代码时，`pre-commit`都会自动运行`Spotless`来检查代码风格和格式。
 
+### 前端代码风格
+
+DolphinScheduler使用`pnpm`检查并修复前端代码风格和格式问题。
+首先，进入前端项目文件夹：
+
+```shell
+cd dolphinscheduler-ui
+```
+
+然后，使用`pnpm run lint`检查并修复前端代码风格和格式问题。
+
+```shell
+pnpm run lint
+```
+
+最后，可以运行`pnpm run build:prod`来执行完整的 TypeScript 类型检查，确保只有类型正确的代码才能被提交。

Review Comment:
   ```suggestion
   ```



##########
docs/docs/en/contribute/development-environment-setup.md:
##########
@@ -54,6 +54,27 @@ pre-commit install
 
 Now, every time you commit your code, `pre-commit` will automatically run `Spotless` to check the code style and formatting.
 
+### Frontend Code Style
+
+DolphinScheduler uses `pnpm` to check and automatically fix frontend code style and formatting issues.
+First, navigate to the frontend project directory:
+
+```shell
+cd dolphinscheduler-ui
+```
+
+Then, run `pnpm run lint` to check and fix frontend code style and formatting issues:
+
+```shell
+pnpm run lint
+```
+
+Finally, you can run `pnpm run build:prod` to perform a full TypeScript type check, ensuring that only type-safe code is committed.
+
+```shell
+pnpm run build:prod
+```

Review Comment:
   ```suggestion
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [Doc-17913] Add frontend code check section in development documentation in both Chinese and English [dolphinscheduler]

Posted by "njnu-seafish (via GitHub)" <gi...@apache.org>.
njnu-seafish commented on code in PR #17914:
URL: https://github.com/apache/dolphinscheduler/pull/17914#discussion_r2744853140


##########
docs/docs/en/contribute/development-environment-setup.md:
##########
@@ -54,6 +54,27 @@ pre-commit install
 
 Now, every time you commit your code, `pre-commit` will automatically run `Spotless` to check the code style and formatting.
 
+### Frontend Code Style
+
+DolphinScheduler uses `pnpm` to check and automatically fix frontend code style and formatting issues.
+First, navigate to the frontend project directory:
+
+```shell
+cd dolphinscheduler-ui
+```
+
+Then, run `pnpm run lint` to check and fix frontend code style and formatting issues:
+
+```shell
+pnpm run lint
+```
+
+Finally, you can run `pnpm run build:prod` to perform a full TypeScript type check, ensuring that only type-safe code is committed.

Review Comment:
   > We don't need this since `pnpm run lint` is enough.
   
   ok.    pnpm exec vue-tsc --noEmit  # Type check



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [Doc-17913] Add frontend code check section in development documentation in both Chinese and English [dolphinscheduler]

Posted by "SbloodyS (via GitHub)" <gi...@apache.org>.
SbloodyS merged PR #17914:
URL: https://github.com/apache/dolphinscheduler/pull/17914


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org