cezarovici / goLayouter

3 stars 1 forks source link

TODOs #1

Open TudorHulban opened 1 year ago

TudorHulban commented 1 year ago
  1. readme usage, take out:
    • output_folder_name
    • not working, but good idea
  2. without short verb forms
  3. move English to third person from current 2nd person
  4. take out vendor approach
  5. move file names to special with main.go notation
  6. add zerolog !!
  7. implement OS exits
  8. error messages should be directs to os.stderr not fmt.Println
  9. https://github.com/cezarovici/goLayouter/blob/master/app/services/service.go#L17, import as renders not templates does it make sense, from a wording perspective??
    renderFuncs: templates,
  10. https://github.com/cezarovici/goLayouter/blob/master/app/services/service.go#L31
    • reduce scope
    • introduce structured errors
  11. https://github.com/cezarovici/goLayouter/blob/master/app/services/renders/render_funcs.go#L34, define a type, render
  12. https://github.com/cezarovici/goLayouter/blob/master/app/services/renders/constants.go#L16, package globals should be prefixed with "_" note that https://github.com/cezarovici/goLayouter/blob/master/app/services/renders/constants.go#L10 is not a package global
  13. https://github.com/cezarovici/goLayouter/blob/master/app/services/renders/render_funcs_test.go#L11, do we need to export it?
  14. https://github.com/cezarovici/goLayouter/blob/master/domain/interfaces.go#L6, rename or change the content as it does not make sense
  15. https://github.com/cezarovici/goLayouter/blob/master/domain/item/item.go#L10, works like enum, add for the reader the types you had in mind
  16. https://github.com/cezarovici/goLayouter/blob/master/helpers/helpers.go#L129, in Go we do not have an empty line between the error definition and check
  17. https://github.com/cezarovici/goLayouter/blob/master/helpers/helpers.go#L105, rename param so a reader understands what it is without reading the function body!!
  18. https://github.com/cezarovici/goLayouter/blob/master/helpers/helpers.go, rename file to file_operations and move what is not according to other file which you name in something different than helpers
  19. https://github.com/cezarovici/goLayouter/blob/master/line/line.go, line is not in domain?? what kind of structuring are you implementing?
  20. https://github.com/cezarovici/goLayouter/blob/master/line/line.go#L54, rename as res
cezarovici commented 1 year ago

1 - 4 solved at this 51c9b82906b3debae6528062920fe50d45356e5b commit

cezarovici commented 1 year ago

9 - 10 solved here 19f3253ca14057b0b5daa915ebe9ef642feeffcf

cezarovici commented 1 year ago

12 solved 281579333704b90a190badce2bfc6dbe7c0dd5db

cezarovici commented 1 year ago

13 - 14 solved 57da0c263fe7b2ae0e99af56d36d72e6b2526627

cezarovici commented 1 year ago

19 solved 4d68ca5263a08da1f9701e89be4762063b699459

cezarovici commented 1 year ago

20 solved abdc69956d1c652008c4a786a8119941fa0dca55

cezarovici commented 1 year ago

I don't know :

cezarovici commented 1 year ago

with all changes, I remove the linked file there, but I think 16 is solved, let me know if there are any kind of that problems LE: same for 17

cezarovici commented 1 year ago

15 solved 9e188ca3c8e1bf3303d89cf27cda735048f8e1e0

TudorHulban commented 1 year ago

Please open PRs moving forward!!!