PromucFlow_constructor/app/client/src/enterprise
Valera Melnikov c42e0317de
fix: change appsmith alias (#35349)
In order to unify package names, we decided to use `@appsmith` prefix as
a marker to indicate that packages belong to our codebase and that these
packages are developed internally. So that we can use this prefix, we
need to rename the alias of the same name. But since `@appsmith` is
currently being used as an alias for `ee` folder, we have to rename the
alias as the first step.

Related discussion
https://theappsmith.slack.com/archives/CPG2ZTXEY/p1722516279126329

EE PR — https://github.com/appsmithorg/appsmith-ee/pull/4801

## Automation

/ok-to-test tags="@tag.All"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/10267368821>
> Commit: 2b00af2d257e4d4304db0a80072afef7513de6be
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=10267368821&attempt=2"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.All`
> Spec:
> <hr>Tue, 06 Aug 2024 14:24:22 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [x] No
2024-08-06 17:52:22 +03:00
..
README.md

Appsmith EE

We use the ee alias to switch files between CE and EE to avoid conflicts during regular merging.

Steps to change something for the EE version of app

  • For the functionality you want to change the import statement in its consumers to include the ee import in the CE repo. For eg if you want to update the ApplicationCard component will update this file of ApplicationList component.

    FROM

    // ApplicationList.tsx
    
    import ApplicationCard from "./ApplicationCard";
    
    // OR
    
    import ApplicationCard from "pages/Applications/ApplicationCard";
    

    TO

    // ApplicationList.tsx
    
    import ApplicationCard from "ee/pages/Applications/ApplicationCard";
    
  • Create a new file inside the EE repo called ApplicationCard with the same path

    $ touch app/client/src/enterprise/pages/Applications/ApplicationCard
    
  • EE will now use this file, so you can export a custom ApplicationCard component for EE.

The goal is to reduce conflicts and have EE extend virtually any part of CE so selecting files to update will be crucial. You should keep the following points in mind:

  • NEVER update the CE file in the EE repo
  • All the consumers of the file will need it's expected exports.
  • You can import from the CE file and reexport from your EE if no changes are expected.
  • The types of component props if different will cause problems in the component declaration and use. You can export that out these props into the ee space to avoid this problem by reimplementing them in EE.