Skip to content
This repository has been archived by the owner on Feb 23, 2024. It is now read-only.

Add recommended extensions for VSCode #5233 #5237

Merged
merged 4 commits into from
Dec 1, 2021

Conversation

gigitux
Copy link
Contributor

@gigitux gigitux commented Nov 24, 2021

This PR helps the onboarding experience for a new user that wants to contribute to this repo.

The recommended extensions are:​

Fixes #5233

Testing

How to test the changes in this Pull Request:

Check out this branch

  1. Open the project with VSCode. Be sure that you don't have already all the extensions listed above installed.
  2. Check if VSCode shows on the bottom right a box for installing the recommended extensions.

Add recommended extension for vs code
@gigitux gigitux added type: enhancement The issue is a request for an enhancement. skip-changelog PRs that you don't want to appear in the changelog. type: cooldown Things that are queued for a cooldown period (assists with planning). labels Nov 24, 2021
@rubikuserbot rubikuserbot requested review from a team and dinhtungdu and removed request for a team November 24, 2021 14:10
@github-actions
Copy link
Contributor

github-actions bot commented Nov 24, 2021

Size Change: +1.99 kB (0%)

Total Size: 1.04 MB

Filename Size Change
build/active-filters.js 7.09 kB +1 B (0%)
build/all-products-frontend.js 22.1 kB +2 B (0%)
build/all-products.js 32.9 kB -9 B (0%)
build/all-reviews.js 8.31 kB +10 B (0%)
build/atomic-block-components/add-to-cart--atomic-block-components/button--atomic-block-components/image---a7e2bb9b.js 2.77 kB +5 B (0%)
build/atomic-block-components/add-to-cart--atomic-block-components/button.js 1.49 kB +3 B (0%)
build/atomic-block-components/add-to-cart-frontend.js 6.87 kB +2 B (0%)
build/atomic-block-components/button-frontend.js 1.48 kB +1 B (0%)
build/atomic-block-components/category-list.js 457 B +1 B (0%)
build/atomic-block-components/image-frontend.js 1.38 kB +1 B (0%)
build/atomic-block-components/price-frontend.js 1.74 kB -14 B (-1%)
build/atomic-block-components/price.js 1.69 kB -14 B (-1%)
build/atomic-block-components/sale-badge.js 624 B +1 B (0%)
build/atomic-block-components/sku.js 385 B -1 B (0%)
build/atomic-block-components/stock-indicator-frontend.js 583 B -1 B (0%)
build/atomic-block-components/stock-indicator.js 586 B +2 B (0%)
build/atomic-block-components/summary.js 874 B -1 B (0%)
build/atomic-block-components/tag-list.js 457 B -1 B (0%)
build/atomic-block-components/title.js 1.11 kB +2 B (0%)
build/attribute-filter-frontend.js 16.6 kB +285 B (+2%)
build/attribute-filter.js 10.8 kB -4 B (0%)
build/cart-blocks/checkout-button-frontend.js 1.14 kB -1 B (0%)
build/cart-blocks/empty-cart-frontend.js 346 B +1 B (0%)
build/cart-blocks/express-payment-frontend.js 4.82 kB -1 B (0%)
build/cart-blocks/line-items-frontend.js 5.11 kB -21 B (0%)
build/cart-blocks/order-summary-frontend.js 8.95 kB +2 B (0%)
build/cart-frontend.js 49.1 kB +235 B (0%)
build/cart.js 44.8 kB +291 B (+1%)
build/checkout-blocks/actions-frontend.js 1.44 kB -1 B (0%)
build/checkout-blocks/billing-address--checkout-blocks/shipping-address-frontend.js 4.24 kB -97 B (-2%)
build/checkout-blocks/billing-address-frontend.js 890 B +1 B (0%)
build/checkout-blocks/contact-information-frontend.js 2.94 kB -4 B (0%)
build/checkout-blocks/express-payment-frontend.js 5.11 kB -1 B (0%)
build/checkout-blocks/order-note-frontend.js 1.13 kB -5 B (0%)
build/checkout-blocks/order-summary-frontend.js 11.4 kB +9 B (0%)
build/checkout-blocks/payment-frontend.js 7.49 kB -3 B (0%)
build/checkout-blocks/shipping-methods-frontend.js 4.89 kB -6 B (0%)
build/checkout-blocks/terms-frontend.js 1.22 kB -3 B (0%)
build/checkout-blocks/totals-frontend.js 323 B +1 B (0%)
build/checkout-frontend.js 51.3 kB +219 B (0%)
build/checkout.js 47.9 kB +371 B (+1%)
build/featured-category.js 6.67 kB +13 B (0%)
build/featured-product.js 8.02 kB +9 B (0%)
build/handpicked-products.js 5.37 kB -2 B (0%)
build/legacy-template.js 2.05 kB -1 B (0%)
build/mini-cart-component-frontend.js 40.9 kB +225 B (+1%)
build/mini-cart.js 5.95 kB -1 B (0%)
build/price-filter-frontend.js 12.4 kB +293 B (+2%)
build/price-filter.js 8.62 kB +3 B (0%)
build/product-categories.js 2.9 kB -1 B (0%)
build/product-category.js 6.44 kB -2 B (0%)
build/product-new.js 5.73 kB -1 B (0%)
build/product-on-sale.js 6.11 kB -2 B (0%)
build/product-search.js 2.47 kB +1 B (0%)
build/product-tag.js 5.81 kB -3 B (0%)
build/product-top-rated.js 5.7 kB -3 B (0%)
build/products-by-attribute.js 6.61 kB -3 B (0%)
build/reviews-by-category.js 9.96 kB +16 B (0%)
build/reviews-by-product.js 11 kB +23 B (0%)
build/single-product-frontend.js 25.5 kB +1 B (0%)
build/single-product.js 8.5 kB -2 B (0%)
build/stock-filter-frontend.js 6.81 kB +296 B (+5%) 🔍
build/stock-filter.js 6.81 kB -1 B (0%)
build/wc-blocks-style.css 21.1 kB +1 B (0%)
build/wc-blocks-vendors.js 254 kB -130 B (0%)
build/wc-blocks.js 2.96 kB +2 B (0%)
ℹ️ View Unchanged
Filename Size
build/active-filters-frontend.js 6.23 kB
build/atomic-block-components/add-to-cart.js 6.44 kB
build/atomic-block-components/button.js 851 B
build/atomic-block-components/category-list-frontend.js 457 B
build/atomic-block-components/image.js 1.05 kB
build/atomic-block-components/rating-frontend.js 553 B
build/atomic-block-components/rating.js 554 B
build/atomic-block-components/sale-badge-frontend.js 626 B
build/atomic-block-components/sku-frontend.js 385 B
build/atomic-block-components/summary-frontend.js 874 B
build/atomic-block-components/tag-list-frontend.js 458 B
build/atomic-block-components/title-frontend.js 1.11 kB
build/blocks-checkout.js 20.8 kB
build/cart-blocks/accepted-payment-methods-frontend.js 1.14 kB
build/cart-blocks/filled-cart-frontend.js 768 B
build/cart-blocks/items-frontend.js 298 B
build/cart-blocks/totals-frontend.js 320 B
build/checkout-blocks/fields-frontend.js 343 B
build/checkout-blocks/shipping-address-frontend.js 976 B
build/mini-cart-contents.js 1.81 kB
build/mini-cart-frontend.js 1.74 kB
build/price-format.js 1.19 kB
build/product-best-sellers.js 5.57 kB
build/reviews-frontend.js 7.21 kB
build/vendors--atomic-block-components/add-to-cart--cart-blocks/order-summary--checkout-blocks/billing-ad--c5eb4dcd-frontend.js 16.1 kB
build/vendors--atomic-block-components/add-to-cart-frontend.js 4.45 kB
build/vendors--atomic-block-components/price--cart-blocks/line-items--cart-blocks/order-summary--checkout--8a3571de-frontend.js 5.71 kB
build/vendors--cart-blocks/line-items--checkout-blocks/order-summary-frontend.js 3.14 kB
build/vendors--cart-blocks/order-summary--checkout-blocks/billing-address--checkout-blocks/order-summary---eb4d2cec-frontend.js 5.02 kB
build/wc-blocks-data.js 8.84 kB
build/wc-blocks-editor-style-rtl.css 15.8 kB
build/wc-blocks-editor-style.css 15.8 kB
build/wc-blocks-google-analytics.js 1.56 kB
build/wc-blocks-middleware.js 949 B
build/wc-blocks-registry.js 2.69 kB
build/wc-blocks-shared-context.js 1.51 kB
build/wc-blocks-shared-hocs.js 1.14 kB
build/wc-blocks-style-rtl.css 21.1 kB
build/wc-blocks-vendors-style-rtl.css 1.37 kB
build/wc-blocks-vendors-style.css 1.37 kB
build/wc-payment-method-bacs.js 820 B
build/wc-payment-method-cheque.js 816 B
build/wc-payment-method-cod.js 912 B
build/wc-payment-method-paypal.js 838 B
build/wc-payment-method-stripe.js 11.1 kB
build/wc-settings.js 2.58 kB

compressed-size-action

Copy link
Member

@dinhtungdu dinhtungdu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gigitux We already have a section on recommended extensions here. Personally, I just use a few extensions listed above. It's not a good developer experience to me if I install recommended extensions then have to remove some of them manually. It's also hard to debug when there is something unexpected caused by one extension in many recommended extensions I've just installed.

On the other hand, in your PR, you remove .vscode from the ignore file. That folder may contain many other local/project-specific files. So I don't think we should whitelist it. I'm not sure about other people's workflow, but for WordPress themes/plugins development, I add the WordPress root dir to the workspace, not the plugin folder, so the recommendation here may not work in that case.

@gigitux
Copy link
Contributor Author

gigitux commented Nov 29, 2021

@dinhtungdu Thanks for your feedback!

We already have a section on recommended extensions here. Personally, I just use a few extensions listed above. It's not a good developer experience to me if I install recommended extensions then have to remove some of them manually. It's also hard to debug when there is something unexpected caused by one extension in many recommended extensions I've just installed.

Before installing the recommended extensions, you can review them and decide not to install them. It's just to speed up the onboarding for the newcomers.

It's also hard to debug when there is something unexpected caused by one extension in many recommended extensions I've just installed.

These extensions were chosen after getting some opinions from other folks in the team about what extensions they use.

On the other hand, in your PR, you remove .vscode from the ignore file.
Maybe, for now, it's just better to whitelist only extensions.json. I will update the PR 👍

Copy link
Member

@dinhtungdu dinhtungdu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gigitux The recommendation doesn't show for me. I have some but not all of the recommended extensions installed. When I check the extension tab, I see some extensions not in our list but appear in the Recommended section. Please check the screencast for more detail.

Screen.Recording.2021-11-30.at.16.09.55.mov

@dinhtungdu
Copy link
Member

dinhtungdu commented Nov 30, 2021

Also, I'm not sure about the benefit of this PR in real use-cases, given that we're developing a WordPress plugin.

I'm not sure about other people's workflow, but for WordPress themes/plugins development, I add the WordPress root dir to the workspace, not the plugin folder, so the recommendation here may not work in that case.

@gigitux
Copy link
Contributor Author

gigitux commented Nov 30, 2021

@gigitux The recommendation doesn't show for me. I have some but not all of the recommended extensions installed. When I check the extension tab, I see some extensions not in our list but appear in the Recommended section. Please check the screencast for more detail.

Screen.Recording.2021-11-30.at.16.09.55.mov

Maybe it doesn't show you because you already closed the dialog in the past or for your VSCode configuration. Check the attached video to check what should happen when a user opens for the first time our project. Another way to check that everything is okay is to open the extension section and write in the search box @recommended.

image

Also, I'm not sure about the benefit of this PR in real use-cases, given that we're developing a WordPress plugin.
The goal of this PR is to improve the experience of our team as well.
They are simply things that don't impact productivity/codebase but can be helpful.

trim_YZA6HU.mp4

@gigitux gigitux requested a review from dinhtungdu November 30, 2021 10:32
Copy link
Member

@dinhtungdu dinhtungdu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They are simply things that don't impact productivity/codebase but can be helpful.

👍🏽

@github-actions github-actions bot added this to the 6.5.0 milestone Dec 1, 2021
@gigitux gigitux merged commit f2f4c56 into trunk Dec 1, 2021
@gigitux gigitux deleted the add/5233-recommended-extension-vs-code branch December 1, 2021 08:50
jonny-bull pushed a commit to jonny-bull/woocommerce-gutenberg-products-block that referenced this pull request Dec 14, 2021
)

* Add recommended extension for vs code woocommerce#5233

Add recommended extension for vs code

* replace PHP extensions

* add editor config extension

* update gitignore
jonny-bull pushed a commit to jonny-bull/woocommerce-gutenberg-products-block that referenced this pull request Dec 16, 2021
)

* Add recommended extension for vs code woocommerce#5233

Add recommended extension for vs code

* replace PHP extensions

* add editor config extension

* update gitignore
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
skip-changelog PRs that you don't want to appear in the changelog. type: cooldown Things that are queued for a cooldown period (assists with planning). type: enhancement The issue is a request for an enhancement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Recommending VSCode extensions to improve the developer experience
2 participants