This repository has been archived by the owner on May 3, 2024. It is now read-only.
feat(routes): childRoutes are not required for root module #657
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
📊 Bundle Size Report
|
bishnubista
commented
Jan 21, 2022
…o feat/childRoutes-not-required-in-root-module
bishnubista
commented
Jan 21, 2022
code-forger
suggested changes
Jan 21, 2022
code-forger
reviewed
Jan 21, 2022
code-forger
reviewed
Jan 21, 2022
JAdshead
reviewed
Jan 21, 2022
10xLaCroixDrinker
suggested changes
Jan 24, 2022
10xLaCroixDrinker
previously approved these changes
Jan 24, 2022
Matthew-Mallimo
previously approved these changes
Jan 24, 2022
I will do it. thanks. |
bishnubista
dismissed stale reviews from Matthew-Mallimo and 10xLaCroixDrinker
via
748360a
10xLaCroixDrinker
suggested changes
Jan 24, 2022
| @@ -0,0 +1,3 @@ | |||
| const hasChildRoutes = (module) => (module !== null && typeof module === 'object') && !!module.childRoutes; | |||
There was a problem hiding this comment.
This file needs the license header
| @@ -0,0 +1,11 @@ | |||
| import hasChildRoutes from '../../../src/universal/utils/hasChildRoutes'; | |||
There was a problem hiding this comment.
License header is also needed here
docs/api/modules/Routing.md
Outdated
| @@ -39,7 +39,7 @@ Enables components and modules to define their own child routes. `childRoutes` c | |||
| route, array of routes or a function which accepts the Redux store as the sole argument and returns | |||
| a single route or array of routes. | |||
|
|
|||
| One App requires the Root Module to have at least one child route defined. This can be either `<Route>` or `<ModuleRoute>` with a `path`. | |||
| `childRoutes` is optional for Root Module. `childRoutes` can be either `<Route>` or `<ModuleRoute>` with a `path`. If `childRoutes` is not defined, default path `/` is added to RootRoute prop in one app. | |||
There was a problem hiding this comment.
Suggested change
| `childRoutes` is optional for Root Module. `childRoutes` can be either `<Route>` or `<ModuleRoute>` with a `path`. If `childRoutes` is not defined, default path `/` is added to RootRoute prop in one app. | |
| `childRoutes` is optional for Root Module. `childRoutes` can be either `<Route>` or `<ModuleRoute>` with a `path`. If `childRoutes` is not defined, the default path `/` is added to the root route. |
10xLaCroixDrinker
previously approved these changes
Jan 24, 2022
Matthew-Mallimo
previously approved these changes
Jan 25, 2022
JAdshead
reviewed
Jan 25, 2022
| * permissions and limitations under the License. | ||
| */ | ||
|
|
||
| const hasChildRoutes = (module) => module !== null && typeof module === 'object' && !!module.childRoutes; |
There was a problem hiding this comment.
as null and undefined are falsy this null check is redundant, also not a fan of the type check as i don't think its needed, anything that would throw a type error is considered falsy, anything else (string, int,symbol etc) will return undefined.
Suggested change
| const hasChildRoutes = (module) => module !== null && typeof module === 'object' && !!module.childRoutes; | |
| const hasChildRoutes = (module) => module && !!module.childRoutes; |
If you are desperate for a boolean
Suggested change
| const hasChildRoutes = (module) => module !== null && typeof module === 'object' && !!module.childRoutes; | |
| const hasChildRoutes = (module) => !!module && !!module.childRoutes; |
There was a problem hiding this comment.
@JAdshead Updated.
infoxicator
previously approved these changes
Jan 25, 2022
bishnubista
dismissed stale reviews from infoxicator, Matthew-Mallimo, and 10xLaCroixDrinker
via
4a937e0
JAdshead
approved these changes
Jan 26, 2022
code-forger
approved these changes
Jan 26, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Motivation and Context
Root modules are required to have childRoutes. With this change, childRoutes will be optional.
How Has This Been Tested?
Ran one-app server locally with root module, with and without child routes.
Test cases are written for new files and files changed.
Types of Changes
Checklist:
What is the Impact to Developers Using One App?
Root modules no longer requires childRoutes. If childRoutes are not provided, path is added, which will render root component.