Mention config in generated README & generate env folder

Also, get rid of the extra lib/{package_name} directory which is rarely relevant.
This commit is contained in:
KtorZ 2024-09-06 14:15:44 +02:00
parent 04fb11084c
commit 5ec147e6c7
No known key found for this signature in database
GPG Key ID: 33173CB6F77F4277
1 changed files with 22 additions and 6 deletions

View File

@ -37,9 +37,10 @@ fn create_project(args: Args, package_name: &PackageName) -> miette::Result<()>
})?; })?;
} }
create_lib(&root, package_name)?; create_lib(&root)?;
if !args.lib { if !args.lib {
create_env(&root)?;
create_validators(&root)?; create_validators(&root)?;
} }
@ -94,8 +95,13 @@ fn print_success_message(package_name: &PackageName) {
) )
} }
fn create_lib(root: &Path, package_name: &PackageName) -> miette::Result<()> { fn create_env(root: &Path) -> miette::Result<()> {
let lib = root.join("lib").join(&package_name.repo); let env = root.join("env");
fs::create_dir_all(env).into_diagnostic()
}
fn create_lib(root: &Path) -> miette::Result<()> {
let lib = root.join("lib");
fs::create_dir_all(lib).into_diagnostic() fs::create_dir_all(lib).into_diagnostic()
} }
@ -113,8 +119,6 @@ fn readme(root: &Path, project_name: &str) -> miette::Result<()> {
Write validators in the `validators` folder, and supporting functions in the `lib` folder using `.ak` as a file extension. Write validators in the `validators` folder, and supporting functions in the `lib` folder using `.ak` as a file extension.
For example, as `validators/always_true.ak`
```aiken ```aiken
validator my_first_validator {{ validator my_first_validator {{
spend(_datum: Option<Data>, _redeemer: Data, _output_reference: Data, _context: Data) {{ spend(_datum: Option<Data>, _redeemer: Data, _output_reference: Data, _context: Data) {{
@ -129,13 +133,25 @@ fn readme(root: &Path, project_name: &str) -> miette::Result<()> {
aiken build aiken build
``` ```
## Configuring
**aiken.toml**
```toml
[config.default]
network_id = 41
```
Or, alternatively, write conditional environment modules under `env`.
## Testing ## Testing
You can write tests in any module using the `test` keyword. For example: You can write tests in any module using the `test` keyword. For example:
```aiken ```aiken
use config
test foo() {{ test foo() {{
1 + 1 == 2 config.network_id + 1 == 42
}} }}
``` ```