#28399278

Build Type

push

Committed by

Commit Message

<a href="https://github.com/benmosher/eslint-plugin-import/commit/<a class=hub.com/benmosher/eslint-plugin-import/commit/c7594bb3de6cddd61d9c27f68d019670cf8a2b09">c7594bb3d<a href="https://github.com/benmosher/eslint-plugin-import/commit/c7594bb3de6cddd61d9c27f68d019670cf8a2b09">">Merge </a><a class="double-link" href="https://github.com/benmosher/eslint-plugin-import/commit/<a class="double-link" href="https://github.com/benmosher/eslint-plugin-import/commit/36430c7debddc4450157f757a42c8ec437123289">36430c7de</a>">36430c7de</a><a href="https://github.com/benmosher/eslint-plugin-import/commit/c7594bb3de6cddd61d9c27f68d019670cf8a2b09"> into 397b6c5f4">397b6c5f4</a>

Run Details

1617 of 1850 branches covered (87.41%)

2045 of 2570 relevant lines covered (79.57%)

123.98 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

92.73

/src/rules/dynamic-import-chunkname.js

import vm from 'vm';
import docsUrl from '../docsUrl';

module.exports = {
  meta: {
    type: 'suggestion',
    docs: {
      url: docsUrl('dynamic-import-chunkname'),
    },
    schema: [{
      type: 'object',
      properties: {
        importFunctions: {
          type: 'array',
          uniqueItems: true,
          items: {
            type: 'string',
          },
        },
        webpackChunknameFormat: {
          type: 'string',
        },
      },
    }],
  },

  create(context) {
    const config = context.options[0];
    const { importFunctions = [] } = config || {};
    const { webpackChunknameFormat = '[0-9a-zA-Z-_/.]+' } = config || {};

    const paddedCommentRegex = /^ (\S[\s\S]+\S) $/;
    const commentStyleRegex = /^( \w+: (["'][^"']*["']|\d+|false|true),?)+ $/;
    const chunkSubstrFormat = ` webpackChunkName: ["']${webpackChunknameFormat}["'],? `;
    const chunkSubstrRegex = new RegExp(chunkSubstrFormat);

    function run(node, arg) {
      const sourceCode = context.getSourceCode();
      const leadingComments = sourceCode.getCommentsBefore
        ? sourceCode.getCommentsBefore(arg) // This method is available in ESLint >= 4.
        : sourceCode.getComments(arg).leading; // This method is deprecated in ESLint 7.

      if (!leadingComments || leadingComments.length === 0) {
        context.report({
          node,
          message: 'dynamic imports require a leading comment with the webpack chunkname',
        });
        return;
      }

      let isChunknamePresent = false;

      for (const comment of leadingComments) {
        if (comment.type !== 'Block') {
          context.report({
            node,
            message: 'dynamic imports require a /* foo */ style comment, not a // foo comment',
          });
          return;
        }

        if (!paddedCommentRegex.test(comment.value)) {
          context.report({
            node,
            message: `dynamic imports require a block comment padded with spaces - /* foo */`,
          });
          return;
        }

        try {
          // just like webpack itself does
          vm.runInNewContext(`(function() {return {${comment.value}}})()`);
        }
        catch (error) {
          context.report({
            node,
            message: `dynamic imports require a "webpack" comment with valid syntax`,
          });
          return;
        }

        if (!commentStyleRegex.test(comment.value)) {
          context.report({
            node,
            message:
              `dynamic imports require a leading comment in the form /*${chunkSubstrFormat}*/`,
          });
          return;
        }

        if (chunkSubstrRegex.test(comment.value)) {
          isChunknamePresent = true;
        }
      }

      if (!isChunknamePresent) {
        context.report({
          node,
          message:
            `dynamic imports require a leading comment in the form /*${chunkSubstrFormat}*/`,
        });
      }
    }

    return {
      ImportExpression(node) {
        run(node, node.source);
      },

      CallExpression(node) {
        if (node.callee.type !== 'Import' && importFunctions.indexOf(node.callee.name) < 0) {
          return;
        }

        run(node, node.arguments[0]);
      },
    };
  },
};

1	import vm from 'vm';
2	import docsUrl from '../docsUrl';
3
4	module.exports = {
5	meta: {
6	type: 'suggestion',
7	docs: {
8	url: docsUrl('dynamic-import-chunkname'),
9	},
10	schema: [{
11	type: 'object',
12	properties: {
13	importFunctions: {
14	type: 'array',
15	uniqueItems: true,
16	items: {
17	type: 'string',
18	},
19	},
20	webpackChunknameFormat: {
21	type: 'string',
22	},
23	},
24	}],
25	},
26
27	create(context) {
28	const config = context.options[0];	80✔
29	const { importFunctions = [] } = config \|\| {};	80✔
30	const { webpackChunknameFormat = '[0-9a-zA-Z-_/.]+' } = config \|\| {};	80✔
31
32	const paddedCommentRegex = /^ (\S[\s\S]+\S) $/;	80✔
33	const commentStyleRegex = /^( \w+: (["'][^"']*["']\|\d+\|false\|true),?)+ $/;	80✔
34	const chunkSubstrFormat = ` webpackChunkName: ["']${webpackChunknameFormat}["'],? `;	80✔
35	const chunkSubstrRegex = new RegExp(chunkSubstrFormat);	80✔
36
37	function run(node, arg) {
38	const sourceCode = context.getSourceCode();	62✔
39	const leadingComments = sourceCode.getCommentsBefore	62✔
40	? sourceCode.getCommentsBefore(arg) // This method is available in ESLint >= 4.	62!
41	: sourceCode.getComments(arg).leading; // This method is deprecated in ESLint 7.
42
43	if (!leadingComments \|\| leadingComments.length === 0) {	62✔
44	context.report({
45	node,
46	message: 'dynamic imports require a leading comment with the webpack chunkname',
47	});
48	return;	3✔
49	}
50
51	let isChunknamePresent = false;	59✔
52
53	for (const comment of leadingComments) {	59✔
54	if (comment.type !== 'Block') {	65✔
55	context.report({
56	node,
57	message: 'dynamic imports require a /* foo */ style comment, not a // foo comment',
58	});
59	return;	3✔
60	}
61
62	if (!paddedCommentRegex.test(comment.value)) {	62✔
63	context.report({
64	node,
65	message: `dynamic imports require a block comment padded with spaces - /* foo */`,
66	});
67	return;	2✔
68	}
69
70	try {	60✔
71	// just like webpack itself does
72	vm.runInNewContext(`(function() {return {${comment.value}}})()`);	60✔
73	}
74	catch (error) {
75	context.report({
76	node,
77	message: `dynamic imports require a "webpack" comment with valid syntax`,
78	});
79	return;	16✔
80	}
81
82	if (!commentStyleRegex.test(comment.value)) {	44✔
83	context.report({
84	node,
85	message:
86	`dynamic imports require a leading comment in the form /${chunkSubstrFormat}/`,
87	});
88	return;	5✔
89	}
90
91	if (chunkSubstrRegex.test(comment.value)) {	39✔
92	isChunknamePresent = true;	26✔
93	}
94	}
95
96	if (!isChunknamePresent) {	33✔
97	context.report({
98	node,
99	message:
100	`dynamic imports require a leading comment in the form /${chunkSubstrFormat}/`,
101	});
102	}
103	}
104
105	return {
106	ImportExpression(node) {
107	run(node, node.source);	×
108	},
109
110	CallExpression(node) {
111	if (node.callee.type !== 'Import' && importFunctions.indexOf(node.callee.name) < 0) {	62!
112	return;	×
113	}
114
115	run(node, node.arguments[0]);	62✔
116	},
117	};
118	},
119	};

benmosher / eslint-plugin-import / #28399278

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous