feat: new custompages upload command

[emilyskuo]

🚥 Resolves RM-12966

🧰 Changes

Adding a new custompages upload command for folks to upload MD or HTML custom pages. Largely copied from docs/reference upload with some minor tweaks (adding HTML as a valid input).

🧬 QA & Testing

See __tests__/commands/custompages/upload.test.ts. Also did some manual testing locally with some of the custom page test fixtures

[kanadgupta]

a couple small nits below but overall this looks great! quick question since the answer is not immediately jumping out to me — if a user passes an HTML file into this, do we set the type: 'html'?

[erunion]

+1'ing kanad's feedback but this lgtm

[emilyskuo]

quick question since the answer is not immediately jumping out to me — if a user passes an HTML file into this, do we set the type: 'html'?

@kanadgupta I tested this out with an HTML file with just a title in the metadata and no we're not 😬 It uploaded as type: 'markdown' (I assume as a default). AJV doesn't catch it as an error, but we could add a check to fix to update content.type if it detects an html file

[kanadgupta]

@emilyskuo hmm yeah there are a few places we could do this... i wouldn't necessarily consider this a "frontmatter fix" per se since this shouldn't be an attribute that users specify in their frontmatter — what if we did it around here instead:

rdme/src/lib/syncPagePath.ts

Lines 100 to 122 in ad93a7a

	// normalize the category uri
	if (payload.category?.uri) {
	const regex = new RegExp(categoryUriRegexPattern);
	if (!regex.test(payload.category.uri)) {
	let uri = payload.category.uri;
	this.debug(`normalizing category uri ${uri} for ${filePath}`);
	// remove leading and trailing slashes
	uri = uri.replace(/^\/|\/$/g, '');
	payload.category.uri = `/branches/${branch}/categories/${this.route}/${uri}`;
	}
	}
	// normalize the parent uri
	if (payload.parent?.uri) {
	const regex = new RegExp(parentUriRegexPattern);
	if (!regex.test(payload.parent.uri)) {
	let uri = payload.parent.uri;
	this.debug(`normalizing parent uri ${uri} for ${filePath}`);
	// remove leading and trailing slashes
	uri = uri.replace(/^\/|\/$/g, '');
	payload.parent.uri = `/branches/${branch}/${this.route}/${uri}`;
	}
	}

in those if-statements, we're patching the category/parent page data in the payload prior to hitting the API, so maybe that's also a good spot to do this as well? i believe this pushPage function should have access to all the info you need (the full file name, the fixed up frontmatter data, etc.). if you look at my very much in-progress changelog PR, i also enhanced the types of those payloads to support changelog types. if you end up running with this approach i'd probably suggest doing that as well.

let me know if you think of a better spot or if you run into any issues with this approach!

[kanadgupta]

just a handful of requested changes that should be quick to address, but on the whole this looks phenomenal. great work ❤️‍🔥

[kanadgupta]

hell yeah brother 🤘🏽 this was a surprisingly gnarly change, awesome work!

[kanadgupta]

🎉 This PR is included in version 10.4.0-next.1 🎉

The release is available on:

• npm package (@next dist-tag)
• v10.4.0-next.1
• GitHub release

Your semantic-release bot 📦🚀