This repository has been archived by the owner on Feb 26, 2024. It is now read-only.
Restrict general help content in REPL context #5885
Merged
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.
PR description
This PR limits the general help output for
truffle console
andtruffle develop
so help forconsole
,dashboard
,db
,develop
,init
andwatch
won't be shown. It achieves this by defining a single source of truth for valid CLI and Console commands. Thecommands/commands.js
module defines this state, and other parts of the codebase have been refactored to import and rely on this information. The Console class no longer needs to be passedallowedCommands
and has removed the maintenance ofexcludedCommands
. Instead, the signature for the help function has changed to indicate whether it is displaying help for the CLI or the REPL. Tests and webpack concerns have been updated to reflect these changes, and the source of truth for valid Truffle commands has been updated in various files.Contributes to: #5312
Testing instructions
help
in truffle develop, and confirm it doesn't show help forconsole
,dashboard
,db
,develop
,init
andwatch
Documentation & breaking changes concerns