Organize the formula folder
What is the formula folder?
This folder contains the files with the formula’s behavior.
Each programming language has its own specificities, but the formula’s structure is almost always the same, no matter what language is used, and will contain:
| File | Description |
|---|---|
config.json | File to configure the formula inputs. |
main file | File to extract local variables. |
pkg/formula file | File to implement the formula operation. |
Dockerfile | File to build docker images. |
README file | File to explain what the formula does. |
Makefile file | File to compile the formula’s code (will be deprecated 03/2021). |
build.sh file | File to compile the formula’s code in shell. |
metadata.json file | File to tag the formula’s information. |
set_unmask.sh file | File used by the Makefile file. |
help.json files | File to configure formula helper messages on the CLI. |
- You can find all languages templates on the ritchie-formulas repository.
Formula folder examples
To change the formula’s behavior for this language, you’ll have at least to update the following files:
- config.json: Update the inputs configurations.
- main.go: Extract the inputs and call the formula’s methods (coded on formula/*).
- formula/*: Code the formula’s behavior.
- help.json: Change command description message.
To change the formula’s behavior for this language, you’ll have at least to update the following files:
- config.json: Update the inputs configurations.
- main.java: Extract the inputs and call the formula’s methods (coded on formula/*).
- formula/*: Code the formula’s behavior.
- help.json: Change command description message.
To change the formula’s behavior for this language, you’ll have at least to update the following files:
- config.json: Update the inputs configurations.
- index.js: Extract the inputs and call the formula’s methods (coded on formula/*).
- formula/*: Code the formula’s behavior.
- help.json: Change command description message.
To change the formula’s behavior for this language, you’ll have at least to update the following files:
- config.json: Update the inputs configurations.
- main.py: Extract the inputs and call the formula’s methods (coded on formula/*).
- formula/*: Code the formula’s behavior.
- help.json: Change command description message.
To change the formula’s behavior for this language, you’ll have at least to update the following files:
- config.json: Update the inputs configurations.
- main.sh: Extract the inputs and call the formula’s methods (coded on formula/*).
- formula/*: Code the formula’s behavior.
- help.json: Change command description message.
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.