mirror of
https://github.com/enso-org/enso.git
synced 2024-11-27 18:12:31 +03:00
784d06912f
This is not strictly necessary (as indicated by the fact that no actual logic needed to be changed), but it doesn't hurt to make this change. - Make (almost) all `interface`s `readonly` - Some of them are *not* readonly; this is intentional as those *do* need to be mutated - A `no-restricted-syntax` lint rule has been added, but only for `interfaces` - it has been added neither for `classes` nor for `readonly T[]` - A lint rule for `extends React.PropsWithChildren` instead of `extends Readonly<React.PropsWithChildren>` would be easy to add though... # Important Notes - There should be no logic changes, so QA shouldn't need to test anything in particular. |
||
|---|---|---|
| .. | ||
| e2e | ||
| src | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc.cjs | ||
| 404.html | ||
| esbuild-config.ts | ||
| index.html | ||
| package.json | ||
| playwright.config.ts | ||
| postcss.config.js | ||
| README.md | ||
| tailwind.config.js | ||
| tsconfig.json | ||
| vite.config.ts | ||
| vite.test.config.ts | ||
| vitest.config.ts | ||
Dashboard
The dashboard is the entrypoint into the application. It includes project management, project sharing, and user accounts and authentication.
Folder structure
mock/: Overrides for specific files insrc/when running Playwright tests.test-component/: Contains component tests.test-e2e/: Contains end-to-end tests.**/__tests__/: Contains all unit tests. Unit tests MUST be in a__tests__/subfolder, not beside the module they are testing.src/: The dashboard application.index.html: The sole HTML file used by this SPA. It imports the TS entry point.authentication/src/: The main body of the app.index.tsx: The TS entry point.providers/: Contains ReactContexts used by the main app.components/: Contains the root component for the app.dashboard/: The main body of the app. Directly in the folder, there are some utility modules that do not belong elsewhere.components/: Contains all components used by the main app.events/: Custom discriminated unions used to communicate messages between unrelated components.
authentication/: The authentication flow. This includes login, registration, and changing passwords.components/: Contains all components used by the authentication flow.providers/: Contains ReactContexts required for authentication, and used by the main app.