Skip to content

Commit beaee57

Browse files
andrey-helldarandrey-helldar
committed
Make titleCase and configuration handling more robust by supporting undefined values and refining default merges.
1 parent 3d1762f commit beaee57

6 files changed

Lines changed: 73 additions & 50 deletions

File tree

‎dist/index.js‎

Lines changed: 30 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -34450,7 +34450,7 @@ exports["default"] = previewUpdater;
3445034450
Object.defineProperty(exports, "__esModule", ({ value: true }));
3445134451
exports.defaultConfig = void 0;
3445234452
exports.defaultConfig = {
34453-
directory: '',
34453+
directory: undefined,
3445434454
path: {
3445534455
readme: 'README.md'
3445634456
},
@@ -34462,27 +34462,27 @@ exports.defaultConfig = {
3446234462
fontSize: '100px',
3446334463
icon: 'code',
3446434464
packageManager: 'auto',
34465-
packageName: '',
34465+
packageName: undefined,
3446634466
packageGlobal: false,
34467-
title: '',
34468-
description: ''
34467+
title: undefined,
34468+
description: undefined
3446934469
}
3447034470
},
3447134471
repository: {
34472-
owner: '',
34473-
repo: '',
34472+
owner: undefined,
34473+
repo: undefined,
3447434474
commit: {
3447534475
branch: 'preview/update-{random}',
3447634476
title: 'docs(preview): Update preview',
34477-
body: '',
34477+
body: undefined,
3447834478
author: {
3447934479
name: 'github-actions',
3448034480
email: 'github-actions@github.com'
3448134481
}
3448234482
},
3448334483
pullRequest: {
3448434484
title: 'Update preview',
34485-
body: '',
34485+
body: undefined,
3448634486
assignees: [],
3448734487
labels: []
3448834488
}
@@ -34560,14 +34560,13 @@ const writeFile = (config, filename, content) => {
3456034560
fs.writeFileSync(filePath(config, filename), content);
3456134561
};
3456234562
exports.writeFile = writeFile;
34563-
const readConfig = (override, userConfigPath, baseConfig = undefined) => {
34564-
const dataConfig = baseConfig ?? config_1.defaultConfig;
34565-
const content = (0, exports.readFile)(override, userConfigPath);
34563+
const readConfig = (config, userConfigPath) => {
34564+
const content = (0, exports.readFile)(config, userConfigPath);
3456634565
if (content === '') {
34567-
return (0, deepmerge_ts_1.deepmerge)(dataConfig, override);
34566+
return (0, deepmerge_ts_1.deepmerge)(config_1.defaultConfig, config);
3456834567
}
3456934568
const userConfig = yaml.load(content);
34570-
return (0, deepmerge_ts_1.deepmerge)(dataConfig, userConfig, override);
34569+
return (0, deepmerge_ts_1.deepmerge)(config_1.defaultConfig, userConfig, config);
3457134570
};
3457234571
exports.readConfig = readConfig;
3457334572
const exec = async (command) => {
@@ -34589,7 +34588,7 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
3458934588
exports.getImages = void 0;
3459034589
const packageManagers_1 = __nccwpck_require__(2453);
3459134590
const encodeUri = (value) => {
34592-
if (value === '') {
34591+
if (value === '' || value === undefined) {
3459334592
return '';
3459434593
}
3459534594
return encodeURIComponent(value);
@@ -34621,7 +34620,12 @@ const packageManager = (config) => {
3462134620
return '';
3462234621
}
3462334622
};
34624-
const packageName = (image) => image.packageManager !== 'none' ? image.packageName : '';
34623+
const packageName = (image) => {
34624+
if (image.packageManager === 'none') {
34625+
return '';
34626+
}
34627+
return image?.packageName || '';
34628+
};
3462534629
const render = (config, theme) => {
3462634630
const image = config.image.parameters;
3462734631
const params = new URLSearchParams({
@@ -34632,7 +34636,7 @@ const render = (config, theme) => {
3463234636
images: image.icon,
3463334637
packageManager: packageManager(config),
3463434638
packageName: packageName(image),
34635-
description: image.description
34639+
description: image.description || ''
3463634640
});
3463734641
return config.image.url.replace('{title}', encodeUri(image.title)) + '?' + params.toString();
3463834642
};
@@ -34934,11 +34938,16 @@ exports.Repository = Repository;
3493434938

3493534939
Object.defineProperty(exports, "__esModule", ({ value: true }));
3493634940
exports.titleCase = void 0;
34937-
const titleCase = (title) => title
34938-
.replace(/([A-Z])/g, '$1')
34939-
.toLowerCase()
34940-
.replace(/(^|\s|-|_)\S/g, (match) => match.toUpperCase())
34941-
.replace(/[-_]/g, ' ');
34941+
const titleCase = (title) => {
34942+
if (title === '' || title === undefined) {
34943+
return '';
34944+
}
34945+
return title
34946+
.replace(/([A-Z])/g, '$1')
34947+
.toLowerCase()
34948+
.replace(/(^|\s|-|_)\S/g, (match) => match.toUpperCase())
34949+
.replace(/[-_]/g, ' ');
34950+
};
3494234951
exports.titleCase = titleCase;
3494334952

3494434953

‎src/types/config.ts‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ export interface ImageParameters
66
icon: string;
77

88
packageManager: 'composer' | 'npm' | 'yarn' | 'auto' | 'none';
9-
packageName: string;
9+
packageName?: string;
1010
packageGlobal: boolean;
1111

12-
title: string;
13-
description: string;
12+
title?: string;
13+
description?: string;
1414
}
1515

1616
export interface Image
@@ -29,22 +29,22 @@ export interface Commit
2929
{
3030
branch: string;
3131
title: string;
32-
body: string;
32+
body?: string;
3333
author: Author
3434
}
3535

3636
export interface PullRequest
3737
{
3838
title: string;
39-
body: string;
39+
body?: string;
4040
assignees: string[];
4141
labels: string[];
4242
}
4343

4444
export interface Repository
4545
{
46-
owner: string;
47-
repo: string;
46+
owner?: string;
47+
repo?: string;
4848
octokit?: any;
4949

5050
commit: Commit;
@@ -58,15 +58,15 @@ export interface Path
5858

5959
export interface Config
6060
{
61-
directory: string;
61+
directory?: string;
6262
path: Path;
6363

6464
image: Image;
6565
repository: Repository;
6666
}
6767

6868
export const defaultConfig: Config = {
69-
directory: '',
69+
directory: undefined,
7070
path: {
7171
readme: 'README.md'
7272
},
@@ -81,22 +81,22 @@ export const defaultConfig: Config = {
8181
icon: 'code',
8282

8383
packageManager: 'auto',
84-
packageName: '',
84+
packageName: undefined,
8585
packageGlobal: false,
8686

87-
title: '',
88-
description: ''
87+
title: undefined,
88+
description: undefined
8989
}
9090
},
9191

9292
repository: {
93-
owner: '',
94-
repo: '',
93+
owner: undefined,
94+
repo: undefined,
9595

9696
commit: {
9797
branch: 'preview/update-{random}',
9898
title: 'docs(preview): Update preview',
99-
body: '',
99+
body: undefined,
100100

101101
author: {
102102
name: 'github-actions',
@@ -106,7 +106,7 @@ export const defaultConfig: Config = {
106106

107107
pullRequest: {
108108
title: 'Update preview',
109-
body: '',
109+
body: undefined,
110110
assignees: [],
111111
labels: []
112112
}

‎src/utils/image.ts‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import { Config, ImageParameters } from '../types/config'
22
import { hasComposer, hasNpm, hasYarn } from './packageManagers'
33

4-
const encodeUri = (value: string): string => {
5-
if (value === '') {
4+
const encodeUri = (value: string | undefined): string => {
5+
if (value === '' || value === undefined) {
66
return ''
77
}
88

@@ -42,7 +42,13 @@ const packageManager = (config: Config): string => {
4242
}
4343
}
4444

45-
const packageName = (image: ImageParameters): string => image.packageManager !== 'none' ? image.packageName : ''
45+
const packageName = (image: ImageParameters): string => {
46+
if (image.packageManager === 'none') {
47+
return ''
48+
}
49+
50+
return image?.packageName || ''
51+
}
4652

4753
const render = (config: Config, theme: 'light' | 'dark'): string => {
4854
const image = config.image.parameters
@@ -55,7 +61,7 @@ const render = (config: Config, theme: 'light' | 'dark'): string => {
5561
images: image.icon,
5662
packageManager: packageManager(config),
5763
packageName: packageName(image),
58-
description: image.description
64+
description: image.description || ''
5965
})
6066

6167
return config.image.url.replace('{title}', encodeUri(image.title)) + '?' + params.toString()

‎src/utils/strings.ts‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1-
export const titleCase = (title: string) => title
2-
.replace(/([A-Z])/g, '$1')
3-
.toLowerCase()
4-
.replace(/(^|\s|-|_)\S/g, (match: string) => match.toUpperCase())
5-
.replace(/[-_]/g, ' ')
1+
export const titleCase = (title: string | undefined) => {
2+
if (title === '' || title === undefined) {
3+
return ''
4+
}
5+
6+
return title
7+
.replace(/([A-Z])/g, '$1')
8+
.toLowerCase()
9+
.replace(/(^|\s|-|_)\S/g, (match: string) => match.toUpperCase())
10+
.replace(/[-_]/g, ' ')
11+
}

‎tests/helpers/config.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { Config, defaultConfig } from '../../src/types/config'
22
import { deepmerge } from 'deepmerge-ts'
33

4-
export const testConfig: Config = <Config>deepmerge(defaultConfig, {
4+
export const rawTestConfig: Config = <Config>{
55
directory: process.cwd(),
66

77
image: {
@@ -11,4 +11,6 @@ export const testConfig: Config = <Config>deepmerge(defaultConfig, {
1111
description: 'Lightweight preview update in your repository'
1212
}
1313
}
14-
})
14+
}
15+
16+
export const testConfig: Config = <Config>deepmerge(defaultConfig, rawTestConfig)

‎tests/unit/filesystem.test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
import { testConfig } from '../helpers/config'
1+
import { rawTestConfig } from '../helpers/config'
22
import { Config, defaultConfig } from '../../src/types/config'
33
import { readConfig } from '../../src/utils/filesystem'
44
import { CONFIG_PATH } from '../../src/utils/inputs'
55

66
test('read config', () => {
7-
const data: Config = readConfig(testConfig, CONFIG_PATH.defaultValue)
7+
const data: Config = readConfig(rawTestConfig, CONFIG_PATH.defaultValue)
88

99
expect(data.directory).toBe(process.cwd())
1010

0 commit comments

Comments
 (0)