-
Notifications
You must be signed in to change notification settings - Fork 106
Add composable contract templates #1416
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Jim8y
wants to merge
4
commits into
dev
Choose a base branch
from
feature/template-composer
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,734
−458
Open
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
c2269ee
Add composable contract templates and update docs
Jim8y 5acd7b4
Remove reflection
shargon f33c94a
Merge branch 'dev' into feature/template-composer
shargon a8b3dc6
Update tests/Neo.Compiler.CSharp.UnitTests/UnitTest_TemplateManager.cs
shargon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <Project> | ||
| <PropertyGroup> | ||
| <NeoVersionPrefix>3.8.1</NeoVersionPrefix> | ||
| <NeoVersionSuffix>*</NeoVersionSuffix> | ||
| </PropertyGroup> | ||
|
|
||
| <PropertyGroup> | ||
| <NeoPackageVersion Condition="'$(NeoVersionSuffix)' == ''">$(NeoVersionPrefix)</NeoPackageVersion> | ||
| <NeoPackageVersion Condition="'$(NeoVersionSuffix)' != ''">$(NeoVersionPrefix)-$(NeoVersionSuffix)</NeoPackageVersion> | ||
| </PropertyGroup> | ||
|
|
||
| <PropertyGroup> | ||
| <NeoAnalyzerVersion>$(NeoPackageVersion)</NeoAnalyzerVersion> | ||
| </PropertyGroup> | ||
| </Project> |
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| # Helper script for scaffolding a smart contract together with its MSTest project. | ||
| # Usage: | ||
| # ./scripts/new_contract_with_tests.sh MyContract [Template] | ||
| # ./scripts/new_contract_with_tests.sh MyContract [Template] [Feature...] | ||
| # Template defaults to "Basic". Available templates: Basic, NEP17, NEP11, Ownable, Oracle. | ||
| # Features can be provided as additional arguments (e.g. "NEP17 Ownable Oracle") or comma separated values. | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| if [[ $# -lt 1 ]]; then | ||
| echo "Usage: $0 <ContractName> [Template] [Feature ...]" >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| contract_name="$1" | ||
| shift | ||
|
|
||
| template="Basic" | ||
| features=() | ||
|
|
||
| if [[ $# -gt 0 ]]; then | ||
| template="$1" | ||
| shift | ||
|
|
||
| # If the template argument looks like inline features, treat it as such | ||
| if [[ "$template" == "--features" ]]; then | ||
| template="Basic" | ||
| elif [[ "$template" == -* ]]; then | ||
| echo "Unexpected option '$template'. Pass features without flags." >&2 | ||
| exit 1 | ||
| elif [[ "$template" == *","* || "$template" == *"+"* ]]; then | ||
| features+=("$template") | ||
| template="Basic" | ||
| fi | ||
| fi | ||
|
|
||
| if [[ $# -gt 0 ]]; then | ||
| features+=("$@") | ||
| fi | ||
|
|
||
| feature_args=() | ||
| if [[ ${#features[@]} -gt 0 ]]; then | ||
| for feature in "${features[@]}"; do | ||
| if [[ -n "$feature" ]]; then | ||
| feature_args+=(--features "$feature") | ||
| fi | ||
| done | ||
| fi | ||
|
|
||
| script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" | ||
| repo_root="$(cd "${script_dir}/.." && pwd)" | ||
|
|
||
| if [[ ${#feature_args[@]} -gt 0 ]]; then | ||
| echo "Scaffolding contract '${contract_name}' with template '${template}' and features '${features[*]}' (tests included)..." | ||
| else | ||
| echo "Scaffolding contract '${contract_name}' with template '${template}' (tests included)..." | ||
| fi | ||
| dotnet run --project "${repo_root}/src/Neo.Compiler.CSharp/Neo.Compiler.CSharp.csproj" -- \ | ||
| new "${contract_name}" --template "${template}" "${feature_args[@]}" --with-tests | ||
|
|
||
| cat <<EOF | ||
|
|
||
| Next steps (from the scaffold output): | ||
| cd ${contract_name} | ||
| dotnet tool restore | ||
| dotnet build | ||
| dotnet tool run nccs ${contract_name}.csproj | ||
|
|
||
| cd ../${contract_name}.UnitTests | ||
| dotnet test | ||
|
|
||
| EOF | ||
This file contains hidden or 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 file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The arguments should be sanitized because it goes to the command line