@wp-blocks/make-pot 1.3.0 → 1.3.1

package/.gitignore

@@ -0,0 +1,11 @@
+# Project exclude paths
+/temp/
+/lib/
+/node_modules/
+/.idea/
+.run
+/src/makeJson.ts
+/tests/fixtures/
+languages
+example
+*.pot

package/.npmignore

@@ -0,0 +1,12 @@
+node_modules
+tests/fixtures
+tests/__snapshots__
+src
+docs/coverage
+languages
+.github
+.prettierrc
+ .prettierignore
+.idea
+example
+*.pot

package/package.json

@@ -1,68 +1,77 @@
-{
-	"name": "@wp-blocks/make-pot",
-	"version": "1.3.0",
-	"license": "GPL-3.0-or-later",
-	"homepage": "https://wp-blocks.github.io/make-pot/",
-	"description": "A Node.js script for generating a POT file from source code",
-	"authors": [
-		"Erik Golinelli <erik@codekraft.it> (https://codekraft.it/)",
-		"John Hooks <bitmachina@outlook.com> (https://johnhooks.io/)"
-	],
-	"main": "lib/run.js",
-	"bin": {
-		"make-pot": "lib/index.js"
-	},
-	"type": "commonjs",
-	"engines": {
-		"node": ">=16.0.0"
-	},
-	"files": ["lib", "*.md", "*.json", "LICENSE"],
-	"keywords": [
-		"gettext",
-		"i18n",
-		"pot",
-		"WordPress",
-		"translation",
-		"internalization"
-	],
-	"scripts": {
-		"postinstall": "npm rebuild tree-sitter tree-sitter-typescript tree-sitter-php tree-sitter-javascript --force",
-		"build": "npx esbuild ./src/**/* --format=cjs --minify --outdir=lib --platform=node",
-		"watch": "tsc --watch",
-		"lint": "npx @biomejs/biome check --apply src",
-		"test": "node --test",
-		"ci:bundle": "npx esbuild ./src/index.ts --format=cjs --outdir=lib --bundle --external:tree-sitter --external:tree-sitter-typescript --external:tree-sitter-php --external:tree-sitter-javascript --platform=node",
-		"test:ci": "npm run ci:bundle && node --test",
-		"test:watch": "node --test --watch",
-		"test:coverage": "node --test --experimental-test-coverage",
-		"run": "node ./lib/index.js tests/fixtures/vinyl/"
-	},
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/wp-blocks/makePot.git"
-	},
-	"bugs": {
-		"url": "https://github.com/wp-blocks/makePot/issues"
-	},
-	"dependencies": {
-		"axios": "^1.6.8",
-		"cli-progress": "^3.12.0",
-		"gettext-merger": "^1.2.1",
-		"gettext-parser": "^4.0.4",
-		"glob": "^10.3.10",
-		"tree-sitter": "^0.20.6",
-		"tree-sitter-javascript": "^0.20.4",
-		"tree-sitter-php": "^0.20.0",
-		"tree-sitter-typescript": "^0.20.5",
-		"yargs": "^17.7.1"
-	},
-	"devDependencies": {
-		"@biomejs/biome": "1.7.3",
-		"@types/cli-progress": "^3.11.5",
-		"@types/gettext-parser": "^4.0.4",
-		"@types/node": "^20.11.28",
-		"@types/yargs": "^17.0.32",
-		"esbuild": "0.21.1",
-		"typescript": "^5.4.5"
-	}
-}
+{
+	"name": "@wp-blocks/make-pot",
+	"version": "1.3.1",
+	"license": "GPL-3.0-or-later",
+	"homepage": "https://wp-blocks.github.io/make-pot/",
+	"description": "A Node.js script for generating a POT file from source code",
+	"authors": [
+		"Erik Golinelli <erik@codekraft.it> (https://codekraft.it/)",
+		"John Hooks <bitmachina@outlook.com> (https://johnhooks.io/)"
+	],
+	"type": "commonjs",
+	"main": "lib/run.js",
+	"bin": {
+		"make-pot": "lib/index.js"
+	},
+	"engines": {
+		"node": ">=16.0.0"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/wp-blocks/makePot.git"
+	},
+	"bugs": {
+		"url": "https://github.com/wp-blocks/makePot/issues"
+	},
+	"files": [
+		"lib",
+		"*.md",
+		"*.json",
+		"tests/*.js",
+		"LICENSE",
+		"editorconfig",
+		".gitignore",
+		".npmignore"
+	],
+	"keywords": [
+		"gettext",
+		"i18n",
+		"pot",
+		"WordPress",
+		"translation",
+		"internalization"
+	],
+	"scripts": {
+		"postinstall": "npm rebuild tree-sitter tree-sitter-typescript tree-sitter-php tree-sitter-javascript --force",
+		"build": "npx esbuild ./src/**/* --format=cjs --minify --outdir=lib --platform=node",
+		"watch": "tsc --watch",
+		"lint": "npx @biomejs/biome check --apply src",
+		"test": "node --test",
+		"ci:bundle": "npx esbuild ./src/index.ts --format=cjs --outdir=lib --bundle --external:tree-sitter --external:tree-sitter-typescript --external:tree-sitter-php --external:tree-sitter-javascript --platform=node",
+		"test:ci": "npm run ci:bundle && node --test",
+		"test:watch": "node --test --watch",
+		"test:coverage": "node --test --experimental-test-coverage",
+		"run": "node ./lib/index.js tests/fixtures/vinyl/"
+	},
+	"dependencies": {
+		"axios": "^1.6.8",
+		"cli-progress": "^3.12.0",
+		"gettext-merger": "^1.2.1",
+		"gettext-parser": "^4.0.4",
+		"glob": "^10.3.10",
+		"tree-sitter": "^0.20.6",
+		"tree-sitter-javascript": "^0.20.4",
+		"tree-sitter-php": "^0.20.0",
+		"tree-sitter-typescript": "^0.20.5",
+		"yargs": "^17.7.1"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "1.7.3",
+		"@types/cli-progress": "^3.11.5",
+		"@types/gettext-parser": "^4.0.4",
+		"@types/node": "^20.11.28",
+		"@types/yargs": "^17.0.32",
+		"esbuild": "0.21.1",
+		"typescript": "^5.4.5"
+	}
+}

package/tests/extract.test.js

@@ -0,0 +1,381 @@
+const { describe, it, beforeEach, before } = require("node:test");
+const assert = require("node:assert");
+const { Block } = require("gettext-merger");
+const { doTree } = require("../lib/");
+
+describe("getStrings", () => {
+	it("should extract translations from js", () => {
+		const content = `var foo = __('Hello World', 'greeting');`;
+		const filename = "filename.js";
+
+		const result = doTree(content, filename);
+		const expected = new Block([]);
+		expected.msgid = "Hello World";
+		expected.comments = {
+			reference: ["filename.js:1"],
+			translator: [""],
+		};
+
+		assert.strictEqual(result.blocks[0].msgid, expected.msgid);
+	});
+
+	it("should extract translations from ts", () => {
+		const content = `__('Hello World', 'greeting');`;
+		const filename = "filename.ts";
+
+		const result = doTree(content, filename).blocks[0].toJson();
+
+		const expected = new Block([]);
+		expected.msgid = "Hello World";
+		expected.comments = {
+			reference: ["filename.ts:1"],
+			translator: [""],
+		};
+
+		assert.strictEqual(result.msgid, expected.msgid);
+		assert.strictEqual(expected.comments?.reference.length, 1);
+		assert.deepStrictEqual(
+			[result.comments.reference],
+			expected.comments.reference,
+		);
+	});
+
+	it("should extract translations from tsx", () => {
+		const content = `const element = <h1>{ __('Hello World', 'greeting')}</h1>;`;
+
+		const filename = "filename.tsx";
+
+		const result = doTree(content, filename);
+
+		const expected = new Block([]);
+		expected.msgid = "Hello World";
+		expected.msgstr = [""];
+		expected.comments = {
+			reference: ["filename.tsx:1"],
+			translator: [""],
+		};
+
+		assert.deepStrictEqual(result.blocks[0].toJson(), expected.toJson());
+	});
+
+	it("should extract translations with context", () => {
+		const content = `<?php __('Hello World', 'greeting'); ?>`;
+		const filename = "filename.php";
+
+		const result = doTree(content, filename);
+
+		const expected = new Block([]);
+		expected.msgid = "Hello World";
+		expected.msgstr = [""];
+		expected.comments = {
+			reference: ["filename.php:1"],
+			translator: [""],
+		};
+
+		assert.deepStrictEqual(result.blocks[0].toJson(), expected.toJson());
+	});
+
+	it("should extract translations from code content with no context or translator comments", () => {
+		const content = `<?php _e('Hello World'); ?>`;
+		const expected = new Block([]);
+		expected.msgctxt = undefined;
+		expected.msgid = "Hello World";
+		expected.msgid_plural = undefined;
+		expected.msgstr = [""];
+		expected.comments = {
+			translator: undefined,
+			reference: ["filename.php:1"],
+		};
+		const filename = "filename.php";
+
+		const result = doTree(content, filename);
+
+		assert.deepEqual(result.blocks[0], expected);
+	});
+
+	it("should extract translations with comments", () => {
+		const filename = "filename.php";
+		const content = `
+		<?php /** translators: ciao! */ echo _x('Hello World', 'greeting'); ?>`;
+		const expectedComments = {
+			reference: ["filename.php:2"],
+			translator: ["ciao!"],
+		};
+
+		const result = doTree(content, filename);
+
+		assert.deepEqual(result.blocks[0].comments, expectedComments);
+	});
+
+	it("should extract translations with comments reporting the right position", () => {
+		const filename = "filename.php";
+		const content = `
+
+
+
+/** line 5*/
+
+
+
+
+		<?php echo _x('Hello World', 'greeting'); ?>`;
+		const expected = `#: filename.php:10
+msgctxt "greeting"
+msgid "Hello World"
+msgstr ""`;
+
+		const result = doTree(content, filename);
+
+		assert.strictEqual(result.blocks[0].toStr(), expected);
+	});
+
+	it("should extract translations inside a sprint", () => {
+		const filename = "filename.php";
+		const content = ` <?php
+$url = 'http://example.com';
+$link = sprintf( wp_kses( __( 'Check out this link to my <a href="%s">website</a> made with WordPress.', 'my-text-domain' ), array(  'a' => array( 'href' => array() ) ) ), esc_url( $url ) );
+echo $link;`;
+		const expected = {
+			"": {
+				'Check out this link to my <a href="%s">website</a> made with WordPress.':
+					{
+						comments: {
+							extracted: "",
+							flag: "",
+							previous: "",
+							reference: "filename.php:3",
+							translator: "",
+						},
+						msgctxt: "",
+						msgid:
+							'Check out this link to my <a href="%s">website</a> made with WordPress.',
+						msgid_plural: undefined,
+						msgstr: [""],
+					},
+			},
+		};
+
+		const result = doTree(content, filename);
+
+		assert.deepStrictEqual(result.toJson(), expected);
+	});
+});
+
+describe("getStrings wp cli", () => {
+	it("should extract from an array of translations", () => {
+		const filename = "filename.php";
+		const content = `<?php $var = 'don't do this'; $instructions = array(
+		"Overview" => array(
+				"title" => __( 'Overview', '3d-product-viewer' ),
+				"text"  => __( "Hold down the right button to move the model", '3d-product-viewer' ),
+				"icon"  => 'icon-book'
+		),
+		"Rotation" => array(
+				"title" => __( 'Rotation', '3d-product-viewer' ),
+				"text"  => __( "Left-click and drag to change the angle", '3d-product-viewer' ),
+				"icon"  => 'icon-rotation'
+		),
+		"Zoom"     => array(
+				"title" => __( 'Zoom', '3d-product-viewer' ),
+				"text"  => __( "Variable is % and not  {$var}", '3d-product-viewer' ),
+				"icon"  => 'icon-zoom'
+		)
+);
+`;
+
+		const result = doTree(content, filename);
+		assert.deepStrictEqual(result.blocks[0].msgid, "Overview");
+	});
+
+	it("should extract translations with translator comments inside the formatting hell", () => {
+		const filename = "filename.php";
+		const content = `<?php if ( count( $errors_in_remigrate_batch ) > 0 ) {
+		$formatted_errors = wp_json_encode( $errors_in_remigrate_batch, JSON_PRETTY_PRINT );
+		WP_CLI::warning(
+		  sprintf(
+		    /* Translators: %1$d is number of errors and %2$s is the formatted array of order IDs. */
+		      _n(
+		        '%1$d error found: %2$s when re-migrating order. Please review the error above.',
+		        '%1$d errors found: %2$s when re-migrating orders. Please review the errors above.',
+		     	count( %s ),
+		        'woocommerce'
+		      ),
+		    count( $errors_in_remigrate_batch ),
+		    $formatted_errors
+		    )
+		  );
+		} else {
+			WP_CLI::warning( 'Re-migration successful.', 'woocommerce' );
+		}
+`;
+
+		const result = doTree(content, filename);
+		assert.strictEqual(
+			"%1$d error found: %2$s when re-migrating order. Please review the error above.",
+			result.blocks[0].msgid,
+		);
+	});
+
+	/** see https://github.com/wp-cli/i18n-command/blob/main/features/makepot.feature */
+	it("should extract translations and comments from code content", () => {
+		const content = `<?php
+
+    And a foo-plugin/foo-plugin.php file:
+      """
+      <?php
+      /**
+       */
+       __( 'Hello World', 'foo-plugin' );
+      """
+    And a foo-plugin/vendor/ignored.php file:
+      """
+      <?php
+       __( 'I am being ignored', 'foo-plugin' );
+      """
+      __( '__', 'foo-plugin' );
+      esc_attr__( 'esc_attr__', 'foo-plugin' );
+      esc_html__( 'esc_html__', 'foo-plugin' );
+      esc_xml__( 'esc_xml__', 'foo-plugin' );
+      _e( '_e', 'foo-plugin' );
+      esc_attr_e( 'esc_attr_e', 'foo-plugin' );
+      esc_html_e( 'esc_html_e', 'foo-plugin' );
+      esc_xml_e( 'esc_xml_e', 'foo-plugin' );
+      _x( '_x', '_x_context', 'foo-plugin' );
+      _ex( '_ex', '_ex_context', 'foo-plugin' );
+      esc_attr_x( 'esc_attr_x', 'esc_attr_x_context', 'foo-plugin' );
+      esc_html_x( 'esc_html_x', 'esc_html_x_context', 'foo-plugin' );
+      esc_xml_x( 'esc_xml_x', 'esc_xml_x_context', 'foo-plugin' );
+      _n( '_n_single', '_n_plural', $number, 'foo-plugin' );
+      _nx( '_nx_single', '_nx_plural', $number, '_nx_context', 'foo-plugin' );
+      _n_noop( '_n_noop_single', '_n_noop_plural', 'foo-plugin' );
+      _nx_noop( '_nx_noop_single', '_nx_noop_plural', '_nx_noop_context', 'foo-plugin' );
+
+      // Compat.
+      _( '_', 'foo-plugin' );
+
+      // Deprecated.
+      _c( '_c', 'foo-plugin' );
+      _nc( '_nc_single', '_nc_plural', $number, 'foo-plugin' );
+      __ngettext( '__ngettext_single', '__ngettext_plural', $number, 'foo-plugin' );
+      __ngettext_noop( '__ngettext_noop_single', '__ngettext_noop_plural', 'foo-plugin' );
+
+      __unsupported_func( '__unsupported_func', 'foo-plugin' );
+      __( 'wrong-domain', 'wrong-domain' );
+
+      // See https://github.com/wp-cli/i18n-command/issues/344
+      \\__( '\\__', 'foo-plugin' );
+      \\_e( '\\_e', 'foo-plugin' );
+      // Included to test if peast correctly parses regexes containing a quote.
+      // See: https://github.com/wp-cli/i18n-command/issues/98
+      n = n.replace(/"/g, '&quot;');
+      n = n.replace(/"|'/g, '&quot;');
+
+      __( '__', 'foo-plugin' );
+      _x( '_x', '_x_context', 'foo-plugin' );
+      _n( '_n_single', '_n_plural', number, 'foo-plugin' );
+      _nx( '_nx_single', '_nx_plural', number, '_nx_context', 'foo-plugin' );
+
+      __( 'wrong-domain', 'wrong-domain' );
+
+      __( 'Hello world' ); // translators: Greeting`;
+
+		const filename = "filename.php";
+
+		const result = doTree(content, filename);
+
+		assert.strictEqual(result.blocks.length, 26);
+	});
+
+	/** see wp cli tests */
+	it("should extract translations and comments from code content", () => {
+		const content = `<?php
+
+      // translators: Foo Bar Comment
+      __( 'Foo Bar', 'foo-plugin' );
+
+      // TrANslAtORs: Bar Baz Comment
+      __( 'Bar Baz', 'foo-plugin' );
+
+      // translators: Software name
+      const string = __( 'WordPress', 'foo-plugin' );
+
+      // translators: So much space
+
+      __( 'Spacey text', 'foo-plugin' );
+
+      /* translators: Long comment
+      spanning multiple
+      lines */
+      const string = __( 'Short text', 'foo-plugin' );
+
+      ReactDOM.render(
+        <h1>{__( 'Hello JSX', 'foo-plugin' )}</h1>,
+        document.getElementById('root')
+      );
+
+      wp.i18n.__( 'wp.i18n.__', 'foo-plugin' );
+      wp.i18n._n( 'wp.i18n._n_single', 'wp.i18n._n_plural', number, 'foo-plugin' );
+
+      const translate = wp.i18n;
+      translate.__( 'translate.__', 'foo-plugin' );
+
+      Object(_wordpress_i18n__WEBPACK_IMPORTED_MODULE_7__["__"])( 'webpack.__', 'foo-plugin' );
+      Object(_wordpress_i18n__WEBPACK_IMPORTED_MODULE_7__[/* __ */ "a"])( 'webpack.mangle.__', 'foo-plugin' );
+
+      Object(u.__)( 'minified.__', 'foo-plugin' );
+      Object(j._x)( 'minified._x', 'minified._x_context', 'foo-plugin' );
+
+      /* translators: babel */
+      (0, __)( 'babel.__', 'foo-plugin' );
+      (0, _i18n.__)( 'babel-i18n.__', 'foo-plugin' );
+      (0, _i18n._x)( 'babel-i18n._x', 'babel-i18n._x_context', 'foo-plugin' );
+
+      eval( "__( 'Hello Eval World', 'foo-plugin' );" );
+
+      __( \`This is a \${bug}\`, 'foo-plugin' );
+
+      /**
+       * Plugin Name: Plugin name
+       */
+
+      /* translators: Translators 1! */
+      _e( 'hello world', 'foo-plugin' );
+
+      /* Translators: Translators 2! */
+      $foo = __( 'foo', 'foo-plugin' );
+
+      /* translators: localized date and time format, see https://secure.php.net/date */
+      __( 'F j, Y g:i a', 'foo-plugin' );
+
+      // translators: let your ears fly!
+      __( 'on', 'foo-plugin' );
+
+      /*
+       * Translators: If there are characters in your language that are not supported
+       * by Lato, translate this to 'off'. Do not translate into your own language.
+       */
+       __( 'off', 'foo-plugin' );
+
+      /* translators: this should get extracted. */ $foo = __( 'baba', 'foo-plugin' );
+
+      /* translators: boo */ /* translators: this should get extracted too. */ /* some other comment */ $bar = g( __( 'bubu', 'foo-plugin' ) );
+
+      {TAB}/*
+      {TAB} * translators: this comment block is indented with a tab and should get extracted too.
+      {TAB} */
+      {TAB}__( 'yolo', 'foo-plugin' );
+
+      /* translators: This is a comment */
+      __( 'Plugin name', 'foo-plugin' );
+
+      /* Translators: This is another comment! */
+      __( 'https://example.com', 'foo-plugin' );
+      `;
+
+		const filename = "filename.php";
+
+		const result = doTree(content, filename);
+
+		assert.strictEqual(result.blocks.length, 20);
+	});
+});

package/tests/getFiles.test.no.js

@@ -0,0 +1,85 @@
+const { sep } = require("node:path");
+const { describe, it } = require("node:test");
+const assert = require("node:assert");
+const { parseCliArgs } = require("./lib/cli/parseCli.js");
+const { getFiles } = require("./lib/fs/glob.js");
+
+describe("getFiles", () => {
+	const DEFAULTS = parseCliArgs({
+		domain: "plugin",
+		slug: "plugin-slug",
+		paths: { cwd: "tests/fixtures/", out: "tests/fixtures/" },
+		options: {
+			silent: true,
+		},
+		$0: "makepot",
+		_: [0, 1],
+	});
+
+	it("should retrieve a all files", async () => {
+		const args = { ...DEFAULTS, domain: "theme" };
+		const pattern = { include: ["./src/**"], exclude: [] };
+
+		const files = getFiles(args, pattern);
+		const collected = [];
+		for (const file of files) {
+			assert.equal(!!file, true);
+			collected.push(file);
+		}
+		assert.deepStrictEqual(collected.length, 28);
+		assert.strictEqual(
+			collected.find((e) => e.includes("const.ts")),
+			"src\\const.ts",
+		);
+	});
+
+	it("Should retrieve a list of txt files based on the provided plugin pattern", async () => {
+		const args = {
+			...DEFAULTS,
+		};
+		const pattern = {
+			include: ["**/*.txt"],
+			exclude: ["node_modules", "dist"],
+		};
+		const expectedFiles = [
+			`tests${sep}fixtures${sep}file1.txt`,
+			`tests${sep}fixtures${sep}sourcedir${sep}file2.txt`,
+			`tests${sep}fixtures${sep}block${sep}readme.txt`,
+		];
+
+		const files = getFiles(args, pattern);
+		const collected = [];
+		for (const file of files) {
+			assert.equal(!!file, true);
+			collected.push(file);
+		}
+
+		assert.deepStrictEqual(collected, expectedFiles);
+	});
+
+	it("should retrieve a list of theme.json files based on the provided theme pattern", async () => {
+		const args = {
+			...DEFAULTS,
+		};
+		const pattern = {
+			include: ["tests/fixtures/sourcedir/**/*.json"],
+			exclude: [],
+		};
+		const expectedFiles = [
+			`tests${sep}fixtures${sep}sourcedir${sep}theme.json`,
+			`tests${sep}fixtures${sep}sourcedir${sep}package.json`,
+			`tests${sep}fixtures${sep}sourcedir${sep}node_modules${sep}module${sep}block.json`,
+		];
+
+		const files = getFiles(args, pattern);
+		const collected = [];
+		for (const file of files) {
+			assert.equal(!!file, true);
+			collected.push(file);
+		}
+
+		const fileFound = collected.filter((file) => expectedFiles.includes(file));
+
+		assert.deepStrictEqual(fileFound.length, 3);
+	});
+});

package/tests/jsonParse.no.js

@@ -0,0 +1,49 @@
+const fs = require("node:fs");
+const { describe, it } = require("node:test");
+const assert = require("node:assert");
+const { parseJsonFile } = require("../lib/extractors/json.js");
+
+describe("should parse json", () => {
+	it("theme.json", async () => {
+		const expected = {
+			"block style label": {
+				label: {
+					comments: {
+						reference: "block/block.json",
+					},
+					msgctxt: "block style label",
+					msgid: "label",
+					msgstr: [],
+				},
+			},
+			"block description": {
+				description: {
+					comments: {
+						reference: "block/block.json",
+					},
+					msgctxt: "block description",
+					msgid: "description",
+					msgstr: [],
+				},
+			},
+			"block keyword": {
+				undefined: {
+					comments: {
+						reference: "block/block.json",
+					},
+					msgctxt: "block keyword",
+					msgid: undefined,
+					msgstr: [],
+				},
+			},
+		};
+
+		const result = await parseJsonFile({
+			fileContent: fs.readFileSync("tests/fixtures/block/block.json", "utf8"),
+			filename: "block.json",
+			filepath: "block/block.json",
+		});
+
+		assert.strictEqual(result, expected);
+	});
+});

package/tests/tree.test.js

@@ -0,0 +1,158 @@
+const path = require("node:path");
+const fs = require("node:fs");
+const { describe, it } = require("node:test");
+const assert = require("node:assert");
+const { doTree } = require("../lib/");
+
+describe("doTree js", () => {
+	const filepath = "tests/fixtures/block/javascript.js";
+	const filePath = path.join(process.cwd(), filepath);
+	const fileContent = fs.readFileSync(filePath, "utf8");
+	it("Should parse TSX file and extract strings", () => {
+		const fileParsed = doTree(fileContent, filepath);
+		assert.deepEqual(fileParsed.blocks[0], {
+			comments: {
+				reference: ["tests\\fixtures\\block\\javascript.js:7"],
+				translator: undefined,
+			},
+			msgctxt: undefined,
+			msgid: "Simple Block",
+			msgid_plural: undefined,
+			msgstr: [""],
+		});
+	});
+});
+
+describe("doTree php", () => {
+	const filepath = "tests/fixtures/plugin/plugin.php";
+	const filePath = path.join(process.cwd(), filepath);
+	const fileContent = fs.readFileSync(filePath, "utf8");
+	it("Should parse TSX file and extract strings", () => {
+		const fileParsed = doTree(fileContent, filepath);
+		assert.deepEqual(fileParsed.blocks[1], {
+			comments: {
+				reference: ["tests\\fixtures\\plugin\\plugin.php:65"],
+				translator: undefined,
+			},
+			msgctxt: undefined,
+			msgid: "You\\'re a silly monkey",
+			msgid_plural: undefined,
+			msgstr: [""],
+		});
+	});
+});
+
+describe("doTree tsx file", () => {
+	const filepath = "tests/fixtures/block/SvgControls.tsx";
+	const filePath = path.join(process.cwd(), filepath);
+	const fileContent = fs.readFileSync(filePath, "utf8");
+	it("Should parse TSX file and extract strings", () => {
+		const fileParsed = doTree(fileContent, filepath);
+		assert.deepEqual(fileParsed.blocks[2], {
+			comments: {
+				reference: ["tests\\fixtures\\block\\SvgControls.tsx:107"],
+				translator: undefined,
+			},
+			msgctxt: undefined,
+			msgid: "Replace SVG",
+			msgid_plural: undefined,
+			msgstr: [""],
+		});
+	});
+});
+
+describe("doTree php test file", async () => {
+	/** see wp cli tests */
+	it("should extract translations and comments from code content", () => {
+		const content = `<?php
+
+      // translators: Foo Bar Comment
+      __( 'Foo Bar', 'foo-plugin' );
+
+      // TrANslAtORs: Bar Baz Comment
+      __( 'Bar Baz', 'foo-plugin' );
+
+      // translators: Software name
+      const string = __( 'WordPress', 'foo-plugin' );
+
+      // translators: So much space
+
+      __( 'Spacey text', 'foo-plugin' );
+
+      /* translators: Long comment
+      spanning multiple
+      lines */
+      const string = __( 'Short text', 'foo-plugin' );
+
+      ReactDOM.render(
+        <h1>{__( 'Hello JSX', 'foo-plugin' )}</h1>,
+        document.getElementById('root')
+      );
+
+      wp.i18n.__( 'wp.i18n.__', 'foo-plugin' );
+
+      const translate = wp.i18n;
+      translate.__( 'translate.__', 'foo-plugin' );
+
+      Object(_wordpress_i18n__WEBPACK_IMPORTED_MODULE_7__["__"])( 'webpack.__', 'foo-plugin' );
+      Object(_wordpress_i18n__WEBPACK_IMPORTED_MODULE_7__[/* __ */ "a"])( 'webpack.mangle.__', 'foo-plugin' );
+
+      Object(u.__)( 'minified.__', 'foo-plugin' );
+      Object(j._x)( 'minified._x', 'minified._x_context', 'foo-plugin' );
+
+      /* translators: babel */
+      (0, __)( 'babel.__', 'foo-plugin' );
+      (0, _i18n.__)( 'babel-i18n.__', 'foo-plugin' );
+      (0, _i18n._x)( 'babel-i18n._x', 'babel-i18n._x_context', 'foo-plugin' );
+
+      eval( "__( 'Hello Eval World', 'foo-plugin' );" );
+
+      __( "ASDASDASD', 'foo-plugin' );
+
+      /**
+       * Plugin Name: Plugin name
+       */
+
+      /* translators: Translators 1! */
+      _e( 'hello world', 'foo-plugin' );
+
+      /* Translators: Translators 2! */
+      $foo = __( 'foo', 'foo-plugin' );
+
+      /* translators: localized date and time format, see https://secure.php.net/date */
+      __( 'F j, Y g:i a', 'foo-plugin' );
+
+      // translators: let your ears fly!
+      __( 'on', 'foo-plugin' );
+
+      /*
+       * Translators: If there are characters in your language that are not supported
+       * by Lato, translate this to 'off'. Do not translate into your own language.
+       */
+       __( 'off', 'foo-plugin' );
+
+      /* translators: this should get extracted. */ $foo = __( 'baba', 'foo-plugin' );
+
+      /* translators: boo */ /* translators: this should get extracted too. */ /* some other comment */ $bar = g( __( 'bubu', 'foo-plugin' ) );
+
+      {TAB}/*
+      {TAB} * translators: this comment block is indented with a tab and should get extracted too.
+      {TAB} */
+      {TAB}__( 'yolo', 'foo-plugin' );
+
+      /* translators: This is a comment */
+      __( 'Plugin name', 'foo-plugin' );
+
+      /* Translators: This is another comment! */
+      __( 'https://example.com', 'foo-plugin' );
+      `;
+
+		const filename = "filename.php";
+
+		const r = doTree(content, filename).blocks;
+		const res = Object.values(r)[0];
+
+		assert.strictEqual(r.map((block) => block).length, 11);
+		assert.strictEqual(r.filter((block) => block.comments).length, 11);
+	});
+});

package/tests/wpcliCompare.no.js

@@ -0,0 +1,32 @@
+const fs = require("node:fs");
+const path = require("node:path");
+const { describe, it } = require("node:test");
+const assert = require("node:assert");
+
+const { makePot } = require("../lib/");
+const { getArgs } = require("../lib/cli/getArgs.js");
+
+describe("doTree is like wpcli", () => {
+	it("Should emit a pot file for theme like the wp-cli makepot", async () => {
+		const filePath = path.join(process.cwd(), "./tests/fixtures/theme/");
+		const potPath = path.join(process.cwd(), "./tests/fixtures/theme.pot");
+		const potContent = fs.readFileSync(potPath, "utf8");
+		const args = getArgs({
+			_: [filePath],
+		});
+		const fileParsed = await makePot(args);
+		assert.deepEqual(fileParsed, potContent);
+	});
+
+	it("should emit a pot file for plugin like the wp-cli makepot", async () => {
+		const filePath = path.join(process.cwd(), "./tests/fixtures/vinyl/");
+		const potPath = path.join(process.cwd(), "./tests/fixtures/vinyl.pot");
+		const potContent = fs.readFileSync(potPath, "utf8");
+
+		const args = getArgs({
+			_: [filePath],
+		});
+		const fileParsed = await makePot(args);
+		assert.deepEqual(fileParsed, potContent);
+	});
+});