stylelint-value-no-exposed-custom-properties/index.es.mjs.map

A stylelint rule to disallow usage of exposed custom properties

{"version":3,"file":"index.es.mjs","sources":["lib/get-custom-properties-from-root.js","lib/get-custom-properties-from-imports.js","index.js"],"sourcesContent":["// return custom selectors from the css root, conditionally removing them\nexport default (root) => {\n  // initialize custom selectors\n  const customProperties = {}\n\n  // for each custom property declaration\n  root.walkDecls(customPropertyRegExp, (decl) => {\n    const { prop } = decl\n\n    // write the parsed value to the custom property\n    customProperties[prop] = decl.value\n  })\n\n  // return all custom properties, preferring :root properties over html properties\n  return customProperties\n}\n\n// match custom properties\nconst customPropertyRegExp = /^--[A-z][\\w-]*$/\n","import fs from 'fs'\nimport path from 'path'\nimport postcss from 'postcss'\nimport getCustomPropertiesFromRoot from './get-custom-properties-from-root'\n\n/* Get Custom Properties from CSS File\n/* ========================================================================== */\n\nasync function getCustomPropertiesFromCSSFile(from) {\n  const css = await readFile(from)\n  const root = postcss.parse(css, { from })\n\n  return getCustomPropertiesFromRoot(root)\n}\n\n/* Get Custom Properties from Object\n/* ========================================================================== */\n\nfunction getCustomPropertiesFromObject(object) {\n  const customProperties = Object.assign(\n    {},\n    Object(object).customProperties,\n    Object(object)['custom-properties']\n  )\n\n  return customProperties\n}\n\n/* Get Custom Properties from JSON file\n/* ========================================================================== */\n\nasync function getCustomPropertiesFromJSONFile(from) {\n  const object = await readJSON(from)\n\n  return getCustomPropertiesFromObject(object)\n}\n\n/* Get Custom Properties from JS file\n/* ========================================================================== */\n\nasync function getCustomPropertiesFromJSFile(from) {\n  const object = await import(from)\n\n  return getCustomPropertiesFromObject(object)\n}\n\n/* Get Custom Properties from Sources\n/* ========================================================================== */\n\nexport default function getCustomPropertiesFromSources(sources) {\n  return sources\n    .map((source) => {\n      if (source instanceof Promise) {\n        return source\n      } else if (source instanceof Function) {\n        return source()\n      }\n\n      // read the source as an object\n      const opts = source === Object(source) ? source : { from: String(source) }\n\n      // skip objects with Custom Properties\n      if (opts.customProperties || opts['custom-properties']) {\n        return opts\n      }\n\n      // source pathname\n      const from = path.resolve(String(opts.from || ''))\n\n      // type of file being read from\n      const type = (opts.type || path.extname(from).slice(1)).toLowerCase()\n\n      return { type, from }\n    })\n    .reduce(async (customProperties, source) => {\n      const { type, from } = await source\n\n      if (type === 'css') {\n        return Object.assign(\n          await customProperties,\n          await getCustomPropertiesFromCSSFile(from)\n        )\n      }\n\n      if (type === 'js') {\n        return Object.assign(\n          await customProperties,\n          await getCustomPropertiesFromJSFile(from)\n        )\n      }\n\n      if (type === 'json') {\n        return Object.assign(\n          await customProperties,\n          await getCustomPropertiesFromJSONFile(from)\n        )\n      }\n\n      return Object.assign(\n        await customProperties,\n        await getCustomPropertiesFromObject(await source)\n      )\n    }, {})\n}\n\n/* Promise-ified utilities\n/* ========================================================================== */\n\nconst readFile = (from) =>\n  new Promise((resolve, reject) => {\n    fs.readFile(from, 'utf8', (error, result) => {\n      if (error) {\n        reject(error)\n      } else {\n        resolve(result)\n      }\n    })\n  })\n\nconst readJSON = async (from) => JSON.parse(await readFile(from))\n","import stylelint from 'stylelint'\nimport getCustomPropertiesFromRoot from './lib/get-custom-properties-from-root'\nimport getCustomPropertiesFromImports from './lib/get-custom-properties-from-imports'\n\nconst ruleName = 'plugin/value-no-exposed-custom-properties'\n\nfunction isCustomPropertyDecl(prop) {\n  return prop.includes('--')\n}\n\nfunction prepareValue(value) {\n  if (typeof value === 'string') {\n    value = value.toUpperCase()\n  }\n\n  return value\n}\n\nfunction foundCustomPropertyInValue(properies, value) {\n  value = prepareValue(value)\n\n  for (let i in properies) {\n    const property = prepareValue(properies[i])\n\n    if (value.includes(property)) return i\n  }\n}\n\nasync function getCustomProperties(root, importFrom) {\n  // all custom properties from the file and imports\n  return Object.assign(\n    {},\n    await getCustomPropertiesFromImports(importFrom),\n    getCustomPropertiesFromRoot(root)\n  )\n}\n\nfunction checkDeclOnCustomProperty(decl, customProperties, result) {\n  const foundVariable = foundCustomPropertyInValue(customProperties, decl.value)\n\n  if (foundVariable) {\n    stylelint.utils.report({\n      ruleName,\n      result,\n      node: decl,\n      message:\n        'The value (or a part of it) should be presented as a custom property: \"' +\n        decl.value +\n        '\" is \"' +\n        foundVariable +\n        '\" (' +\n        ruleName +\n        ')',\n    })\n  }\n}\n\nmodule.exports = stylelint.createPlugin(ruleName, function (method, options) {\n  return async function (root, result) {\n    if (!method) return\n\n    const importFrom = options && options.importFrom ? options.importFrom : []\n    const customProperties = await getCustomProperties(root, importFrom)\n\n    root.walkRules(function (rule) {\n      rule.walkDecls(function (decl) {\n        // Skip custom properties declarations\n        if (!isCustomPropertyDecl(decl.prop)) {\n          checkDeclOnCustomProperty(decl, customProperties, result)\n        }\n      })\n    })\n  }\n})\n"],"names":["root","customProperties","walkDecls","customPropertyRegExp","decl","prop","value","getCustomPropertiesFromCSSFile","from","css","readFile","postcss","parse","getCustomPropertiesFromRoot","getCustomPropertiesFromObject","object","Object","assign","getCustomPropertiesFromJSONFile","readJSON","getCustomPropertiesFromJSFile","getCustomPropertiesFromSources","sources","map","source","Promise","Function","opts","String","path","resolve","type","extname","slice","toLowerCase","reduce","reject","fs","error","result","JSON","ruleName","isCustomPropertyDecl","includes","prepareValue","toUpperCase","foundCustomPropertyInValue","properies","i","property","getCustomProperties","importFrom","getCustomPropertiesFromImports","checkDeclOnCustomProperty","foundVariable","stylelint","utils","report","node","message","module","exports","createPlugin","method","options","walkRules","rule"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AACA,mCAAgBA,IAAD,IAAU;;EAEvB,MAAMC,gBAAgB,GAAG,EAAzB,CAFuB;;EAKvBD,IAAI,CAACE,SAAL,CAAeC,oBAAf,EAAsCC,IAAD,IAAU;IAC7C,MAAQC,IAAR,GAAiBD,IAAjB,CAAQC,IAAR,CAD6C;;IAI7CJ,gBAAgB,CAACI,IAAD,CAAhB,GAAyBD,IAAI,CAACE,KAA9B;GAJF,EALuB;;EAavB,OAAOL,gBAAP;CAbF;;AAiBA,MAAME,oBAAoB,GAAG,iBAA7B;;ACbA;;;SAGeI;;;;;;;;sDAAf,WAA8CC,IAA9C,EAAoD;IAClD,MAAMC,GAAG,SAASC,QAAQ,CAACF,IAAD,CAA1B;IACA,MAAMR,IAAI,GAAGW,OAAO,CAACC,KAAR,CAAcH,GAAd,EAAmB;MAAED;KAArB,CAAb;IAEA,OAAOK,2BAA2B,CAACb,IAAD,CAAlC;;;;;AAMF,SAASc,6BAAT,CAAuCC,MAAvC,EAA+C;EAC7C,MAAMd,gBAAgB,GAAGe,MAAM,CAACC,MAAP,CACvB,EADuB,EAEvBD,MAAM,CAACD,MAAD,CAAN,CAAed,gBAFQ,EAGvBe,MAAM,CAACD,MAAD,CAAN,CAAe,mBAAf,CAHuB,CAAzB;EAMA,OAAOd,gBAAP;;;;;;SAMaiB;;;;;;;;uDAAf,WAA+CV,IAA/C,EAAqD;IACnD,MAAMO,MAAM,SAASI,QAAQ,CAACX,IAAD,CAA7B;IAEA,OAAOM,6BAA6B,CAACC,MAAD,CAApC;;;;;SAMaK;;;;;;;;qDAAf,WAA6CZ,IAA7C,EAAmD;IACjD,MAAMO,MAAM,SAAS,OAAOP,IAAP,CAArB;IAEA,OAAOM,6BAA6B,CAACC,MAAD,CAApC;;;;;AAMF,AAAe,SAASM,8BAAT,CAAwCC,OAAxC,EAAiD;EAC9D,OAAOA,OAAO,CACXC,GADI,CACCC,MAAD,IAAY;IACf,IAAIA,MAAM,YAAYC,OAAtB,EAA+B;MAC7B,OAAOD,MAAP;KADF,MAEO,IAAIA,MAAM,YAAYE,QAAtB,EAAgC;MACrC,OAAOF,MAAM,EAAb;KAJa;;;IAQf,MAAMG,IAAI,GAAGH,MAAM,KAAKR,MAAM,CAACQ,MAAD,CAAjB,GAA4BA,MAA5B,GAAqC;MAAEhB,IAAI,EAAEoB,MAAM,CAACJ,MAAD;KAAhE,CARe;;IAWf,IAAIG,IAAI,CAAC1B,gBAAL,IAAyB0B,IAAI,CAAC,mBAAD,CAAjC,EAAwD;MACtD,OAAOA,IAAP;KAZa;;;IAgBf,MAAMnB,IAAI,GAAGqB,IAAI,CAACC,OAAL,CAAaF,MAAM,CAACD,IAAI,CAACnB,IAAL,IAAa,EAAd,CAAnB,CAAb,CAhBe;;IAmBf,MAAMuB,IAAI,GAAG,CAACJ,IAAI,CAACI,IAAL,IAAaF,IAAI,CAACG,OAAL,CAAaxB,IAAb,EAAmByB,KAAnB,CAAyB,CAAzB,CAAd,EAA2CC,WAA3C,EAAb;IAEA,OAAO;MAAEH,IAAF;MAAQvB;KAAf;GAtBG,EAwBJ2B,MAxBI;IAAA,6BAwBG,WAAOlC,gBAAP,EAAyBuB,MAAzB,EAAoC;MAC1C,4BAA6BA,MAA7B;YAAQO,IAAR,iBAAQA,IAAR;YAAcvB,IAAd,iBAAcA,IAAd;;MAEA,IAAIuB,IAAI,KAAK,KAAb,EAAoB;QAClB,OAAOf,MAAM,CAACC,MAAP,OACChB,gBADD,QAECM,8BAA8B,CAACC,IAAD,CAF/B,CAAP;;;MAMF,IAAIuB,IAAI,KAAK,IAAb,EAAmB;QACjB,OAAOf,MAAM,CAACC,MAAP,OACChB,gBADD,QAECmB,6BAA6B,CAACZ,IAAD,CAF9B,CAAP;;;MAMF,IAAIuB,IAAI,KAAK,MAAb,EAAqB;QACnB,OAAOf,MAAM,CAACC,MAAP,OACChB,gBADD,QAECiB,+BAA+B,CAACV,IAAD,CAFhC,CAAP;;;MAMF,OAAOQ,MAAM,CAACC,MAAP,OACChB,gBADD,QAECa,6BAA6B,OAAOU,MAAP,CAF9B,CAAP;KAhDG;;IAAA;MAAA;;OAoDF,EApDE,CAAP;;;;;AA0DF,MAAMd,QAAQ,GAAIF,IAAD,IACf,IAAIiB,OAAJ,CAAY,CAACK,OAAD,EAAUM,MAAV,KAAqB;EAC/BC,EAAE,CAAC3B,QAAH,CAAYF,IAAZ,EAAkB,MAAlB,EAA0B,CAAC8B,KAAD,EAAQC,MAAR,KAAmB;IAC3C,IAAID,KAAJ,EAAW;MACTF,MAAM,CAACE,KAAD,CAAN;KADF,MAEO;MACLR,OAAO,CAACS,MAAD,CAAP;;GAJJ;CADF,CADF;;AAWA,MAAMpB,QAAQ;EAAA,8BAAG,WAAOX,IAAP;IAAA,OAAgBgC,IAAI,CAAC5B,KAAL,OAAiBF,QAAQ,CAACF,IAAD,CAAzB,CAAhB;GAAH;;EAAA,gBAARW,QAAQ;IAAA;;GAAd;;ACnHA,MAAMsB,QAAQ,GAAG,2CAAjB;;AAEA,SAASC,oBAAT,CAA8BrC,IAA9B,EAAoC;EAClC,OAAOA,IAAI,CAACsC,QAAL,CAAc,IAAd,CAAP;;;AAGF,SAASC,YAAT,CAAsBtC,KAAtB,EAA6B;EAC3B,IAAI,OAAOA,KAAP,KAAiB,QAArB,EAA+B;IAC7BA,KAAK,GAAGA,KAAK,CAACuC,WAAN,EAAR;;;EAGF,OAAOvC,KAAP;;;AAGF,SAASwC,0BAAT,CAAoCC,SAApC,EAA+CzC,KAA/C,EAAsD;EACpDA,KAAK,GAAGsC,YAAY,CAACtC,KAAD,CAApB;;EAEA,KAAK,IAAI0C,CAAT,IAAcD,SAAd,EAAyB;IACvB,MAAME,QAAQ,GAAGL,YAAY,CAACG,SAAS,CAACC,CAAD,CAAV,CAA7B;IAEA,IAAI1C,KAAK,CAACqC,QAAN,CAAeM,QAAf,CAAJ,EAA8B,OAAOD,CAAP;;;;SAInBE;;;;;2CAAf,WAAmClD,IAAnC,EAAyCmD,UAAzC,EAAqD;;IAEnD,OAAOnC,MAAM,CAACC,MAAP,CACL,EADK,QAECmC,8BAA8B,CAACD,UAAD,CAF/B,EAGLtC,2BAA2B,CAACb,IAAD,CAHtB,CAAP;;;;;AAOF,SAASqD,yBAAT,CAAmCjD,IAAnC,EAAyCH,gBAAzC,EAA2DsC,MAA3D,EAAmE;EACjE,MAAMe,aAAa,GAAGR,0BAA0B,CAAC7C,gBAAD,EAAmBG,IAAI,CAACE,KAAxB,CAAhD;;EAEA,IAAIgD,aAAJ,EAAmB;IACjBC,SAAS,CAACC,KAAV,CAAgBC,MAAhB,CAAuB;MACrBhB,QADqB;MAErBF,MAFqB;MAGrBmB,IAAI,EAAEtD,IAHe;MAIrBuD,OAAO,EACL,4EACAvD,IAAI,CAACE,KADL,GAEA,QAFA,GAGAgD,aAHA,GAIA,KAJA,GAKAb,QALA,GAMA;KAXJ;;;;AAgBJmB,MAAM,CAACC,OAAP,GAAiBN,SAAS,CAACO,YAAV,CAAuBrB,QAAvB,EAAiC,UAAUsB,MAAV,EAAkBC,OAAlB,EAA2B;EAC3E;IAAA,6BAAO,WAAgBhE,IAAhB,EAAsBuC,MAAtB,EAA8B;MACnC,IAAI,CAACwB,MAAL,EAAa;MAEb,MAAMZ,UAAU,GAAGa,OAAO,IAAIA,OAAO,CAACb,UAAnB,GAAgCa,OAAO,CAACb,UAAxC,GAAqD,EAAxE;MACA,MAAMlD,gBAAgB,SAASiD,mBAAmB,CAAClD,IAAD,EAAOmD,UAAP,CAAlD;MAEAnD,IAAI,CAACiE,SAAL,CAAe,UAAUC,IAAV,EAAgB;QAC7BA,IAAI,CAAChE,SAAL,CAAe,UAAUE,IAAV,EAAgB;;UAE7B,IAAI,CAACsC,oBAAoB,CAACtC,IAAI,CAACC,IAAN,CAAzB,EAAsC;YACpCgD,yBAAyB,CAACjD,IAAD,EAAOH,gBAAP,EAAyBsC,MAAzB,CAAzB;;SAHJ;OADF;KANF;;IAAA;MAAA;;;CADe,CAAjB"}