wkspower / wks-platform

WKS Platform is a cutting-edge Adaptive Case Management platform built on top of Camunda workflow automation engine. Designed to empower organizations with agile and flexible case management capabilities, WKS Platform enables efficient handling of complex, unstructured processes.
MIT License
31 stars 13 forks source link

ESLint issue while running Shell Scripts for Local Development for windows #300

Open vishwakarma-dev opened 1 month ago

vishwakarma-dev commented 1 month ago

ESLint issue while running Shell Scripts for Local Development for windows Failed to start the portal for the local development using the shell scripts

To Reproduce Steps to reproduce the behavior:

  1. Dev setup as described on the installation guide
  2. Update the environment variables
  3. When tried to run docker-portal-startup.sh documented on Shell Scripts for Local Development
  4. Then the below error occurs

7.980 [warn] Code style issues found in 161 files. Run Prettier to fix. 8.005 error Command failed with exit code 1.

Screenshots

https://github.com/user-attachments/assets/ded889d0-d362-4f2c-9bcd-90d0bfc65e3f

Desktop :

francav commented 1 month ago

Hi @vishwakarma-dev Thanks for your contribution.

Where did those prettier issues originate? Are them related to development work you are doing within case-portal react app?

vishwakarma-dev commented 1 month ago

Hi @vishwakarma-dev Thanks for your contribution.

Where did those prettier issues originate? Are them related to development work you are doing within case-portal react app?

It is originated in Case Portal React App when tried to run the whole project with the help of Shell scripts provided on local dev setup while setting Up the Project avail on Github [ Before Any Customisation ]. I fixed that issue and requested to merge please kindly review the solution.

vishwakarma-dev commented 1 month ago

Hi @vishwakarma-dev Thanks for your contribution. Where did those prettier issues originate? Are them related to development work you are doing within case-portal react app?

It is originated in Case Portal React App when tried to run the whole project with the help of Shell scripts provided on local dev setup while setting Up the Project avail on Github [ Before Any Customisation ]. I fixed that issue and requested to merge please kindly review the solution.

Waiting for the reply ??

francav commented 1 month ago

Hi, thank you for your contribution, and I apologize for the delayed response.

I’m not sure if adding a code modification script like prettier --write in a Dockerfile is the best approach. It doesn't seem like the right place for it, especially considering a developer might never run the Dockerfile. When and where should the validation and fixes take place then?

I believe the correct location for eslint/prettier checks is within the CI/CD pipeline (e.g., GitHub Actions), as we currently have it set up. If errors are detected during the pipeline run, the developer should apply the necessary fixes locally before updating the PR. That’s how I envision the process, but I’m open to suggestions for improvement.

That said, I’m unclear why you’re encountering these validation issues on your end. Could you point out the exact issues eslint is raising? We can start from there to understand why it's happening in your environment.

Best regards, Victor