@penskemediacorp/twig-to-php-parser 1.14.0 → 1.27.1

package/__tests__/fixtures/larva.config.js

@@ -1,7 +1,7 @@
 module.exports = {
 	parser: {
-		twigDir: `${__dirname}/src/patterns/`,
-		phpDir: `${__dirname}/template-parts/patterns/`,
+		twigDir: `${ __dirname }/src/patterns/`,
+		phpDir: `${ __dirname }/template-parts/patterns/`,
 		isUsingPlugin: true,
-	}
-};
+	},
+};

package/__tests__/parser-methods.test.js

@@ -3,106 +3,116 @@ const assert = require( 'assert' );
 const parserMethods = require( '../index.js' ).methods;
 
 const expectations = {
-	childInclude: '<?php \\PMC::render_template( CHILD_THEME_PATH . \'/template-parts/patterns/objects/o-nav.php\', $o_nav, true ); ?>',
-	larvaInclude: '<?php \\PMC::render_template( PMC_CORE_PATH . \'/template-parts/patterns/objects/o-nav.php\', $o_nav, true ); ?>',
-	pluginEnabled: '<?php \\PMC\\Larva\\Pattern::get_instance()->render_pattern_template( \'objects/o-nav\', $o_nav, true ); ?>'
+	childInclude:
+		"<?php \\PMC::render_template( CHILD_THEME_PATH . '/template-parts/patterns/objects/o-nav.php', $o_nav, true ); ?>",
+	larvaInclude:
+		"<?php \\PMC::render_template( PMC_CORE_PATH . '/template-parts/patterns/objects/o-nav.php', $o_nav, true ); ?>",
+	pluginEnabled:
+		"<?php \\PMC\\Larva\\Pattern::get_instance()->render_pattern_template( 'objects/o-nav', $o_nav, true ); ?>",
 };
 
-describe( 'parse include statements', function() {
-
+describe( 'parse include statements', function () {
 	it( 'twig includes are parsed to PMC::render_template calls', ( done ) => {
-		parserMethods.parseIncludePath(
-			'{% include "o-nav/o-nav.twig" with o_nav %}',
-			'o-nav',
-			'o_nav' )
-		.catch( e => console.log( e ) )
-		.then( ( result ) => {
-			assert.equal( result, expectations.childInclude );
-			done();
-		});
-	});
+		parserMethods
+			.parseIncludePath(
+				'{% include "o-nav/o-nav.twig" with o_nav %}',
+				'o-nav',
+				'o_nav'
+			)
+			.catch( ( e ) => console.log( e ) )
+			.then( ( result ) => {
+				assert.equal( result, expectations.childInclude );
+				done();
+			} );
+	} );
 
 	it( 'if larva namespace, parsed path references the parent theme', ( done ) => {
-
-		parserMethods.parseIncludePath(
-			'{% include "@larva/objects/o-nav.twig" with o_nav %}',
-			'o-nav',
-			'o_nav'
-		)
-		.catch( e => console.log( e ) )
-		.then( ( result ) => {
-			assert.equal( result, expectations.larvaInclude );
-			done();
-		} );
+		parserMethods
+			.parseIncludePath(
+				'{% include "@larva/objects/o-nav.twig" with o_nav %}',
+				'o-nav',
+				'o_nav'
+			)
+			.catch( ( e ) => console.log( e ) )
+			.then( ( result ) => {
+				assert.equal( result, expectations.larvaInclude );
+				done();
+			} );
 	} );
 
 	it( 'if plugin is enabled, use the render_pattern_template method from Larva', ( done ) => {
-
-		parserMethods.parseIncludePath(
-			'{% include "@project/objects/o-nav.twig" with o_nav %}',
-			'o-nav',
-			'o_nav',
-			true )
-			.catch( e => console.log( e ) )
+		parserMethods
+			.parseIncludePath(
+				'{% include "@project/objects/o-nav.twig" with o_nav %}',
+				'o-nav',
+				'o_nav',
+				true
+			)
+			.catch( ( e ) => console.log( e ) )
 			.then( ( result ) => {
 				assert.equal( result, expectations.pluginEnabled );
 				done();
 			} );
 	} );
-
-});
+} );
 
 describe( 'parse SVG includes', function () {
 	it( 'parses includes to brand_directory when using plugin', ( done ) => {
-
-		const expectedPluginEnabled = '<?php \\PMC::render_template( \\PMC\\Larva\\Config::get_instance()->get( \'brand_directory\' ) . \'/build/svg/\' . ( $c_logo_svg ?? \'\' ) . \'.svg\', [], true ); ?>';
-
-		parserMethods.parseSvgPath(
-			"{% include '../../build/svg/' ~ c_logo_svg ~ '.svg' %}",
-			'c_logo_svg',
-			true
-		)
-		.catch( e => console.log( e ) )
-		.then( ( result ) => {
-			assert.equal( result, expectedPluginEnabled );
-			done();
-		});
+		const expectedPluginEnabled =
+			"<?php \\PMC::render_template( \\PMC\\Larva\\Config::get_instance()->get( 'brand_directory' ) . '/build/svg/' . ( $c_logo_svg ?? '' ) . '.svg', [], true ); ?>";
+
+		parserMethods
+			.parseSvgPath(
+				"{% include '../../build/svg/' ~ c_logo_svg ~ '.svg' %}",
+				'c_logo_svg',
+				true
+			)
+			.catch( ( e ) => console.log( e ) )
+			.then( ( result ) => {
+				assert.equal( result, expectedPluginEnabled );
+				done();
+			} );
 	} );
 	it( 'parses includes to CHILD_THEME_PATH when not using plugin', ( done ) => {
-
-		const expected = '<?php \\PMC::render_template( CHILD_THEME_PATH . \'/assets/build/svg/\' . ( $c_logo_svg ?? \'\' ) . \'.svg\', [], true ); ?>';
-
-		parserMethods.parseSvgPath(
-			"{% include '../../build/svg/' ~ c_logo_svg ~ '.svg' %}",
-			'c_logo_svg'
-		)
-		.catch( e => console.log( e ) )
-		.then( ( result ) => {
-			assert.equal( result, expected );
-			done();
-		});
-	});
+		const expected =
+			"<?php \\PMC::render_template( CHILD_THEME_PATH . '/assets/build/svg/' . ( $c_logo_svg ?? '' ) . '.svg', [], true ); ?>";
+
+		parserMethods
+			.parseSvgPath(
+				"{% include '../../build/svg/' ~ c_logo_svg ~ '.svg' %}",
+				'c_logo_svg'
+			)
+			.catch( ( e ) => console.log( e ) )
+			.then( ( result ) => {
+				assert.equal( result, expected );
+				done();
+			} );
+	} );
 } );
 
 describe( 'parse custom functions', function () {
 	it( 'parses wp_action function', ( done ) => {
-
-		parserMethods.parseWpAction("{{wp_action('test','param',variable)}}")
-			.catch( e => console.log( e ) )
+		parserMethods
+			.parseWpAction( "{{wp_action('test','param',variable)}}" )
+			.catch( ( e ) => console.log( e ) )
 			.then( ( result ) => {
-				assert.equal( result, "<?php do_action( 'test', 'param', $variable ); ?>" );
+				assert.equal(
+					result,
+					"<?php do_action( 'test', 'param', $variable ); ?>"
+				);
 				done();
-			});
+			} );
 
 		// Test spacing
-		parserMethods.parseWpAction("{{ 	wp_action( 	'test', 	'param', 	variable 	) 	}}")
-			.catch( e => console.log( e ) )
+		parserMethods
+			.parseWpAction( "{{ 	wp_action( 	'test', 	'param', 	variable 	) 	}}" )
+			.catch( ( e ) => console.log( e ) )
 			.then( ( result ) => {
-				assert.equal( result, "<?php do_action( 'test', 'param', $variable ); ?>" );
+				assert.equal(
+					result,
+					"<?php do_action( 'test', 'param', $variable ); ?>"
+				);
 				done();
-			});
-
+			} );
 	} );
-
 } );
-

package/__tests__/twig-to-php-parser.test.js

@@ -5,7 +5,7 @@ const twigToPhpParser = require( '../index' ).twigToPhpParser;
 const exec = require( 'child_process' ).exec;
 
 const fixture = path.join( __dirname, 'fixtures' );
-const expectedDir = `${fixture}/template-parts-expected/patterns/`;
+const expectedDir = `${ fixture }/template-parts-expected/patterns/`;
 
 const getAppConfiguration = require( '../lib/getConfig' );
 const appConfiguration = getAppConfiguration( 'parser' );
@@ -22,44 +22,58 @@ const patternShortPaths = [
 	'modules/html-tag-interpolation.php',
 ];
 
-describe( 'twig to php parser', function() {
-
+describe( 'twig to php parser', function () {
 	beforeEach( ( done ) => {
-
-		exec( 'mkdir ' + appConfiguration.phpDir, ( err  ) => {
+		exec( 'mkdir ' + appConfiguration.phpDir, ( err ) => {
 			if ( err ) {
 				console.error( err );
 			}
-		});
+		} );
 
 		return twigToPhpParser( appConfiguration )
-		.catch( ( e ) => console.log( e ) )
-		.then( ( result ) => done() ); // Catch PHP errors.
-	});
+			.catch( ( e ) => console.log( e ) )
+			.then( ( result ) => done() ); // Catch PHP errors.
+	} );
 
 	it( 'creates new files and directories for objects, components, and modules', ( done ) => {
-		assert.equal( fs.existsSync( appConfiguration.phpDir + 'objects/o-nav.php' ), true );
-		assert.equal( fs.existsSync( appConfiguration.phpDir + 'components/c-nav-link.php' ), true );
-		assert.equal( fs.existsSync( appConfiguration.phpDir + 'modules/breadcrumbs.php' ), true );
+		assert.equal(
+			fs.existsSync( appConfiguration.phpDir + 'objects/o-nav.php' ),
+			true
+		);
+		assert.equal(
+			fs.existsSync(
+				appConfiguration.phpDir + 'components/c-nav-link.php'
+			),
+			true
+		);
+		assert.equal(
+			fs.existsSync(
+				appConfiguration.phpDir + 'modules/breadcrumbs.php'
+			),
+			true
+		);
 		done();
-	});
+	} );
 
 	it( 'parses patterns as expected', ( done ) => {
 		patternShortPaths.forEach( ( shortpath ) => {
-			let expectedContents = fs.readFileSync( expectedDir + shortpath ).toString();
-			let actualContents = fs.readFileSync( appConfiguration.phpDir + shortpath ).toString();
+			const expectedContents = fs
+				.readFileSync( expectedDir + shortpath )
+				.toString();
+			const actualContents = fs
+				.readFileSync( appConfiguration.phpDir + shortpath )
+				.toString();
 
 			assert.equal( actualContents, expectedContents );
-		});
+		} );
 		done();
-	});
+	} );
 
 	afterEach( () => {
 		exec( 'rm -r ' + appConfiguration.phpDir, ( err ) => {
 			if ( err ) {
 				console.error( err );
 			}
-		});
-	});
-
-});
+		} );
+	} );
+} );

package/index.js

@@ -7,12 +7,11 @@ const config = getAppConfiguration( 'parser' );
 /**
  * Twig to PHP Parser
  *
- * @param {object} config Optional object containing configuration. See the
+ * @param {Object} config Optional object containing configuration. See the
  *                        package README for supported configuration.
  */
 
 function twigToPhpParser( config = {} ) {
-
 	// TODO: We need some kind of wrapper here for config...or better:
 	// move this to pmc-plugins/pmc-larva and scrap this awkward JS
 	// execPhp wrapper situation, and use Larva\Config for this config.
@@ -26,12 +25,10 @@ function twigToPhpParser( config = {} ) {
 		} else {
 			twigDir = config.twigDir;
 		}
-	}
-	else if ( 'undefined' !== typeof config.relativeSrcOverride ) {
+	} else if ( 'undefined' !== typeof config.relativeSrcOverride ) {
 		if ( config.relativeSrcOverride.startsWith( '/' ) ) {
 			twigDir = config.relativeSrcOverride;
-		}
-		else {
+		} else {
 			twigDir = path.join( process.cwd(), config.relativeSrcOverride );
 		}
 	}
@@ -45,119 +42,131 @@ function twigToPhpParser( config = {} ) {
 	}
 
 	return new Promise( ( resolve, reject ) => {
-
-		execPhp( path.resolve( __dirname, './lib/twig-to-php-parser.php' ), config.phpBinaryPath, function( error, php, output ) {
-
-			if ( error ) {
-				reject( error );
-			}
-
-			php.twig_to_php_parser( twigDir, phpDir, isUsingPlugin, function( error, result, output, printed ) {
-
+		execPhp(
+			path.resolve( __dirname, './lib/twig-to-php-parser.php' ),
+			config.phpBinaryPath,
+			function ( error, php, output ) {
 				if ( error ) {
 					reject( error );
 				}
 
-				resolve( result );
-
-			});
-
-		});
-
-	});
-
-};
-
-function parseIncludePath( twigIncludeStr, patternName, dataName, isUsingPlugin = false ) {
-
-	return new Promise( ( resolve, reject ) => {
-
-		execPhp( path.resolve( __dirname, './lib/twig-to-php-parser.php' ), config.phpBinaryPath, function( error, php, output ) {
-
-			if ( error ) {
-				reject( error );
+				php.twig_to_php_parser(
+					twigDir,
+					phpDir,
+					isUsingPlugin,
+					function ( error, result, output, printed ) {
+						if ( error ) {
+							reject( error );
+						}
+
+						resolve( result );
+					}
+				);
 			}
+		);
+	} );
+}
 
-			php.parse_include_path( twigIncludeStr, patternName, dataName, isUsingPlugin, function( error, result, output, printed ) {
-
+function parseIncludePath(
+	twigIncludeStr,
+	patternName,
+	dataName,
+	isUsingPlugin = false
+) {
+	return new Promise( ( resolve, reject ) => {
+		execPhp(
+			path.resolve( __dirname, './lib/twig-to-php-parser.php' ),
+			config.phpBinaryPath,
+			function ( error, php, output ) {
 				if ( error ) {
 					reject( error );
 				}
 
-				resolve( result );
-
-			});
-
-		});
-
-	});
-
-};
+				php.parse_include_path(
+					twigIncludeStr,
+					patternName,
+					dataName,
+					isUsingPlugin,
+					function ( error, result, output, printed ) {
+						if ( error ) {
+							reject( error );
+						}
+
+						resolve( result );
+					}
+				);
+			}
+		);
+	} );
+}
 
 function parseSvgPath( twigSvgIncludeStr, svgName, isUsingPlugin = false ) {
-
 	return new Promise( ( resolve, reject ) => {
-
-		execPhp( path.resolve( __dirname, './lib/twig-to-php-parser.php' ), config.phpBinaryPath, function( error, php, output ) {
-
-			if ( error ) {
-				reject( error );
-			}
-
-			php.parse_svg_path( twigSvgIncludeStr, svgName, isUsingPlugin, function( error, result, output, printed ) {
-
+		execPhp(
+			path.resolve( __dirname, './lib/twig-to-php-parser.php' ),
+			config.phpBinaryPath,
+			function ( error, php, output ) {
 				if ( error ) {
 					reject( error );
 				}
 
-				resolve( result );
-
-			});
-
-		});
-
-	});
-
-};
+				php.parse_svg_path(
+					twigSvgIncludeStr,
+					svgName,
+					isUsingPlugin,
+					function ( error, result, output, printed ) {
+						if ( error ) {
+							reject( error );
+						}
+
+						resolve( result );
+					}
+				);
+			}
+		);
+	} );
+}
 
 function parseWpAction( twigMarkup ) {
 	return new Promise( ( resolve, reject ) => {
-
-		execPhp( path.resolve( __dirname, './lib/twig-to-php-parser.php' ), config.phpBinaryPath, function( error, php, output ) {
-
-			if ( error ) {
-				reject( error );
-			}
-
-			php.parse_wp_action( twigMarkup, function( error, result, output, printed ) {
-
+		execPhp(
+			path.resolve( __dirname, './lib/twig-to-php-parser.php' ),
+			config.phpBinaryPath,
+			function ( error, php, output ) {
 				if ( error ) {
 					reject( error );
 				}
 
-				resolve( result );
-
-			});
-
-		});
-
-	});
+				php.parse_wp_action(
+					twigMarkup,
+					function ( error, result, output, printed ) {
+						if ( error ) {
+							reject( error );
+						}
 
+						resolve( result );
+					}
+				);
+			}
+		);
+	} );
 }
 
 module.exports = {
-	twigToPhpParser: twigToPhpParser,
+	twigToPhpParser,
 	methods: {
-		parseIncludePath: parseIncludePath,
-		parseSvgPath: parseSvgPath,
-		parseWpAction: parseWpAction
+		parseIncludePath,
+		parseSvgPath,
+		parseWpAction,
 	},
 	run: () => {
 		twigToPhpParser( config )
-			.catch( e => console.log( e ) ) // PHP errors
-			.then( result => console.log(
-				chalk.green( 'Completed parsing Twig templates to PHP.' )
-			) )
-			.catch( e => console.log( e ) );
-	}
+			.catch( ( e ) => console.log( e ) ) // PHP errors
+			.then( ( result ) =>
+				console.log(
+					chalk.green( 'Completed parsing Twig templates to PHP.' )
+				)
+			)
+			.catch( ( e ) => console.log( e ) );
+	},
 };

package/lib/getConfig.js

@@ -20,7 +20,6 @@ const path = require( 'path' );
  */
 
 module.exports = function getAppConfiguration( key ) {
-
 	try {
 		let appRoot = process.cwd();
 
@@ -28,15 +27,22 @@ module.exports = function getAppConfiguration( key ) {
 			appRoot = path.join( __dirname, '../__tests__/fixtures' );
 		}
 
-		let config = require( `${appRoot}/larva.config.js` )[ key ];
+		const config = require( `${ appRoot }/larva.config.js` )[ key ];
 
 		if ( undefined === config ) {
-			throw new Error( `Configuration for \`${key}\` is required in larva.config.js. \nPlease refer to the Larva's docs for adding configuration: https://github.com/penske-media-corp/pmc-larva` );
+			throw new Error(
+				`Configuration for \`${ key }\` is required in larva.config.js. \nPlease refer to the Larva's docs for adding configuration: https://github.com/penske-media-corp/pmc-larva`
+			);
 		}
 
 		return config;
-
 	} catch ( error ) {
-		console.error( chalk.red( chalk.bold( 'There is no larva.config.js in this directory.\n' ) + error ) );
+		console.error(
+			chalk.red(
+				chalk.bold(
+					'There is no larva.config.js in this directory.\n'
+				) + error
+			)
+		);
 	}
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@penskemediacorp/twig-to-php-parser",
-  "version": "1.14.0",
+  "version": "1.27.1",
   "description": "> TODO: description",
   "author": "laras126 <laras126@gmail.com>",
   "homepage": "https://github.com/penske-media-corp/pmc-larva#readme",
@@ -26,5 +26,5 @@
     "chalk": "^4.1.0",
     "exec-php": "0.0.5"
   },
-  "gitHead": "fbf545499333b58c945ad92d4be8ffa8a233bae3"
+  "gitHead": "cb5a91282f5e1f4f023f2c2f8a97752c2918868c"
 }