eslint-config-cityssm/lists/writeGoodComments.allowlist.ts

ESLint rules used in the City of Sault Ste. Marie's TypeScript projects.

/* eslint-disable @cspell/spellchecker */

function capitalize(lowercaseString: string): string {
  return lowercaseString.charAt(0).toUpperCase() + lowercaseString.slice(1)
}

const whitelistLowercase = [
  'only',
  'purchase',
  'maximum',
  'minimum',
  'successfully',
  'validate'
] satisfies Array<Lowercase<string>>

/**
 * Words that will not be flagged by write-good-comments.
 */
export const whitelist = [...whitelistLowercase] as string[]

// List is case-sensitive, include words starting with capitals.
for (const word of whitelistLowercase) {
  whitelist.push(capitalize(word))
}

export default whitelist