Adding prettier command and running it for the first time #7893

ytimocin · 2024-09-06T21:18:19Z

Description

Adding prettier command and running it for the first time.

Type of change

This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional).

Fixes: #issue_number

radius-functional-tests · 2024-09-06T21:19:50Z

Radius functional test overview

🔍 Go to test action run

Name	Value
Repository	radius-project/radius
Commit ref	`15cff8e`
Unique ID	func61175ee7a7
Image tag	pr-func61175ee7a7

Click here to see the list of tools in the current test run

gotestsum 1.12.0
KinD: v0.20.0
Dapr: 1.12.0
Azure KeyVault CSI driver: 1.4.2
Azure Workload identity webhook: 1.3.0
Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-func61175ee7a7
Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-func61175ee7a7
controller test image location: ghcr.io/radius-project/dev/controller:pr-func61175ee7a7
ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-func61175ee7a7
deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting datastoresrp-cloud functional tests...
⌛ Starting ucp-cloud functional tests...
⌛ Starting corerp-cloud functional tests...
✅ datastoresrp-cloud functional tests succeeded
✅ ucp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

github-actions · 2024-09-06T21:27:50Z

Unit Tests

3 478 tests ±0 3 470 ✅ ±0 5m 15s ⏱️ -2s
270 suites ±0 8 💤 ±0
1 files ±0 0 ❌ ±0

Results for commit 713dee3. ± Comparison against base commit 1c73038.

♻️ This comment has been updated with latest results.

build/prettier.mk

rynowak · 2024-09-10T08:03:41Z

Lets have a discussion before adding new required tools.

For starters, whats the benefit of adding prettier to our contribution process? Why is this worth having every contributor install it and learn how to use it?

build/prettier.mk

radius-functional-tests · 2024-10-14T22:32:06Z

Radius functional test overview

🔍 Go to test action run

Name	Value
Repository	radius-project/radius
Commit ref	`9c712f0`
Unique ID	func632a96e2a1
Image tag	pr-func632a96e2a1

Click here to see the list of tools in the current test run

gotestsum 1.12.0
KinD: v0.20.0
Dapr: 1.12.0
Azure KeyVault CSI driver: 1.4.2
Azure Workload identity webhook: 1.3.0
Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-func632a96e2a1
Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-func632a96e2a1
controller test image location: ghcr.io/radius-project/dev/controller:pr-func632a96e2a1
ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-func632a96e2a1
deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting datastoresrp-cloud functional tests...
⌛ Starting corerp-cloud functional tests...
⌛ Starting ucp-cloud functional tests...
✅ datastoresrp-cloud functional tests succeeded
✅ ucp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

.github/workflows/prettier.yaml

.prettierignore

Makefile

build/prettier.mk

rynowak · 2024-10-15T17:11:16Z

build/prettier.mk

+
+PRETTIER_VERSION := 3.3.3
+
+prettier-check:


Please add documentation for these, use the other files as an example. When it's done you should see the new targets in the command line help printed by make.

rynowak · 2024-10-15T17:12:45Z

build/prettier.mk

+
+prettier-format:
+	@npx prettier@$(PRETTIER_VERSION) --write "*/**/*.{ts,js,mjs,json}"
+


Suggestion:

Should we name/group these commands based on their purpose rather than their tool?

Example:

make format-check

VS

make prettier-check

Consider what would happen if we add more formatting tools in the future.

build/prettier.mk

rynowak · 2024-10-15T17:13:41Z

build/prettier.mk

+	@npx prettier@$(PRETTIER_VERSION) --check "*/**/*.{ts,js,mjs,json}"
+
+prettier-format:
+	@npx prettier@$(PRETTIER_VERSION) --write "*/**/*.{ts,js,mjs,json}"


What is the experience like if node is not installed? What about when it's an ancient version of node?

rynowak · 2024-10-15T17:16:35Z

docs/contributing/contributing-code/contributing-code-building/README.md

+
+```sh
+make me prettier
+```


Can we be less clever about the name?

I think this guidance should be combined with line 14. The idea is that we're giving contributors simple advice. Saying "run make format build test lint" is simpler than saying "run make build test lint and then run make prettier".

radius-functional-tests · 2024-10-16T21:40:59Z

Radius functional test overview

🔍 Go to test action run

Name	Value
Repository	radius-project/radius
Commit ref	`ebcca56`
Unique ID	funcf629a26e8f
Image tag	pr-funcf629a26e8f

Click here to see the list of tools in the current test run

gotestsum 1.12.0
KinD: v0.20.0
Dapr: 1.12.0
Azure KeyVault CSI driver: 1.4.2
Azure Workload identity webhook: 1.3.0
Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-funcf629a26e8f
Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-funcf629a26e8f
controller test image location: ghcr.io/radius-project/dev/controller:pr-funcf629a26e8f
ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-funcf629a26e8f
deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting corerp-cloud functional tests...
⌛ Starting ucp-cloud functional tests...
✅ ucp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

codecov · 2024-10-16T22:11:53Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.34%. Comparing base (1c73038) to head (713dee3).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #7893   +/-   ##
=======================================
  Coverage   59.33%   59.34%           
=======================================
  Files         560      560           
  Lines       37488    37487    -1     
=======================================
+ Hits        22245    22247    +2     
+ Misses      13697    13695    -2     
+ Partials     1546     1545    -1

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

Also running the prettier command for the first time Signed-off-by: ytimocin <[email protected]>

radius-functional-tests · 2024-10-17T22:00:09Z

Radius functional test overview

🔍 Go to test action run

Name	Value
Repository	radius-project/radius
Commit ref	`713dee3`
Unique ID	funcdb04695a1d
Image tag	pr-funcdb04695a1d

Click here to see the list of tools in the current test run

gotestsum 1.12.0
KinD: v0.20.0
Dapr: 1.12.0
Azure KeyVault CSI driver: 1.4.2
Azure Workload identity webhook: 1.3.0
Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-funcdb04695a1d
Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-funcdb04695a1d
controller test image location: ghcr.io/radius-project/dev/controller:pr-funcdb04695a1d
ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-funcdb04695a1d
deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting corerp-cloud functional tests...
⌛ Starting ucp-cloud functional tests...
✅ ucp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

rynowak · 2024-10-17T23:27:05Z

.github/workflows/lint.yaml

+        if: steps.format-check.outcome == 'failure'
+        run: |
+          echo "Format check failed. Please fix the formatting issues. You can run 'make format-write' to update the code."
+          exit 1


Awesome 👍

rynowak

nice!

ytimocin requested review from a team as code owners September 6, 2024 21:18

ytimocin temporarily deployed to functional-tests September 6, 2024 21:18 — with GitHub Actions Inactive

lakshmimsft reviewed Sep 6, 2024

View reviewed changes

build/prettier.mk Outdated Show resolved Hide resolved

ytimocin force-pushed the ytimocin/build/prettier branch from 15cff8e to fd548b4 Compare September 10, 2024 22:34

ytimocin had a problem deploying to functional-tests September 10, 2024 22:34 — with GitHub Actions Failure

ytimocin commented Oct 14, 2024

View reviewed changes

build/prettier.mk Outdated Show resolved Hide resolved

ytimocin force-pushed the ytimocin/build/prettier branch from fd548b4 to 9ea5db0 Compare October 14, 2024 21:37

ytimocin requested a deployment to functional-tests October 14, 2024 21:37 — with GitHub Actions Waiting

ytimocin force-pushed the ytimocin/build/prettier branch from 9ea5db0 to fdb5c75 Compare October 14, 2024 21:40

ytimocin requested a deployment to functional-tests October 14, 2024 21:40 — with GitHub Actions Waiting

ytimocin force-pushed the ytimocin/build/prettier branch from fdb5c75 to 960414d Compare October 14, 2024 21:42

ytimocin requested a deployment to functional-tests October 14, 2024 21:42 — with GitHub Actions Waiting

ytimocin force-pushed the ytimocin/build/prettier branch from 960414d to ee342b6 Compare October 14, 2024 21:44

ytimocin requested a deployment to functional-tests October 14, 2024 21:44 — with GitHub Actions Waiting

ytimocin force-pushed the ytimocin/build/prettier branch from ee342b6 to 9c712f0 Compare October 14, 2024 22:29

ytimocin temporarily deployed to functional-tests October 14, 2024 22:29 — with GitHub Actions Inactive