@wp-blocks/make-pot 0.0.1

package/tests/extract.test.ts

@@ -0,0 +1,380 @@
+import { describe, expect } from '@jest/globals'
+import { doTree } from '../src/tree'
+
+describe('getStrings', () => {
+	it('should extract translations with context', () => {
+		const content = `<?php __('Hello World', 'greeting'); ?>`
+		const filename = 'filename.php'
+
+		const result = doTree(content, filename)
+
+		expect(result).toMatchObject({
+			'': {
+				'Hello World': {
+					comments: {
+						reference: 'filename.php:1',
+					},
+					msgid: 'Hello World',
+					msgstr: [],
+				},
+			},
+		})
+	})
+	it('should extract translations from code content with no context or translator comments', () => {
+		const content = `<?php _e('Hello World'); ?>`
+		const expected = {
+			'': {
+				'Hello World': {
+					comments: {
+						reference: 'filename.php:1',
+					},
+					msgid: 'Hello World',
+					msgstr: [],
+				},
+			},
+		}
+		const filename = 'filename.php'
+
+		const result = doTree(content, filename)
+
+		expect(result).toEqual(expected)
+	})
+
+	it('should extract translations with comments', () => {
+		const filename = 'filename.php'
+		const content = `
+		<?php /** translators: ciao! */ echo _x('Hello World', 'greeting'); ?>`
+		const expected = {
+			'': {
+				'Hello World': {
+					comments: {
+						reference: 'filename.php:2',
+						translator: 'ciao!',
+					},
+					msgid: 'Hello World',
+					msgstr: [],
+				},
+			},
+		}
+
+		const result = doTree(content, filename)
+
+		expect(result).toEqual(expected)
+	})
+
+	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 = {
+			'': {
+				'Hello World': {
+					comments: {
+						reference: 'filename.php:10',
+					},
+					msgid: 'Hello World',
+					msgstr: [],
+				},
+			},
+		}
+
+		const result = doTree(content, filename)
+
+		expect(result).toEqual(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: {
+							reference: 'filename.php:3',
+						},
+						msgid: 'Check out this link to my <a href="%s">website</a> made with WordPress.',
+						msgstr: [],
+					},
+			},
+		}
+
+		const result = doTree(content, filename)
+
+		expect(result).toEqual(expected)
+	})
+})
+describe('getStrings wp cli', () => {
+	it('should extract translations with translator comments inside the formatting hell', () => {
+		const filename = 'filename.php'
+		const content = `<?php /** 1*/
+/** 2*/ /** translators: 1: Site URL, 2: Username, 3: User email address, 4: Lost password URL. */
+                sprintf(__( 'Your site at %1$s is active. You may now log in to your site using your chosen username of &#8220;%2$s&#8221;. Please check your email inbox at %3$s for your password and login instructions. If you do not receive an email, please check your junk or spam folder. If you still do not receive an email within an hour, you can <a href="%4$s">reset your password</a>.' ),
+/** 6*/\t\t\tsprintf( '<a href="http://%1$s%2$s">%1$s%2$s</a>', $signup->domain, $blog_details->path ),
+/** 7*/\t\t\t$signup->user_login,
+/** 8*/\t\t\t$signup->user_email,
+/** 9*/\t\t\twp_lostpassword_url()
+/** 10*/\t\t);
+
+/** 11*/\t\techo __( 'aaaaaaa' );
+/** 12*/\t\techo __( 'aaaaaaa' );
+/** 13 */\t\techo __( 'aaaaaaa' );
+/** 14 */
+/** 15 */      printf(
+\t\t\t\t/* translators: 1: Site URL, 2: Username, 3: User email address, 4: Lost password URL. */
+\t\t\t__( 'aaaaaaa' ),
+/** 18 */\t\t\t\t);
+/** translators:aaaa */
+echo __( 'Your site at %1$s' )
+
+/** translators:aaaa */
+_e( 'Your site at %1$s' )`
+		const expected = [
+			{
+				'': {
+					'Your site at %1$s is active. You may now log in to your site using your chosen username of &#8220;%2$s&#8221;. Please check your email inbox at %3$s for your password and login instructions. If you do not receive an email, please check your junk or spam folder. If you still do not receive an email within an hour, you can <a href="%4$s">reset your password</a>.':
+						{
+							comments: {
+								reference: 'filename.php:3',
+							},
+							msgid: 'Your site at %1$s is active. You may now log in to your site using your chosen username of &#8220;%2$s&#8221;. Please check your email inbox at %3$s for your password and login instructions. If you do not receive an email, please check your junk or spam folder. If you still do not receive an email within an hour, you can <a href="%4$s">reset your password</a>.',
+							msgstr: [],
+						},
+				},
+			},
+			{
+				'': {
+					aaaaaaa: {
+						comments: {
+							reference: 'filename.php:10',
+						},
+						msgid: 'aaaaaaa',
+						msgstr: [],
+					},
+				},
+			},
+			{
+				'': {
+					aaaaaaa: {
+						comments: {
+							reference: 'filename.php:11',
+						},
+						msgid: 'aaaaaaa',
+						msgstr: [],
+					},
+				},
+			},
+			{
+				'': {
+					aaaaaaa: {
+						comments: {
+							reference: 'filename.php:12',
+						},
+						msgid: 'aaaaaaa',
+						msgstr: [],
+					},
+				},
+			},
+			{
+				'': {
+					aaaaaaa: {
+						comments: {
+							reference: 'filename.php:16',
+							translator: '',
+						},
+						msgid: 'aaaaaaa',
+						msgstr: [],
+					},
+				},
+			},
+			{
+				'': {
+					'Your site at %1$s': {
+						comments: {
+							reference: 'filename.php:19',
+						},
+						msgid: 'Your site at %1$s',
+						msgstr: [],
+					},
+				},
+			},
+		]
+
+		const result = doTree(content, filename)
+		expect(result).toMatchObject(result)
+	})
+
+	/** 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)
+
+		expect(result).toMatchSnapshot()
+	})
+
+	/** 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)
+
+		expect(result).toMatchSnapshot()
+	})
+})

package/tests/getFiles.test.ts

@@ -0,0 +1,114 @@
+import { describe, expect } from '@jest/globals'
+import { getFiles } from '../src/glob'
+import { Args, DomainType } from '../src/types'
+import { parseCliArgs } from '../src/cliArgs'
+import path from 'path'
+
+describe('getFiles', () => {
+	const DEFAULTS = parseCliArgs({
+		domain: 'plugin' as DomainType,
+		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' } as Args
+		const pattern = { include: ['**'], exclude: [] }
+
+		const files = await getFiles(args, pattern)
+		const collected: string[] = []
+		for (const file of files) {
+			expect(file).toBeTruthy()
+			collected.push(file)
+		}
+		expect(collected.length).toBeGreaterThan(2)
+		expect(collected.find((e) => e.includes('theme.json'))).toBeTruthy()
+	})
+	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' + path.sep + 'fixtures' + path.sep + 'file1.txt',
+			'tests' +
+				path.sep +
+				'fixtures' +
+				path.sep +
+				'sourcedir' +
+				path.sep +
+				'file2.txt',
+			'tests' +
+				path.sep +
+				'fixtures' +
+				path.sep +
+				'block' +
+				path.sep +
+				'readme.txt',
+		]
+
+		const files = await getFiles(args, pattern)
+		const collected: string[] = []
+		for (const file of files) {
+			expect(file).toBeTruthy()
+			collected.push(file)
+		}
+
+		expect(collected).toEqual(expectedFiles)
+	})
+	it('should retrieve a list of theme.json files based on the provided theme pattern', async () => {
+		const args = {
+			...DEFAULTS,
+		}
+		const pattern = {
+			include: ['**/*.json'],
+			exclude: [],
+		}
+		const expectedFiles = [
+			`sourcedir${path.sep}theme.json`,
+			`sourcedir${path.sep}package.json`,
+			`sourcedir${path.sep}node_modules${path.sep}module${path.sep}block.json`,
+			`node_modules${path.sep}block.json`,
+			`fse${path.sep}theme.json`,
+			`block${path.sep}block.json`,
+		]
+
+		const files = await getFiles(args, pattern)
+		let collected = []
+		for (const file of files) {
+			expect(file).toBeTruthy()
+			collected.push(file)
+		}
+		expect(
+			collected.filter((file) => !expectedFiles.includes(file))
+		).toBeTruthy()
+	})
+	it('Should retrieve a list of files without any node_modules folder', async () => {
+		const args = {
+			...DEFAULTS,
+		}
+		const pattern = {
+			include: ['**'],
+			exclude: ['node_modules'],
+		}
+
+		const files = await getFiles(args, pattern)
+		let collected = []
+		for (const file of files) {
+			expect(file).toBeTruthy()
+			collected.push(file)
+		}
+
+		// for each file check if that strings contains the node_modules folder
+		expect(collected.find((e) => e.includes('node_modules'))).toBeFalsy()
+		expect(collected.length).toBeGreaterThan(10)
+	})
+})

package/tests/getStrings.test.ts

@@ -0,0 +1,149 @@
+import { describe, expect } from '@jest/globals'
+import { getStrings } from '../src/parser'
+import { Args, DomainType } from '../src/types'
+import { getFiles } from '../src/glob'
+
+const args: Args = {
+	slug: 'plugin-slug',
+	paths: { cwd: 'tests/fixtures/sourcedir/', out: 'tests/fixtures/' },
+	domain: 'plugin' as DomainType,
+	patterns: {
+		include: ['**'],
+		exclude: [
+			'node_modules',
+			'vendor',
+			'dist',
+			'tests',
+			'package-lock.json',
+		],
+	},
+}
+
+describe('getStrings', () => {
+	it('Should build pot file', async () => {
+		const files = await getFiles(args as Args, {
+			include: ['file.php'],
+			exclude: ['node_modules', 'dist'],
+		})
+		const dataExtracted = await getStrings({ ...args } as Args, files)
+		const expected = {
+			'': {
+				sdasdasdasd: {
+					msgid: 'sdasdasdasd',
+					msgid_plural: undefined,
+					msgstr: [],
+				},
+				'strong magenta': {
+					msgid: 'strong magenta',
+					msgid_plural: undefined,
+					msgstr: [],
+				},
+				'light grayish magenta': {
+					msgid: 'light grayish magenta',
+					msgid_plural: undefined,
+					msgstr: [],
+				},
+				'very light gray': {
+					msgid: 'very light gray',
+					msgid_plural: undefined,
+					msgstr: [],
+				},
+				'very dark gray': {
+					msgid: 'very dark gray',
+					msgid_plural: undefined,
+					msgstr: [],
+				},
+				'Vivid cyan blue to vivid purple': {
+					msgid: 'Vivid cyan blue to vivid purple',
+					msgid_plural: undefined,
+					msgstr: [],
+				},
+				'Vivid green cyan to vivid cyan blue': {
+					msgid: 'Vivid green cyan to vivid cyan blue',
+					msgid_plural: undefined,
+					msgstr: [],
+				},
+				'Light green cyan to vivid green cyan': {
+					msgid: 'Light green cyan to vivid green cyan',
+					msgid_plural: undefined,
+					msgstr: [],
+				},
+				'Luminous vivid amber to luminous vivid orange': {
+					msgid: 'Luminous vivid amber to luminous vivid orange',
+					msgid_plural: undefined,
+					msgstr: [],
+				},
+				'Luminous vivid orange to vivid red': {
+					msgid: 'Luminous vivid orange to vivid red',
+					msgid_plural: undefined,
+					msgstr: [],
+				},
+				Small: {
+					msgid: 'Small',
+					msgid_plural: undefined,
+					msgstr: [],
+				},
+				Regular: {
+					msgid: 'Regular',
+					msgid_plural: undefined,
+					msgstr: [],
+				},
+				Large: {
+					msgid: 'Large',
+					msgid_plural: undefined,
+					msgstr: [],
+				},
+				Huge: {
+					msgid: 'Huge',
+					msgid_plural: undefined,
+					msgstr: [],
+				},
+			},
+		}
+		expect(dataExtracted).toMatchObject(expected)
+	})
+	it('Should build pot file from fixtures block.json', async () => {
+		const currentArgs = {
+			...args,
+			paths: { cwd: 'tests/fixtures/block/', out: 'tests/fixtures/' },
+			patterns: {
+				include: ['block.json'],
+				exclude: ['node_modules'],
+			},
+		} as Args
+		const files = await getFiles(currentArgs as Args, currentArgs.patterns)
+		const dataExtracted = await getStrings(currentArgs as Args, files)
+
+		const expected = {
+			'block variation keyword': {
+				undefined: {
+					msgstr: [],
+					msgid: 'undefined',
+					msgctxt: 'block variation keyword',
+				},
+			},
+			'block variation title': {
+				title: {
+					msgstr: [],
+					msgid: 'title',
+					msgctxt: 'block variation title',
+				},
+			},
+			'block variation description': {
+				description: {
+					msgstr: [],
+					msgid: 'description',
+					msgctxt: 'block variation description',
+				},
+			},
+			'block style label': {
+				label: {
+					msgstr: [],
+					msgid: 'label',
+					msgctxt: 'block style label',
+				},
+			},
+		}
+		expect(dataExtracted).toMatchObject(expected)
+	})
+})