index.js 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. 'use strict';
  2. const valueParser = require('postcss-value-parser');
  3. const report = require('../../utils/report');
  4. const ruleMessages = require('../../utils/ruleMessages');
  5. const validateOptions = require('../../utils/validateOptions');
  6. const setAtRuleParams = require('../../utils/setAtRuleParams');
  7. const getAtRuleParams = require('../../utils/getAtRuleParams');
  8. const atRuleParamIndex = require('../../utils/atRuleParamIndex');
  9. const ruleName = 'import-notation';
  10. const messages = ruleMessages(ruleName, {
  11. expected: (unfixed, fixed) => `Expected "${unfixed}" to be "${fixed}"`,
  12. });
  13. const meta = {
  14. url: 'https://stylelint.io/user-guide/rules/list/import-notation',
  15. fixable: true,
  16. };
  17. /** @type {import('stylelint').Rule} */
  18. const rule = (primary, _, context) => {
  19. return (root, result) => {
  20. const validOptions = validateOptions(result, ruleName, {
  21. actual: primary,
  22. possible: ['string', 'url'],
  23. });
  24. if (!validOptions) {
  25. return;
  26. }
  27. root.walkAtRules(/^import$/i, checkAtRuleImportParams);
  28. /**
  29. * @param {import('postcss').AtRule} atRule
  30. */
  31. function checkAtRuleImportParams(atRule) {
  32. const params = getAtRuleParams(atRule);
  33. const parsed = valueParser(params);
  34. for (const node of parsed.nodes) {
  35. const start = atRuleParamIndex(atRule);
  36. const end = start + node.sourceEndIndex;
  37. if (primary === 'string') {
  38. if (node.type === 'function' && node.value.toLowerCase() === 'url') {
  39. const urlFunctionFull = valueParser.stringify(node);
  40. const urlFunctionArguments = valueParser.stringify(node.nodes);
  41. const quotedUrlFunctionFirstArgument =
  42. node.nodes[0] && node.nodes[0].type === 'word'
  43. ? `"${urlFunctionArguments}"`
  44. : urlFunctionArguments;
  45. if (context.fix) {
  46. const restAtRuleParams = atRule.params.slice(node.sourceEndIndex);
  47. setAtRuleParams(atRule, `${quotedUrlFunctionFirstArgument}${restAtRuleParams}`);
  48. return;
  49. }
  50. complain(
  51. messages.expected(urlFunctionFull, quotedUrlFunctionFirstArgument),
  52. atRule,
  53. start,
  54. end,
  55. );
  56. return;
  57. }
  58. }
  59. if (primary === 'url') {
  60. if (node.type === 'space') return;
  61. if (node.type === 'word' || node.type === 'string') {
  62. const path = valueParser.stringify(node);
  63. const urlFunctionFull = `url(${path})`;
  64. if (context.fix) {
  65. const restAtRuleParams = atRule.params.slice(node.sourceEndIndex);
  66. setAtRuleParams(atRule, `${urlFunctionFull}${restAtRuleParams}`);
  67. return;
  68. }
  69. const quotedNodeValue =
  70. node.type === 'word' ? `"${node.value}"` : `${node.quote}${node.value}${node.quote}`;
  71. complain(messages.expected(quotedNodeValue, urlFunctionFull), atRule, start, end);
  72. return;
  73. }
  74. }
  75. }
  76. }
  77. /**
  78. * @param {string} message
  79. * @param {import('postcss').Node} node
  80. * @param {number} index
  81. * @param {number} endIndex
  82. */
  83. function complain(message, node, index, endIndex) {
  84. report({
  85. message,
  86. node,
  87. index,
  88. endIndex,
  89. result,
  90. ruleName,
  91. });
  92. }
  93. };
  94. };
  95. rule.ruleName = ruleName;
  96. rule.messages = messages;
  97. rule.meta = meta;
  98. module.exports = rule;