{"id":15655032,"url":"https://github.com/ultirequiem/lorelai","last_synced_at":"2025-05-01T12:52:10.028Z","repository":{"id":104824000,"uuid":"414042038","full_name":"UltiRequiem/lorelai","owner":"UltiRequiem","description":"✍ Generate Lorem Ipsum like a pro","archived":false,"fork":false,"pushed_at":"2025-03-17T18:22:33.000Z","size":649,"stargazers_count":25,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-01T12:51:59.484Z","etag":null,"topics":["cli","command-line","go","golang","lorem-ipsum","lorem-ipsum-generator","random-generation"],"latest_commit_sha":null,"homepage":"http://ulti.js.org/lorelai/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/UltiRequiem.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-06T02:20:31.000Z","updated_at":"2025-03-17T18:26:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"054e460d-8007-497e-b4ee-3ebfa97f6c72","html_url":"https://github.com/UltiRequiem/lorelai","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UltiRequiem%2Florelai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UltiRequiem%2Florelai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UltiRequiem%2Florelai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UltiRequiem%2Florelai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/UltiRequiem","download_url":"https://codeload.github.com/UltiRequiem/lorelai/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251879122,"owners_count":21658691,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","command-line","go","golang","lorem-ipsum","lorem-ipsum-generator","random-generation"],"created_at":"2024-10-03T12:55:36.085Z","updated_at":"2025-05-01T12:52:10.022Z","avatar_url":"https://github.com/UltiRequiem.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lorelai\n\n[![PkgGoDev](https://pkg.go.dev/badge/github.com/UltiRequiem/lorelai)](https://pkg.go.dev/github.com/UltiRequiem/lorelai)\n![CodeQL](https://github.com/UltiRequiem/lorelai/workflows/CodeQL/badge.svg)\n[![Go Report Card](https://goreportcard.com/badge/github.com/UltiRequiem/lorelai)](https://goreportcard.com/report/github.com/UltiRequiem/lorelai)\n\nA [package](#documentation) and [command line tool](#cli-tool) to generate\n[Lorem ipsum](https://en.wikipedia.org/wiki/Lorem_ipsum).\n\n![Cover](./assets/cover.gif)\n\n[Blog explaining this package](https://ultirequiem.hashnode.dev/lorelai)\n\nCheckout the code coverage at: https://ulti.js.org/lorelai\n\n## Install\n\n```bash\ngo get github.com/UltiRequiem/lorelai/pkg\n```\n\n## Examples\n\n### Generating Text\n\n```go\nfunc printTonsOfText() {\n\tfor i := 0; i \u003c 10; i++ {\n          fmt.Println(lorelai.Paragraph())\n\t}\n}\n```\n\n### Convenience Utilities\n\n```go\nfunc sayHi() {\n\tfmt.Println(fmt.Sprintf(\"My, my name is: %s.\", lorelai.Word()))\n\tfmt.Println(fmt.Sprintf(\"My email address is %s\", lorelai.Email()))\n\tfmt.Println(fmt.Sprintf(\"My website is: %s\", lorelai.URL()))\n}\n```\n\nFor more examples check the [examples directory](./example/main.go).\n\n## Documentation\n\nThis package exports 8 functions:\n\n- [Word](https://github.com/UltiRequiem/lorelai/blob/main/pkg/root.go#L29):\n  Returns 1 Word\n\nE.g: \"sodales\", \"phasellus\" , \"diam\", etc.\n\n- [Sentence](https://github.com/UltiRequiem/lorelai/blob/main/pkg/root.go#L34):\n  Returns 8 Words\n\nE.g: \"Varius sed imperdiet amet laoreet ex sapien placerat.\", etc.\n\n- [Paragraph](https://github.com/UltiRequiem/lorelai/blob/main/pkg/root.go#L39):\n  Returns 45 Words\n\nE.g: \"Nisi lacinia ante non nunc eros nibh mattis enim orci ante in ornare\naccumsan iaculis vel...\"\n\n- [FormattedLoremWords](https://github.com/UltiRequiem/lorelai/blob/main/pkg/root.go#L24):\n  It receives a number and returns a string with the number of words you have\n  indicated. The first letter will be capital and the sentence will end with a\n  dot.\n\nE.g: \"Libero malesuada duis massa luctus.\", \"Curabitur hendrerit sed.\",\n\"Ligula.\", etc.\n\n- [LoremWords](https://github.com/UltiRequiem/lorelai/blob/main/pkg/root.go#L10):\n  It receives a number and returns a string with the number of words you have\n  indicated.\n\nE.g: \"arcu\", \"blandit porttitor a scelerisque\", \"donec justo lacinia\", etc.\n\n- [Domain](https://github.com/UltiRequiem/lorelai/blob/main/pkg/convenience.go#L10):\n  Returns a domain\n\nE.g: \"neque.net\", \"arcu.org\" , \"lorem.io\", etc.\n\n- [URL](https://github.com/UltiRequiem/lorelai/blob/main/pkg/convenience.go#L17):\n  Returns an URL\n\nE.g: \"https://pellentesque.org\", \"https://id.io\" , \"https://efficitur.com\", etc.\n\n- [Email](https://github.com/UltiRequiem/lorelai/blob/main/pkg/convenience.go#L22):\n  Retuns an email address\n\nE.g: \"bibendum@id.pe\", \"ornare@duis.pe\" , \"quisque@faucibus.org\", etc.\n\n## CLI Tool\n\n### Installation\n\n```bash\ngo install github.com/UltiRequiem/lorelai@latest\n```\n\nOr use a binary from\n[releases](https://github.com/UltiRequiem/lorelai/releases/latest).\n\n### Usage\n\nIf you don't pass any flag or you pass the help flag:\n\n```\n lorelai 1.0.0\n Easily generate Lorem Ipsum on command line.\n\n -h or --help           Print this\n\n -w or --word           Number of words to print\n\n -p or --paragraph      Number of paragraphs to print\n\n -s or --sentences      Number of sentences to print\n\n -o or --output         If passed it will try to put the output in a file\n\n --url                  A random URL\n\n --email                A random Email Address\n\n --color                Print the output with colors?\n\n  Examples:\n      lorelai -w 55           # Will print 55 words\n      lorelai -p 5            # Will print 5 paragraphs\n      lorelai -s 5 --output b # Will write 5 sentences on file b if possible\n      lorelai -w 55 -s 5      # Will print 55 words and 5 sentences\n\n If you need more help, found a bug or want to suggest a new feature:\n https://github.com/UltiRequiem/lorelai\n```\n\n## Contributing\n\nFeel free to sugest new features or report bugs.\n\nA big thanks to [Antoineio](https://github.com/Antoineio) for adding tests and\ncontributing to the CI.\n\n## License\n\nThis project is licensed under the [MIT License](./license).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fultirequiem%2Florelai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fultirequiem%2Florelai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fultirequiem%2Florelai/lists"}