index.js 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. 'use strict';
  2. const valueParser = require('postcss-value-parser');
  3. const declarationValueIndex = require('../../utils/declarationValueIndex');
  4. const findNotContiguousOrRectangular = require('./utils/findNotContiguousOrRectangular');
  5. const report = require('../../utils/report');
  6. const ruleMessages = require('../../utils/ruleMessages');
  7. const validateOptions = require('../../utils/validateOptions');
  8. const { assert } = require('../../utils/validateTypes');
  9. const ruleName = 'named-grid-areas-no-invalid';
  10. const messages = ruleMessages(ruleName, {
  11. expectedToken: () => 'Expected cell token within string',
  12. expectedSameNumber: () => 'Expected same number of cell tokens in each string',
  13. expectedRectangle: (name) => `Expected single filled-in rectangle for "${name}"`,
  14. });
  15. const meta = {
  16. url: 'https://stylelint.io/user-guide/rules/named-grid-areas-no-invalid',
  17. };
  18. /** @type {import('stylelint').Rule} */
  19. const rule = (primary) => {
  20. return (root, result) => {
  21. const validOptions = validateOptions(result, ruleName, { actual: primary });
  22. if (!validOptions) {
  23. return;
  24. }
  25. root.walkDecls(/^(?:grid|grid-template|grid-template-areas)$/i, (decl) => {
  26. const { value } = decl;
  27. if (value.toLowerCase().trim() === 'none') return;
  28. /** @type {Array<{ values: string[], index: number, endIndex: number }>} */
  29. const areas = [];
  30. let reportSent = false;
  31. valueParser(value).walk(({ sourceIndex, sourceEndIndex, type, value: tokenValue }) => {
  32. if (type !== 'string') return;
  33. if (tokenValue === '') {
  34. complain(messages.expectedToken(), sourceIndex, sourceEndIndex);
  35. reportSent = true;
  36. return;
  37. }
  38. areas.push({
  39. values: tokenValue.trim().split(' ').filter(Boolean),
  40. index: sourceIndex,
  41. endIndex: sourceEndIndex,
  42. });
  43. });
  44. if (reportSent) return;
  45. const [firstArea] = areas;
  46. if (firstArea === undefined) return;
  47. const notSameNumberArea = areas.find(
  48. (area) => area.values.length !== firstArea.values.length,
  49. );
  50. if (notSameNumberArea !== undefined) {
  51. complain(
  52. messages.expectedSameNumber(),
  53. notSameNumberArea.index,
  54. notSameNumberArea.endIndex,
  55. );
  56. return;
  57. }
  58. const notContiguousOrRectangular = findNotContiguousOrRectangular(areas.map((a) => a.values));
  59. for (const name of notContiguousOrRectangular.sort()) {
  60. const area = areas.find((a) => a.values.includes(name));
  61. assert(area);
  62. complain(messages.expectedRectangle(name), area.index, area.endIndex);
  63. }
  64. /**
  65. * @param {string} message
  66. * @param {number} index
  67. * @param {number} endIndex
  68. */
  69. function complain(message, index, endIndex) {
  70. const start = declarationValueIndex(decl);
  71. report({
  72. message,
  73. node: decl,
  74. index: start + index,
  75. endIndex: start + endIndex,
  76. result,
  77. ruleName,
  78. });
  79. }
  80. });
  81. };
  82. };
  83. rule.ruleName = ruleName;
  84. rule.messages = messages;
  85. rule.meta = meta;
  86. module.exports = rule;