Skip to content
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

docs(utils): add a JSDoc to createJsVarName #3877

Merged
merged 1 commit into from
Dec 7, 2022
Merged

docs(utils): add a JSDoc to createJsVarName #3877

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 11 additions & 1 deletion src/utils/util.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,17 @@ import { buildError } from './message-utils';

const SUPPRESSED_JSDOC_TAGS: string[] = ['internal'];

export const createJsVarName = (fileName: string) => {
/**
* Create a stylistically-appropriate JS variable name from a filename
*
* If the filename has any of the special characters "?", "#", "&" and "=" it
* will take the string before the left-most instance of one of those
* characters.
*
* @param fileName the filename which serves as starting material
* @returns a JS variable name based on the filename
*/
export const createJsVarName = (fileName: string): string => {
if (isString(fileName)) {
fileName = fileName.split('?')[0];
fileName = fileName.split('#')[0];
Expand Down