aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2024-12-04 08:31:47 +0100
committerGitHub <[email protected]>2024-12-04 07:31:47 +0000
commit2ba5edb1f37c357d992f8d1bd3febf02f68fbbdd (patch)
tree5376ddc9fd3bfee10f441314787e853e2ba5467c
parent1bfa1fa144d58011ce71655c2409663b7114f6a3 (diff)
downloadfaker-2ba5edb1f37c357d992f8d1bd3febf02f68fbbdd.tar.xz
faker-2ba5edb1f37c357d992f8d1bd3febf02f68fbbdd.zip
chore: improve variable naming of system module (#3315)
* chore: improve variable naming of system module * chore: rename variables in tests
-rw-r--r--src/modules/system/index.ts14
-rw-r--r--test/modules/system.spec.ts30
2 files changed, 22 insertions, 22 deletions
diff --git a/src/modules/system/index.ts b/src/modules/system/index.ts
index 1c387e51..8a5c65f0 100644
--- a/src/modules/system/index.ts
+++ b/src/modules/system/index.ts
@@ -77,21 +77,21 @@ export class SystemModule extends ModuleBase {
.toLowerCase()
.replaceAll(/\W/g, '_');
- const extensionsStr = this.faker.helpers
+ const extensionsSuffix = this.faker.helpers
.multiple(() => this.fileExt(), { count: extensionCount })
.join('.');
- if (extensionsStr.length === 0) {
+ if (extensionsSuffix.length === 0) {
return baseName;
}
- return `${baseName}.${extensionsStr}`;
+ return `${baseName}.${extensionsSuffix}`;
}
/**
* Returns a random file name with a given extension or a commonly used extension.
*
- * @param ext Extension. Empty string is considered to be not set.
+ * @param extension The file extension to use. Empty string is considered to be not set.
*
* @example
* faker.system.commonFileName() // 'dollar.jpg'
@@ -99,10 +99,10 @@ export class SystemModule extends ModuleBase {
*
* @since 3.1.0
*/
- commonFileName(ext?: string): string {
- const str = this.fileName({ extensionCount: 0 });
+ commonFileName(extension?: string): string {
+ const fileName = this.fileName({ extensionCount: 0 });
- return `${str}.${ext || this.commonFileExt()}`;
+ return `${fileName}.${extension || this.commonFileExt()}`;
}
/**
diff --git a/test/modules/system.spec.ts b/test/modules/system.spec.ts
index 876fb3c6..1e3ff79b 100644
--- a/test/modules/system.spec.ts
+++ b/test/modules/system.spec.ts
@@ -66,8 +66,8 @@ describe('system', () => {
() => {
describe('commonFileExt()', () => {
it('should return common file types', () => {
- const fileExt = faker.system.commonFileExt();
- const extList = [
+ const actual = faker.system.commonFileExt();
+ const extensions = [
'gif',
'htm',
'html',
@@ -96,11 +96,11 @@ describe('system', () => {
];
expect(
- extList,
- `generated common file ext should be one of [${extList.join(
+ extensions,
+ `generated common file ext should be one of [${extensions.join(
', '
- )}]. Got "${fileExt}".`
- ).include(fileExt);
+ )}]. Got "${actual}".`
+ ).include(actual);
});
});
@@ -164,15 +164,15 @@ describe('system', () => {
describe('fileExt()', () => {
it('should return file ext', () => {
- const fileExt = faker.system.fileExt();
+ const actual = faker.system.fileExt();
- expect(fileExt).toBeTypeOf('string');
- expect(fileExt).not.toBe('');
+ expect(actual).toBeTypeOf('string');
+ expect(actual).not.toBe('');
});
it('should return file ext based on mimeType', () => {
- const fileExt = faker.system.fileExt('text/plain');
- const extList = [
+ const actual = faker.system.fileExt('text/plain');
+ const extensions = [
'txt',
'text',
'conf',
@@ -184,11 +184,11 @@ describe('system', () => {
];
expect(
- extList,
- `generated common file ext should be one of [${extList.join(
+ extensions,
+ `generated common file ext should be one of [${extensions.join(
','
- )}]. Got "${fileExt}".`
- ).include(fileExt);
+ )}]. Got "${actual}".`
+ ).include(actual);
});
});