dynamic-import-chunkname.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  1. 'use strict';
  2. var _vm = require('vm');
  3. var _vm2 = _interopRequireDefault(_vm);
  4. var _docsUrl = require('../docsUrl');
  5. var _docsUrl2 = _interopRequireDefault(_docsUrl);
  6. function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
  7. module.exports = {
  8. meta: {
  9. type: 'suggestion',
  10. docs: {
  11. url: (0, _docsUrl2.default)('dynamic-import-chunkname')
  12. },
  13. schema: [{
  14. type: 'object',
  15. properties: {
  16. importFunctions: {
  17. type: 'array',
  18. uniqueItems: true,
  19. items: {
  20. type: 'string'
  21. }
  22. },
  23. webpackChunknameFormat: {
  24. type: 'string'
  25. }
  26. }
  27. }]
  28. },
  29. create: function (context) {
  30. const config = context.options[0];
  31. var _ref = config || {},
  32. _ref$importFunctions = _ref.importFunctions;
  33. const importFunctions = _ref$importFunctions === undefined ? [] : _ref$importFunctions;
  34. var _ref2 = config || {},
  35. _ref2$webpackChunknam = _ref2.webpackChunknameFormat;
  36. const webpackChunknameFormat = _ref2$webpackChunknam === undefined ? '[0-9a-zA-Z-_/.]+' : _ref2$webpackChunknam;
  37. const paddedCommentRegex = /^ (\S[\s\S]+\S) $/;
  38. const commentStyleRegex = /^( \w+: ("[^"]*"|\d+|false|true),?)+ $/;
  39. const chunkSubstrFormat = ` webpackChunkName: "${webpackChunknameFormat}",? `;
  40. const chunkSubstrRegex = new RegExp(chunkSubstrFormat);
  41. return {
  42. CallExpression(node) {
  43. if (node.callee.type !== 'Import' && importFunctions.indexOf(node.callee.name) < 0) {
  44. return;
  45. }
  46. const sourceCode = context.getSourceCode();
  47. const arg = node.arguments[0];
  48. const leadingComments = sourceCode.getCommentsBefore ? sourceCode.getCommentsBefore(arg) // This method is available in ESLint >= 4.
  49. : sourceCode.getComments(arg).leading; // This method is deprecated in ESLint 7.
  50. if (!leadingComments || leadingComments.length === 0) {
  51. context.report({
  52. node,
  53. message: 'dynamic imports require a leading comment with the webpack chunkname'
  54. });
  55. return;
  56. }
  57. let isChunknamePresent = false;
  58. for (const comment of leadingComments) {
  59. if (comment.type !== 'Block') {
  60. context.report({
  61. node,
  62. message: 'dynamic imports require a /* foo */ style comment, not a // foo comment'
  63. });
  64. return;
  65. }
  66. if (!paddedCommentRegex.test(comment.value)) {
  67. context.report({
  68. node,
  69. message: `dynamic imports require a block comment padded with spaces - /* foo */`
  70. });
  71. return;
  72. }
  73. try {
  74. // just like webpack itself does
  75. _vm2.default.runInNewContext(`(function(){return {${comment.value}}})()`);
  76. } catch (error) {
  77. context.report({
  78. node,
  79. message: `dynamic imports require a "webpack" comment with valid syntax`
  80. });
  81. return;
  82. }
  83. if (!commentStyleRegex.test(comment.value)) {
  84. context.report({
  85. node,
  86. message: `dynamic imports require a leading comment in the form /*${chunkSubstrFormat}*/`
  87. });
  88. return;
  89. }
  90. if (chunkSubstrRegex.test(comment.value)) {
  91. isChunknamePresent = true;
  92. }
  93. }
  94. if (!isChunknamePresent) {
  95. context.report({
  96. node,
  97. message: `dynamic imports require a leading comment in the form /*${chunkSubstrFormat}*/`
  98. });
  99. }
  100. }
  101. };
  102. }
  103. };
  104. //# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"sources":["../../src/rules/dynamic-import-chunkname.js"],"names":["module","exports","meta","type","docs","url","schema","properties","importFunctions","uniqueItems","items","webpackChunknameFormat","create","context","config","options","paddedCommentRegex","commentStyleRegex","chunkSubstrFormat","chunkSubstrRegex","RegExp","CallExpression","node","callee","indexOf","name","sourceCode","getSourceCode","arg","arguments","leadingComments","getCommentsBefore","getComments","leading","length","report","message","isChunknamePresent","comment","test","value","vm","runInNewContext","error"],"mappings":";;AAAA;;;;AACA;;;;;;AAEAA,OAAOC,OAAP,GAAiB;AACfC,QAAM;AACJC,UAAM,YADF;AAEJC,UAAM;AACJC,WAAK,uBAAQ,0BAAR;AADD,KAFF;AAKJC,YAAQ,CAAC;AACPH,YAAM,QADC;AAEPI,kBAAY;AACVC,yBAAiB;AACfL,gBAAM,OADS;AAEfM,uBAAa,IAFE;AAGfC,iBAAO;AACLP,kBAAM;AADD;AAHQ,SADP;AAQVQ,gCAAwB;AACtBR,gBAAM;AADgB;AARd;AAFL,KAAD;AALJ,GADS;;AAuBfS,UAAQ,UAAUC,OAAV,EAAmB;AACzB,UAAMC,SAASD,QAAQE,OAAR,CAAgB,CAAhB,CAAf;;AADyB,eAEQD,UAAU,EAFlB;AAAA,oCAEjBN,eAFiB;;AAAA,UAEjBA,eAFiB,wCAEC,EAFD;;AAAA,gBAG+BM,UAAU,EAHzC;AAAA,sCAGjBH,sBAHiB;;AAAA,UAGjBA,sBAHiB,yCAGQ,kBAHR;;;AAKzB,UAAMK,qBAAqB,mBAA3B;AACA,UAAMC,oBAAoB,wCAA1B;AACA,UAAMC,oBAAqB,uBAAsBP,sBAAuB,MAAxE;AACA,UAAMQ,mBAAmB,IAAIC,MAAJ,CAAWF,iBAAX,CAAzB;;AAEA,WAAO;AACLG,qBAAeC,IAAf,EAAqB;AACnB,YAAIA,KAAKC,MAAL,CAAYpB,IAAZ,KAAqB,QAArB,IAAiCK,gBAAgBgB,OAAhB,CAAwBF,KAAKC,MAAL,CAAYE,IAApC,IAA4C,CAAjF,EAAoF;AAClF;AACD;;AAED,cAAMC,aAAab,QAAQc,aAAR,EAAnB;AACA,cAAMC,MAAMN,KAAKO,SAAL,CAAe,CAAf,CAAZ;AACA,cAAMC,kBAAkBJ,WAAWK,iBAAX,GACpBL,WAAWK,iBAAX,CAA6BH,GAA7B,CADoB,CACc;AADd,UAEpBF,WAAWM,WAAX,CAAuBJ,GAAvB,EAA4BK,OAFhC,CAPmB,CASqB;;AAExC,YAAI,CAACH,eAAD,IAAoBA,gBAAgBI,MAAhB,KAA2B,CAAnD,EAAsD;AACpDrB,kBAAQsB,MAAR,CAAe;AACbb,gBADa;AAEbc,qBAAS;AAFI,WAAf;AAIA;AACD;;AAED,YAAIC,qBAAqB,KAAzB;;AAEA,aAAK,MAAMC,OAAX,IAAsBR,eAAtB,EAAuC;AACrC,cAAIQ,QAAQnC,IAAR,KAAiB,OAArB,EAA8B;AAC5BU,oBAAQsB,MAAR,CAAe;AACbb,kBADa;AAEbc,uBAAS;AAFI,aAAf;AAIA;AACD;;AAED,cAAI,CAACpB,mBAAmBuB,IAAnB,CAAwBD,QAAQE,KAAhC,CAAL,EAA6C;AAC3C3B,oBAAQsB,MAAR,CAAe;AACbb,kBADa;AAEbc,uBAAU;AAFG,aAAf;AAIA;AACD;;AAED,cAAI;AACF;AACAK,yBAAGC,eAAH,CAAoB,uBAAsBJ,QAAQE,KAAM,OAAxD;AACD,WAHD,CAIA,OAAOG,KAAP,EAAc;AACZ9B,oBAAQsB,MAAR,CAAe;AACbb,kBADa;AAEbc,uBAAU;AAFG,aAAf;AAIA;AACD;;AAED,cAAI,CAACnB,kBAAkBsB,IAAlB,CAAuBD,QAAQE,KAA/B,CAAL,EAA4C;AAC1C3B,oBAAQsB,MAAR,CAAe;AACbb,kBADa;AAEbc,uBACG,2DAA0DlB,iBAAkB;AAHlE,aAAf;AAKA;AACD;;AAED,cAAIC,iBAAiBoB,IAAjB,CAAsBD,QAAQE,KAA9B,CAAJ,EAA0C;AACxCH,iCAAqB,IAArB;AACD;AACF;;AAED,YAAI,CAACA,kBAAL,EAAyB;AACvBxB,kBAAQsB,MAAR,CAAe;AACbb,gBADa;AAEbc,qBACG,2DAA0DlB,iBAAkB;AAHlE,WAAf;AAKD;AACF;AAxEI,KAAP;AA0ED;AA3Gc,CAAjB","file":"dynamic-import-chunkname.js","sourcesContent":["import vm from 'vm'\nimport docsUrl from '../docsUrl'\n\nmodule.exports = {\n  meta: {\n    type: 'suggestion',\n    docs: {\n      url: docsUrl('dynamic-import-chunkname'),\n    },\n    schema: [{\n      type: 'object',\n      properties: {\n        importFunctions: {\n          type: 'array',\n          uniqueItems: true,\n          items: {\n            type: 'string',\n          },\n        },\n        webpackChunknameFormat: {\n          type: 'string',\n        },\n      },\n    }],\n  },\n\n  create: function (context) {\n    const config = context.options[0]\n    const { importFunctions = [] } = config || {}\n    const { webpackChunknameFormat = '[0-9a-zA-Z-_/.]+' } = config || {}\n\n    const paddedCommentRegex = /^ (\\S[\\s\\S]+\\S) $/\n    const commentStyleRegex = /^( \\w+: (\"[^\"]*\"|\\d+|false|true),?)+ $/\n    const chunkSubstrFormat = ` webpackChunkName: \"${webpackChunknameFormat}\",? `\n    const chunkSubstrRegex = new RegExp(chunkSubstrFormat)\n\n    return {\n      CallExpression(node) {\n        if (node.callee.type !== 'Import' && importFunctions.indexOf(node.callee.name) < 0) {\n          return\n        }\n\n        const sourceCode = context.getSourceCode()\n        const arg = node.arguments[0]\n        const leadingComments = sourceCode.getCommentsBefore\n          ? sourceCode.getCommentsBefore(arg) // This method is available in ESLint >= 4.\n          : sourceCode.getComments(arg).leading // This method is deprecated in ESLint 7.\n\n        if (!leadingComments || leadingComments.length === 0) {\n          context.report({\n            node,\n            message: 'dynamic imports require a leading comment with the webpack chunkname',\n          })\n          return\n        }\n\n        let isChunknamePresent = false\n\n        for (const comment of leadingComments) {\n          if (comment.type !== 'Block') {\n            context.report({\n              node,\n              message: 'dynamic imports require a /* foo */ style comment, not a // foo comment',\n            })\n            return\n          }\n\n          if (!paddedCommentRegex.test(comment.value)) {\n            context.report({\n              node,\n              message: `dynamic imports require a block comment padded with spaces - /* foo */`,\n            })\n            return\n          }\n\n          try {\n            // just like webpack itself does\n            vm.runInNewContext(`(function(){return {${comment.value}}})()`)\n          }\n          catch (error) {\n            context.report({\n              node,\n              message: `dynamic imports require a \"webpack\" comment with valid syntax`,\n            })\n            return\n          }\n\n          if (!commentStyleRegex.test(comment.value)) {\n            context.report({\n              node,\n              message:\n                `dynamic imports require a leading comment in the form /*${chunkSubstrFormat}*/`,\n            })\n            return\n          }\n\n          if (chunkSubstrRegex.test(comment.value)) {\n            isChunknamePresent = true\n          }\n        }\n\n        if (!isChunknamePresent) {\n          context.report({\n            node,\n            message:\n              `dynamic imports require a leading comment in the form /*${chunkSubstrFormat}*/`,\n          })\n        }\n      },\n    }\n  },\n}\n"]}