Ovdje je prijedlog kako da učinimo da poruke u Mantil CLI budu kratke, jasne i actionable. Dobar dio ideja sam bezobrazno posudio iz Homebrew čiji način komunikacije je svjetli primjer.
Poruke iz CLI-a dijelimo u (najmanje) dvije razine:
Prva razina poruka je informativne naravi. Jasno opisuje što se događa (ili se dogodilo) i koji je ishod, ali bez da ulazi u detalje poput nabrojavanja svakog koraka u procesu. Informacije trebaju biti čim općenitije i kraće, ali da je iz njih ipak moguće nešto zaključiti i poduzeti (actionable).
Drugs razina poruka je detaljne naravi. Aktivira se opcijom -v. Informacije na ovoj razini detaljno opisuju korake koje Mantil poduzima (ili će poduzeti). Pobrojani su svi koraci i njihovi ishodi. Ova se razina koristi za debugging i slične analize.
Primjer: mantil aws install
mantil aws install ... će kod uspješne instalacije ispisati:
Installing setup lambda function… Done.
==> Setting up AWS infrastructure…
Creating Cloudwatch log groups… Done.
Adding IAM Roles… Done.
Adding DynamoDB database… Done.
Installing Mantil Lambda functions… Done.
Setting up SQS forwarder… Done.
Setting up API Gateway… Done.
==> Installation successful!
63 items added, 0 changed, 0 destroyed
==> Next steps:
- Run mantil help to get started
- Run mantil new to start a new project
- Further documentation:
https://docs.mantil.io
Ovo je dovoljno kratko, jasno i actionable. Kad bismo još izbacili informacije koje slijede iza ==> Setting up AWS infrastructure…, onda bismo izgubili informacije koje pomažu da pregledamo kakve je posljedice napravila instalacija. S informacijom da su napravljene log groups ili IAM Roles već mogu nešto potražiti u AWS-ovu sučelju.
Na žalost, ovdje ne mogu predočiti boje pa prilažem PDF.
Related to: Mantil CLI
Ovdje je prijedlog kako da učinimo da poruke u Mantil CLI budu kratke, jasne i actionable. Dobar dio ideja sam bezobrazno posudio iz Homebrew čiji način komunikacije je svjetli primjer.
Poruke iz CLI-a dijelimo u (najmanje) dvije razine:
-v
. Informacije na ovoj razini detaljno opisuju korake koje Mantil poduzima (ili će poduzeti). Pobrojani su svi koraci i njihovi ishodi. Ova se razina koristi za debugging i slične analize.Primjer: mantil aws install
mantil aws install ...
će kod uspješne instalacije ispisati:Ovo je dovoljno kratko, jasno i actionable. Kad bismo još izbacili informacije koje slijede iza
==> Setting up AWS infrastructure…
, onda bismo izgubili informacije koje pomažu da pregledamo kakve je posljedice napravila instalacija. S informacijom da su napravljene log groups ili IAM Roles već mogu nešto potražiti u AWS-ovu sučelju.Na žalost, ovdje ne mogu predočiti boje pa prilažem PDF.
CLI output example.pdf
Opcija -v radi isto što i gore samo s umetnutim podacima kao do sad.