fiat ⚡

Fiat is latin term that means bringing things into existance. That's pretty much what this guy does... with files.

What is this?

Shortly, is a tool for scaffolding directories and files based on stubs for classes, interfaces, methods, and whatever you provide. It is written in C# using .Netcore 3.1.

If you have to create several boilerplate files for any new implementation, fiat is a tool for you.

Why?

Today's architectures have a common approach of "many objects doing few things" which is better than "few objects doing many things". That's great, but any new implmentation comes with a lot of boilerplate code.

Take Command and Query Responsibility Segregation (CQRS), for example, generally you have separate project libs for commands, queries, persistence, model and the application itself. Any new implementation requires new folders, classes, interfaces etc.

What if...

You could just run something like

fiat new-command Order NewProductItem

Get started

Download the latest release or compile from the code in repository. Put it in your PATH;
Define the stubs files in some folder in your project;
Run fiat init to create the template file fiat.config.json in the root of your project;
Define properly the fiat.config.json template file created. Refer to the simple documentation below;
Run your first fiat profile-name command to create the files you defined;
Get amazed 😲

Stubs

Stubs are files with the boilerplate content to create new files. Refer to the /stubs folder in this repository for some reference and examples. You can use variables in these files to be replaced during the scaffolding creation.

IMPORTANT: Variables should be put between '$'. E.g.: $variablename$. Take a look at the stubs as examples.

fiat.config.json

That's where you define the instructions for directory, file and insertions of code scaffolding for your profiles.

{
  "baseDir": "A fully qualified directory path to which all files are relative to",
  "encoding": "The default encoding is UTF-8. If you need to change that refer to naming convention in the link bellow**",
  "profiles": [
    {
      "name": "profile-name",
      "vars": [ "entity", "action", "variablex", "kindofselfexplanatory" ],
      "stubsDir": "The directory for your stubs. Relative to the base directory defined or a fully qualified path. E.g. stubs/commands",
      "scaffolds": [
        {
          "name": "validator",
          "file": "my-project-model/$entity$/Commands/Validators/$entity$$action$Validator.cs",
          "stub": "Validator.stub",
          "put": { 
            "new-key": "File path to the file with contents to be inserted. A placeholder **fiat:new-key** is expected in the target file/stub.",
            "antoher-key": "A placeholder **fiat:another-key** is expected in the target file/stub."
          }
        }
      ]
    }
  ]
}

** Encoding names convention

A typical command has the following structure

fiat [profile-name] [var1value] [var2value]

diegosiao / fiat