feat: support excluding directories (#4)

Co-authored-by: Pascal Canadas <[email protected]>
Co-authored-by: Enzo Innocenzi <[email protected]>

src/plugin.ts

@@ -55,6 +55,7 @@ export default function(options: Partial<Options> = {}): Plugin {
 				input: 'resources/mail',
 				output: 'resources/views/emails',
 				extension: '.blade.php',
+				exclude: [],
 				logger: config.logger,
 				building: config.command === 'build',
 				log: true,
@@ -73,9 +74,16 @@ export default function(options: Partial<Options> = {}): Plugin {
 				input = path.join(compileOptions.input, '**/*.mjml').replace(/\\/g, '/')
 			}
 
+			const excludes = Array.isArray(compileOptions.exclude)
+				? compileOptions.exclude
+				: [compileOptions.exclude]
 			const files = await fg(input)
 			debug.mjml('Compiling MJML files:', { input, files })
-			files.forEach((file) => compileInput(file, compileOptions))
+			files.forEach((file) => {
+				if (!excludes.some((exclude) => file.startsWith(exclude))) {
+					compileInput(file, compileOptions)
+				}
+			})
 		},
 		configureServer(server) {
 			if (compileOptions.watch === false) {

src/types.ts

@@ -5,6 +5,7 @@ export interface Options {
 	input: string
 	output: string
 	extension: string
+	exclude: string | string[]
 	watch: boolean
 	log: boolean
 	mjml?: MJMLParsingOptions

test/fixtures/has-excludes/mail/mail.mjml

@@ -0,0 +1,11 @@
+<mjml>
+  <mj-body>
+    <mj-section>
+      <mj-column>
+        <mj-image width="100px" src="https://mjml.io/assets/img/logo-small.png"></mj-image>
+        <mj-divider border-color="#F45E43"></mj-divider>
+        <mj-text font-size="20px" color="#F45E43" font-family="helvetica">Hello World</mj-text>
+      </mj-column>
+    </mj-section>
+  </mj-body>
+</mjml>

test/fixtures/has-excludes/partials/_foo.mjml

@@ -0,0 +1,11 @@
+<mjml>
+  <mj-body>
+    <mj-section>
+      <mj-column>
+        <mj-image width="100px" src="https://mjml.io/assets/img/logo-small.png"></mj-image>
+        <mj-divider border-color="#F45E43"></mj-divider>
+        <mj-text font-size="20px" color="#F45E43" font-family="helvetica">Hello World</mj-text>
+      </mj-column>
+    </mj-section>
+  </mj-body>
+</mjml>

test/plugin.test.ts

@@ -28,6 +28,27 @@ test('it compiles', async() => {
 	expect(fs.existsSync(path.resolve(output, 'mail', 'mail.html'))).toBe(true)
 })
 
+test('it can exclude directories', async() => {
+	expect(fs.existsSync(output)).toBe(false)
+
+	await build({
+		root: fixtures,
+		logLevel: 'silent',
+		plugins: [
+			mjml({
+				log: false,
+				extension: '.html',
+				input: path.resolve(fixtures, 'has-excludes'),
+				output,
+				exclude: [path.resolve(fixtures, 'has-excludes', 'partials')],
+			}),
+		],
+	})
+
+	expect(fs.existsSync(path.resolve(output, 'mail', 'mail.html'))).toBe(true)
+	expect(!fs.existsSync(path.resolve(output, 'partials', '_foo.html'))).toBe(true)
+})
+
 test('it throws on compilation errors', async() => {
 	expect(fs.existsSync(output)).toBe(false)