eslint-config-cityssm/lists/writeGoodComments.whitelist.js

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

// eslint-disable-next-line @eslint-community/eslint-comments/disable-enable-pair
/* eslint-disable @cspell/spellchecker */
function capitalize(lowercaseString) {
    return lowercaseString.charAt(0).toUpperCase() + lowercaseString.slice(1);
}
const whitelistLowercase = [
    'only',
    'purchase',
    'maximum',
    'minimum',
    'successfully',
    'validate'
];
/**
 * Words that will not be flagged by write-good-comments.
 */
export const whitelist = [...whitelistLowercase];
// List is case-sensitive, include words starting with capitals.
for (const word of whitelistLowercase) {
    whitelist.push(capitalize(word));
}
export default whitelist;