Skip to content

docs(lorem): define allowed words #2885

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xDivisionByZerox wants to merge 2 commits into
base: next
Choose a base branch
from
Open

docs(lorem): define allowed words #2885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b26bdff
docs(lorem): define allowed words
xDivisionByZerox May 8, 2024
79e8529
Merge branch 'next' into docs/define-allowed-lorem-words
ST-DDT May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/definitions/lorem.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ import type { LocaleEntry } from './definitions';

/**
* The possible definitions related to lorem texts.
*
* The words in this module are determined by the ISO 15924 script of the locale.
* If a locale uses the Latin script, it will utilize Latin lorem words, while a locale using the Cyrillic script will use Cyrillic lorem words, and so forth.
Copy link
Contributor

@matthewmayer matthewmayer May 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* If a locale uses the Latin script, it will utilize Latin lorem words, while a locale using the Cyrillic script will use Cyrillic lorem words, and so forth.
* If a locale uses the Latin script, it should generally utilize Latin "lorem ipsum" words, while a locale using another script should use real or nonsense words to give the same effect as Latin lorem text.

*/
export type LoremDefinition = LocaleEntry<{
/**
Expand Down
3 changes: 3 additions & 0 deletions src/modules/lorem/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ import { filterWordListByLength } from '../word/filter-word-list-by-length';
/**
* Module to generate random texts and words.
*
* The words in this module are determined by the script of the locale used in the faker instance.
* If a locale uses the Latin script, it will utilize Latin lorem words, while a locale using the Cyrillic script will use Cyrillic lorem words, and so forth.
*
* ### Overview
*
* Generate dummy content using traditional faux-Latin [lorem ipsum](https://en.wikipedia.org/wiki/Lorem_ipsum) (in other locales to `en`, alternative words may be used).
Expand Down