[script] Add script to create a new module #8918
Merged
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
This adds a helper script to reduce the boilerplate of creating a new module. It creates the module structure and stubs for all necessary files/directories in the module. The script takes a directory path as an argument, verifies that it doesn't already exist and can be written to, deduces the module name from the last part of the path, and then creates all necessary files doing the minimum of what needs to be done. The module contains a root page and single endpoint named "some_api" as an example. If the --tsx option is specified, a stub tsx index is created as well. Note: SQL is contained in the module's directory rather than the LORIS SQL directory because the script doesn't know if it's a project or LORIS module being created (and if project, where SQL is tracked.)
driusan
force-pushed
the
NewModuleScript
branch
from
bad0323
to
04976ce
Compare
kongtiaowang
added
the
Passed Manual Tests
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
This adds a helper script to reduce the boilerplate of creating a new module.
It creates the module structure and stubs for all the files/directories in the module expected by LORIS, including
README, help, and basic tests/test plan. The script takes a directory path as an argument, verifies that it doesn't already exist and can be written to, deduces the module name from the last part of the path, and then creates all necessary files doing the minimum of what needs to be done.The module contains a root page and a single endpoint named "some_api" as an example.
If the --tsx option is specified, a stub tsx index is created as well.
Note: SQL is contained in the new module's directory rather than the LORIS SQL directory because the script doesn't know if it's a project or LORIS module being created (and if project, where SQL is tracked.)