@wp-blocks/make-pot 1.4.0 → 1.5.1

package/tests/jsonParse.test.js

@@ -0,0 +1,167 @@
+const fs = require("node:fs");
+const { describe, it } = require("node:test");
+const assert = require("node:assert");
+const { parseJsonFile } = require("../lib");
+
+describe("should parse json", () => {
+	describe("should parse block.json", () => {
+		it("block.json", async () => {
+			const expected = [
+				{
+					msgid: "block title",
+					msgctxt: "my block title",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+				{
+					msgid: "block description",
+					msgctxt: "my block description",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+				{
+					msgid: "block keyword",
+					msgctxt: "my block keyword",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+				{
+					msgid: "block keyword",
+					msgctxt: "my block keyword 2",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+				{
+					msgid: "block keyword",
+					msgctxt: "my block keyword 3",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+			];
+
+			const result = await parseJsonFile({
+				fileContent: fs.readFileSync("tests/fixtures/block/block.json", "utf8"),
+				filename: "block.json",
+			});
+
+			assert.deepStrictEqual(result, expected);
+		});
+	});
+
+	describe("should parse theme.json", () => {
+		it("theme.json", async () => {
+			const expected = [
+				{
+					msgid: "Font size name",
+					msgctxt: "Extra small",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+				{
+					msgid: "Font size name",
+					msgctxt: "Small",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+				{
+					msgid: "Font size name",
+					msgctxt: "Medium",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+				{
+					msgid: "Font size name",
+					msgctxt: "Large",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+				{
+					msgid: "Font size name",
+					msgctxt: "Extra large",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+				{
+					msgid: "Font family name",
+					msgctxt: "System Fonts",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+				{
+					msgid: "Color name",
+					msgctxt: "Base",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+				{
+					msgid: "Color name",
+					msgctxt: "Contrast",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+				{
+					msgid: "Color name",
+					msgctxt: "Accent",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+				{
+					msgid: "Color name",
+					msgctxt: "Accent Two",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+				{
+					msgid: "Color name",
+					msgctxt: "Accent Three",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+				{
+					msgid: "Gradient name",
+					msgctxt: "Accent Two to Contrast",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+				{
+					msgid: "Template part name",
+					msgctxt: "Header",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+				{
+					msgid: "Template part name",
+					msgctxt: "Footer",
+					comments: {
+						reference: ["block.json"],
+					},
+				},
+			];
+
+			const result = await parseJsonFile({
+				fileContent: fs.readFileSync("tests/fixtures/fse/theme.json", "utf8"),
+				filename: "theme.json",
+			});
+
+			assert.deepStrictEqual(result, expected);
+		});
+	});
+});

package/tests/parse-headers.test.js

@@ -0,0 +1,74 @@
+const fs = require("node:fs");
+const { describe, it } = require("node:test");
+const assert = require("node:assert");
+const { generateHeader, getAuthorFromPackage } = require("../lib");
+const { join } = require("node:path");
+
+describe("Header generation", () => {
+	describe("Should generate a valid header", () => {
+		it("from user full data", async () => {
+			const expected = {};
+			const author = await getAuthorFromPackage({
+				authors: ["John Doe <1dHsK@example.com> (http://example.com)"],
+			});
+
+			assert.deepStrictEqual(author, {
+				name: "John Doe",
+				email: "1dHsK@example.com",
+				website: "http://example.com",
+			});
+		});
+
+		it("from user data", async () => {
+			const expected = {};
+			const author = await getAuthorFromPackage({
+				authors: ["erik"],
+			});
+
+			assert.deepStrictEqual(author, {
+				name: "erik",
+				email: undefined,
+				website: undefined,
+			});
+		});
+
+		it("from package.json data", async () => {
+			const expected = {
+				"Project-Id-Version": "plugin 1.0.0",
+				"Report-Msgid-Bugs-To": "John Doe <bbb@ccc.ddd>",
+				"MIME-Version": "1.0",
+				"Content-Transfer-Encoding": "8bit",
+				"content-type": "text/plain; charset=iso-8859-1",
+				"plural-forms": "nplurals=2; plural=(n!=1);",
+				"POT-Creation-Date": undefined,
+				"PO-Revision-Date": undefined,
+				"Last-Translator": "John Doe <bbb@ccc.ddd>",
+				"Language-Team": "John Doe <bbb@ccc.ddd>",
+				"X-Generator": "@wp-blocks/make-pot 1.5.1",
+				Language: "en",
+				"X-Domain": "plugin",
+			};
+
+			const result = await generateHeader({
+				headers: {
+					name: "my-block",
+					author: "John Doe",
+					version: "1.0.0",
+					license: "MIT",
+					homepage: "https://example.com",
+					repository: "https://github.com/example/my-block",
+					domain: "my-plugin-text-domain",
+				},
+				paths: {
+					cwd: join(process.cwd(), "tests/fixtures/plugin"),
+				},
+			});
+
+			// remove the date "POT-Creation-Date"
+			result["POT-Creation-Date"] = undefined;
+			result["PO-Revision-Date"] = undefined;
+
+			assert.deepStrictEqual(result, expected);
+		});
+	});
+});

package/tests/tree.test.js

@@ -1,158 +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);
-	});
-});
+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/tsconfig.json

@@ -8,6 +8,8 @@
 		"strict": true,
 		"downlevelIteration": true,
 		"esModuleInterop": true,
+		"forceConsistentCasingInFileNames": true,
+		"skipLibCheck": true,
 		"resolveJsonModule": true,
 		"outDir": "lib",
 		"rootDir": "src"

package/lib/extractors/utils.js

@@ -1 +0,0 @@
-"use strict";var a=Object.defineProperty;var k=Object.getOwnPropertyDescriptor;var m=Object.getOwnPropertyNames;var y=Object.prototype.hasOwnProperty;var x=(n,t)=>{for(var e in t)a(n,e,{get:t[e],enumerable:!0})},p=(n,t,e,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let s of m(t))!y.call(n,s)&&s!==e&&a(n,s,{get:()=>t[s],enumerable:!(r=k(t,s))||r.enumerable});return n};var B=n=>p(a({},"__esModule",{value:!0}),n);var j={};x(j,{gentranslation:()=>l,getKeyByValue:()=>O,yieldParsedData:()=>b});module.exports=B(j);var g=require("gettext-merger"),d=require("./json.js");function O(n,t){return Object.keys(n).find(e=>n[e]===t)??void 0}const l=(n,t,e)=>{const r=new g.Block([]);return r.msgctxt=void 0,r.msgid=t,r.msgid_plural="",r.msgstr=[],r.comments={extracted:[n],reference:[e]},r};function b(n,t,e){const r=new g.SetOfBlocks([],e);return n&&(r.path=e,Object.entries(n).forEach(([s,o])=>{function f(i,c=s){const u=l((0,d.getJsonComment)(s,t),c,e);r.add(u)}if(o)typeof o=="string"?f(o):Array.isArray(o)?o.forEach(i=>f(i)):Object.entries(o).forEach(([i,c])=>{typeof c=="string"&&f(c,i)});else return})),r}0&&(module.exports={gentranslation,getKeyByValue,yieldParsedData});

package/tests/getFiles.test.no.js

@@ -1,85 +0,0 @@
-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);
-	});
-});