discord.js/packages/api-extractor/src/analyzer/SyntaxHelpers.ts

// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.

import * as ts from 'typescript';

/**
 * Helpers for validating various text string formats.
 */
export class SyntaxHelpers {
	/**
	 * Tests whether the input string is safe to use as an ECMAScript identifier without quotes.
	 *
	 * @remarks
	 * For example:
	 *
	 * ```ts
	 * class X {
	 *   public okay: number = 1;
	 *   public "not okay!": number = 2;
	 * }
	 * ```
	 *
	 * A precise check is extremely complicated and highly dependent on the ECMAScript standard version
	 * and how faithfully the interpreter implements it.  To keep things simple, `isSafeUnquotedMemberIdentifier()`
	 * conservatively accepts any identifier that would be valid with ECMAScript 5, and returns false otherwise.
	 */
	public static isSafeUnquotedMemberIdentifier(identifier: string): boolean {
		if (identifier.length === 0) {
			return false; // cannot be empty
		}

		if (!ts.isIdentifierStart(identifier.codePointAt(0)!, ts.ScriptTarget.ES5)) {
			return false;
		}

		for (let index = 1; index < identifier.length; index++) {
			if (!ts.isIdentifierPart(identifier.codePointAt(index)!, ts.ScriptTarget.ES5)) {
				return false;
			}
		}

		return true;
	}

	/**
	 * Given an arbitrary input string, return a regular TypeScript identifier name.
	 *
	 * @remarks
	 * Example input:  "api-extractor-lib1-test"
	 * Example output: "apiExtractorLib1Test"
	 */
	public static makeCamelCaseIdentifier(input: string): string {
		const parts: string[] = input.split(/\W+/).filter((x) => x.length > 0);
		if (parts.length === 0) {
			return '_';
		}

		for (let index = 0; index < parts.length; ++index) {
			let part: string = parts[index]!;
			if (part.toUpperCase() === part) {
				// Preserve existing case unless the part is all upper-case
				part = part.toLowerCase();
			}

			if (index === 0) {
				// If the first part starts with a number, prepend "_"
				if (/\d/.test(part.charAt(0))) {
					part = '_' + part;
				}
			} else {
				// Capitalize the first letter of each part, except for the first one
				part = part.charAt(0).toUpperCase() + part.slice(1);
			}

			parts[index] = part;
		}

		return parts.join('');
	}
}