index.js 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. 'use strict';
  2. const declarationValueIndex = require('../../utils/declarationValueIndex');
  3. const getDeclarationValue = require('../../utils/getDeclarationValue');
  4. const isStandardSyntaxFunction = require('../../utils/isStandardSyntaxFunction');
  5. const { camelCaseFunctions } = require('../../reference/functions');
  6. const optionsMatches = require('../../utils/optionsMatches');
  7. const report = require('../../utils/report');
  8. const ruleMessages = require('../../utils/ruleMessages');
  9. const setDeclarationValue = require('../../utils/setDeclarationValue');
  10. const validateOptions = require('../../utils/validateOptions');
  11. const valueParser = require('postcss-value-parser');
  12. const { isRegExp, isString } = require('../../utils/validateTypes');
  13. const isStandardSyntaxValue = require('../../utils/isStandardSyntaxValue');
  14. const ruleName = 'function-name-case';
  15. const messages = ruleMessages(ruleName, {
  16. expected: (actual, expected) => `Expected "${actual}" to be "${expected}"`,
  17. });
  18. const meta = {
  19. url: 'https://stylelint.io/user-guide/rules/function-name-case',
  20. fixable: true,
  21. };
  22. const mapLowercaseFunctionNamesToCamelCase = new Map();
  23. for (const func of camelCaseFunctions) {
  24. mapLowercaseFunctionNamesToCamelCase.set(func.toLowerCase(), func);
  25. }
  26. /** @type {import('stylelint').Rule} */
  27. const rule = (primary, secondaryOptions, context) => {
  28. return (root, result) => {
  29. const validOptions = validateOptions(
  30. result,
  31. ruleName,
  32. {
  33. actual: primary,
  34. possible: ['lower', 'upper'],
  35. },
  36. {
  37. actual: secondaryOptions,
  38. possible: {
  39. ignoreFunctions: [isString, isRegExp],
  40. },
  41. optional: true,
  42. },
  43. );
  44. if (!validOptions) {
  45. return;
  46. }
  47. root.walkDecls((decl) => {
  48. if (!isStandardSyntaxValue(decl.value)) return;
  49. let needFix = false;
  50. const parsed = valueParser(getDeclarationValue(decl));
  51. parsed.walk((node) => {
  52. if (node.type !== 'function' || !isStandardSyntaxFunction(node)) {
  53. return;
  54. }
  55. const functionName = node.value;
  56. const functionNameLowerCase = functionName.toLowerCase();
  57. if (optionsMatches(secondaryOptions, 'ignoreFunctions', functionName)) {
  58. return;
  59. }
  60. let expectedFunctionName = null;
  61. if (
  62. primary === 'lower' &&
  63. mapLowercaseFunctionNamesToCamelCase.has(functionNameLowerCase)
  64. ) {
  65. expectedFunctionName = mapLowercaseFunctionNamesToCamelCase.get(functionNameLowerCase);
  66. } else if (primary === 'lower') {
  67. expectedFunctionName = functionNameLowerCase;
  68. } else {
  69. expectedFunctionName = functionName.toUpperCase();
  70. }
  71. if (functionName === expectedFunctionName) {
  72. return;
  73. }
  74. if (context.fix) {
  75. needFix = true;
  76. node.value = expectedFunctionName;
  77. return;
  78. }
  79. report({
  80. message: messages.expected,
  81. messageArgs: [functionName, expectedFunctionName],
  82. node: decl,
  83. index: declarationValueIndex(decl) + node.sourceIndex,
  84. result,
  85. ruleName,
  86. });
  87. });
  88. if (context.fix && needFix) {
  89. setDeclarationValue(decl, parsed.toString());
  90. }
  91. });
  92. };
  93. };
  94. rule.ruleName = ruleName;
  95. rule.messages = messages;
  96. rule.meta = meta;
  97. module.exports = rule;