index.js 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. 'use strict';
  2. const valueParser = require('postcss-value-parser');
  3. const getDeclarationValue = require('../../utils/getDeclarationValue');
  4. const isStandardSyntaxValue = require('../../utils/isStandardSyntaxValue');
  5. const optionsMatches = require('../../utils/optionsMatches');
  6. const report = require('../../utils/report');
  7. const ruleMessages = require('../../utils/ruleMessages');
  8. const validateOptions = require('../../utils/validateOptions');
  9. const { isRegExp, isString } = require('../../utils/validateTypes');
  10. const ruleName = 'annotation-no-unknown';
  11. const messages = ruleMessages(ruleName, {
  12. rejected: (annotation) => `Unexpected unknown annotation "${annotation}"`,
  13. });
  14. const meta = {
  15. url: 'https://stylelint.io/user-guide/rules/annotation-no-unknown',
  16. };
  17. /** @type {import('stylelint').Rule} */
  18. const rule = (primary, secondaryOptions) => {
  19. return (root, result) => {
  20. const validOptions = validateOptions(
  21. result,
  22. ruleName,
  23. { actual: primary },
  24. {
  25. actual: secondaryOptions,
  26. possible: {
  27. ignoreAnnotations: [isString, isRegExp],
  28. },
  29. optional: true,
  30. },
  31. );
  32. if (!validOptions) {
  33. return;
  34. }
  35. root.walkDecls(checkStatement);
  36. /**
  37. * @param {import('postcss').Declaration} decl
  38. */
  39. function checkStatement(decl) {
  40. if (!isStandardSyntaxValue(decl.value)) return;
  41. if (decl.important) return;
  42. if (!decl.value.includes('!')) return;
  43. const parsedValue = valueParser(getDeclarationValue(decl));
  44. parsedValue.walk((node) => {
  45. if (!isAnnotation(node)) return;
  46. const value = node.value;
  47. const tokenValue = value.slice(1);
  48. if (optionsMatches(secondaryOptions, 'ignoreAnnotations', tokenValue)) {
  49. return;
  50. }
  51. report({
  52. message: messages.rejected,
  53. messageArgs: [value],
  54. node: decl,
  55. result,
  56. ruleName,
  57. word: value,
  58. });
  59. });
  60. }
  61. /**
  62. * @param {valueParser.Node} node
  63. */
  64. function isAnnotation(node) {
  65. return node.type === 'word' && node.value.startsWith('!');
  66. }
  67. };
  68. };
  69. rule.ruleName = ruleName;
  70. rule.messages = messages;
  71. rule.meta = meta;
  72. module.exports = rule;