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.

Sign up for GitHub

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

Edit readme to include forced overrides functionability #2233

Open
wants to merge 7 commits into
base: feature/extensibility-v2
Choose a base branch
from
+51 −13
Open

Edit readme to include forced overrides functionability #2233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
674df51
Edit readme to include forced overrides functionability
alexvuong Jan 31, 2025
6e2bc81
minor edit
alexvuong Feb 1, 2025
889138f
minor edit
alexvuong Feb 1, 2025
7727c62
minor edit
alexvuong Feb 1, 2025
80b4a00
minor edit
alexvuong Feb 1, 2025
555b01b
PR feedback
alexvuong Feb 1, 2025
11c78d2
PR feedback
alexvuong Feb 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 44 additions & 12 deletions packages/extension-chakra-storefront/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,18 +107,50 @@ Please refer to the sample configuration below in order to properly configure yo
"isProduction": false
},
"enabled": true, // Toggle this extension on or off, this is useful for debugging and development, defaults to true.
"pages": { // Define the url path of each page. A page can be set to false if you want to disable it.
"Account": "/account",
"Cart": "/cart",
"Checkout": "/checkout",
"CheckoutConfirmation": "/checkout/confirmation/:orderNo",
"Home": "/",
"Login": "/login",
"Registration": "/registration",
"ResetPassword": "/reset-password",
"LoginRedirect": "/callback",
"ProductDetail": "/product/:productId",
"ProductList": ["/search", "/category/:categoryId"]
"pages": { // Define the url path of and the configuration on each page. A page can be set to false if you want to disable it.
"Account": {
"path": "/account",
"orderSearchParam": {"limit": 10, "offset": 0, "sort": "best-matches", "refine": []}
},
"Cart": {
"path": "/cart"
},
"Checkout": {
"path": "/checkout",
"shippingCountryCode": [
{"value": "CA", "label": "Canada"},
{"value": "US", "label": "United States"}
]
},
"CheckoutConfirmation": {
"path": "/checkout/confirmation/:orderNo"
},
"Home": {
"path": "/",
"productLimit": 10,
"mainCategory": "newarrivals"
},
"Login": {
"path": "/login"
},
"Registration": {
"path": "/registration"
},
"ResetPassword": {
"path": "/reset-password"
},
"LoginRedirect": {
"path": "/callback"
},
"ProductDetail": {
"path": "/product/:productId"
},
"ProductList": {
"path": ["/search", "/category/:categoryId"],
"imageViewType": "large",
"selectableAttributeId": "color",
"filterAccordionSate": "filters-expanded-index"
}
},
"siteAliases": {}, // Site alias's for multi-site support.
"sites": [ // Site configs for multi-site support.
Expand Down
8 changes: 7 additions & 1 deletion packages/pwa-kit-extension-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,12 @@ Now when the base application is built the import for the `logo.ts` in `extensio

This mechanism is useful when you want to allow for fine grained customization of your application extension. Its the responsibility of the extension developer to ensure their document what files are overridable and what the expected input and output of those files are. For example, if the overridable file is a React component you should document the props that get passed to that component and the expected exports of the file.

#### Forced Overrides
Sometimes, you may need to override some files from an extension but the extension developers do not allow those files to be overridden, you can use `forced_overrides` to bypass these restrictions.
Copy link
Contributor

Choose a reason for hiding this comment

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

🤔 I'm not sure whether this is the right place to describe forced overrides. Because at this point, the readme is talking about The anatomy of an Application Extension (see line 25). But forced overrides is a feature that is used in the base project (not in the app extension).

So what is the correct place? I'm thinking template-typescript-minimal/README.md file. But that readme does not have any existing info on app extensibility.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Typescript minimal is a private project atm. I asked the same question previously too, Adam advised we can put it here to explain about overrides machenism since the logic stays in this package. I think it is okay since we talked about overrides in this section. it is logical we can mentioned about force_overrides too

To do this, create a `.forced_overrides` dot file at the root of your base project, list the files you intend to override, starting with the extension package name. Any files specified in this list will be treated as overridable.

Note: It is advisable to use this function with caution since it could potentially break intended behavior of installed extensions. This should be used as a temporary solution to urgently patch/update an extension.

#### Setup App and Setup Server

These two files represent the core of your extension implementation and how your extension is able to enhance and integrate into your PWA-Kit Application. In your generated extension you'll find that we have stubbed each file out for you with implementations for each Application Extensibility integration point. You can choose to change the implementation of these methods to suit the needs of your extensions, or you can leave them as is if your extension does not require them.
Expand Down Expand Up @@ -280,4 +286,4 @@ export default useStoreLocatorState
```

## Support Policy
Security patches are provided for 24 months after the general availability of each major version of the SDK (1.0, 2.0, and so on).
Security patches are provided for 24 months after the general availability of each major version of the SDK (1.0, 2.0, and so on).
Loading