@wp-blocks/make-pot 1.0.1 → 1.2.0

package/tests/extract.test.ts

@@ -1,5 +1,6 @@
 import { describe, expect } from '@jest/globals'
 import { doTree } from '../src/parser/tree'
+import { Block } from 'gettext-merger'
 
 describe('getStrings', () => {
 	it('should extract translations from js', () => {
@@ -7,36 +8,34 @@ describe('getStrings', () => {
 		const filename = 'filename.js'
 
 		const result = doTree(content, filename)
+		const expected = new Block([])
+		expected.msgid = 'Hello World'
+		expected.comments = {
+			reference: ['filename.js:1'],
+			translator: [''],
+		}
 
-		expect(result).toMatchObject({
-			'': {
-				'Hello World': {
-					comments: {
-						reference: 'filename.js:1',
-					},
-					msgid: 'Hello World',
-					msgstr: [''],
-				},
-			},
-		})
+		expect(result.blocks[0].msgid).toBe(expected.msgid)
 	})
+
 	it('should extract translations from ts', () => {
 		const content = `__('Hello World', 'greeting');`
 		const filename = 'filename.ts'
 
-		const result = doTree(content, filename)
+		const result = doTree(content, filename).blocks[0].toJson()
 
-		expect(result).toMatchObject({
-			'': {
-				'Hello World': {
-					comments: {
-						reference: 'filename.ts:1',
-					},
-					msgid: 'Hello World',
-					msgstr: [''],
-				},
-			},
-		})
+		const expected = new Block([])
+		expected.msgid = 'Hello World'
+		expected.comments = {
+			reference: ['filename.ts:1'],
+			translator: [''],
+		}
+
+		expect(result.msgid).toBe(expected.msgid)
+		expect(expected.comments?.reference).toHaveLength(1)
+		expect([result.comments?.reference]).toEqual(
+			expected.comments?.reference
+		)
 	})
 	it('should extract translations from tsx', () => {
 		const content = `const element = <h1>{ __('Hello World', 'greeting')}</h1>;`
@@ -45,17 +44,15 @@ describe('getStrings', () => {
 
 		const result = doTree(content, filename)
 
-		expect(result).toMatchObject({
-			'': {
-				'Hello World': {
-					comments: {
-						reference: 'filename.tsx:1',
-					},
-					msgid: 'Hello World',
-					msgstr: [''],
-				},
-			},
-		})
+		const expected = new Block([])
+		expected.msgid = 'Hello World'
+		expected.msgstr = ['']
+		expected.comments = {
+			reference: ['filename.tsx:1'],
+			translator: [''],
+		}
+
+		expect(result.blocks[0].toJson()).toEqual(expected.toJson())
 	})
 	it('should extract translations with context', () => {
 		const content = `<?php __('Hello World', 'greeting'); ?>`
@@ -63,42 +60,30 @@ describe('getStrings', () => {
 
 		const result = doTree(content, filename)
 
-		expect(result).toMatchObject({
-			'': {
-				'Hello World': {
-					comments: {
-						reference: 'filename.php:1',
-						translator: '',
-					},
-					msgctxt: '',
-					msgid: 'Hello World',
-					msgid_plural: '',
-					msgstr: [''],
-				},
-			},
-		})
+		const expected = new Block([])
+		expected.msgid = 'Hello World'
+		expected.msgstr = ['']
+		expected.comments = {
+			reference: ['filename.php:1'],
+			translator: [''],
+		}
+
+		expect(result.blocks[0].toJson()).toEqual(expected.toJson())
 	})
 	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',
-						translator: '',
-					},
-					msgctxt: '',
-					msgid: 'Hello World',
-					msgstr: [''],
-					msgid_plural: '',
-				},
-			},
+		const expected = new Block([])
+		expected.msgid = 'Hello World'
+		expected.msgstr = ['']
+		expected.comments = {
+			translator: undefined,
+			reference: ['filename.php:1'],
 		}
 		const filename = 'filename.php'
 
 		const result = doTree(content, filename)
 
-		expect(result).toEqual(expected)
+		expect(result.blocks[0]).toEqual(expected)
 	})
 
 	it('should extract translations with comments', () => {
@@ -106,18 +91,18 @@ describe('getStrings', () => {
 		const content = `
 		<?php /** translators: ciao! */ echo _x('Hello World', 'greeting'); ?>`
 		const expected = {
-			greeting: {
-				'Hello World': {
+			blocks: [
+				{
 					comments: {
-						reference: 'filename.php:2',
-						translator: 'ciao!',
+						reference: ['filename.php:2'],
+						translator: ['ciao!'],
 					},
 					msgctxt: 'greeting',
 					msgid: 'Hello World',
-					msgid_plural: '',
 					msgstr: [''],
 				},
-			},
+			],
+			path: 'filename.php',
 		}
 
 		const result = doTree(content, filename)
@@ -137,24 +122,14 @@ describe('getStrings', () => {
 
 
 		<?php echo _x('Hello World', 'greeting'); ?>`
-		const expected = {
-			greeting: {
-				'Hello World': {
-					msgctxt: 'greeting',
-					msgid: 'Hello World',
-					msgid_plural: '',
-					msgstr: [''],
-					comments: {
-						translator: '',
-						reference: 'filename.php:10',
-					},
-				},
-			},
-		}
+		const expected = `#: filename.php:10
+msgctxt "greeting"
+msgid "Hello World"
+msgstr ""`
 
 		const result = doTree(content, filename)
 
-		expect(result).toMatchObject(expected)
+		expect(result.blocks[0].toStr()).toBe(expected)
 	})
 
 	it('should extract translations inside a sprint', () => {
@@ -168,9 +143,15 @@ echo $link;`
 				'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: [''],
 					},
 			},
@@ -178,11 +159,36 @@ echo $link;`
 
 		const result = doTree(content, filename)
 
-		expect(result).toMatchObject(expected)
+		expect(result.toJson()).toMatchObject(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)
+		expect(result).toMatchSnapshot()
+	})
+
 	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 ) {
@@ -190,10 +196,10 @@ describe('getStrings wp cli', () => {
 		WP_CLI::warning(
 		  sprintf(
 		    /* Translators: %1$d is number of errors and %2$s is the formatted array of order IDs. */
-		    _n(
+		      _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( $errors_in_remigrate_batch ),
+		     	count( %s ),
 		        'woocommerce'
 		      ),
 		    count( $errors_in_remigrate_batch ),
@@ -204,26 +210,11 @@ describe('getStrings wp cli', () => {
 			WP_CLI::warning( 'Re-migration successful.', 'woocommerce' );
 		}
 `
-		const expected = {
-			'': {
-				'%1$d error found: %2$s when re-migrating order. Please review the error above.':
-					{
-						comments: {
-							reference: 'filename.php:6',
-							translator:
-								'%1$d is number of errors and %2$s is the formatted array of order IDs.',
-						},
-						msgctxt: '',
-						msgid: '%1$d error found: %2$s when re-migrating order. Please review the error above.',
-						msgid_plural:
-							'%1$d errors found: %2$s when re-migrating orders. Please review the errors above.',
-						msgstr: ['', ''],
-					},
-			},
-		}
 
 		const result = doTree(content, filename)
-		expect(expected).toMatchObject(result)
+		expect(
+			'%1$d error found: %2$s when re-migrating order. Please review the error above.'
+		).toBe(result.blocks[0].msgid)
 	})
 
 	/** see https://github.com/wp-cli/i18n-command/blob/main/features/makepot.feature */

package/tests/{getFiles.old.ts → getFiles.test.ts}

@@ -1,5 +1,5 @@
 import { describe, expect } from '@jest/globals'
-import { getFiles } from '../src/glob'
+import { getFiles } from '../src/fs/glob'
 import { Args, DomainType } from '../src/types'
 import path from 'path'
 import { parseCliArgs } from '../src/cli/parseCli'
@@ -82,7 +82,7 @@ describe('getFiles', () => {
 		]
 
 		const files = await getFiles(args, pattern)
-		let collected = []
+		const collected = []
 		for (const file of files) {
 			expect(file).toBeTruthy()
 			collected.push(file)
@@ -101,7 +101,7 @@ describe('getFiles', () => {
 		}
 
 		const files = await getFiles(args, pattern)
-		let collected = []
+		const collected = []
 		for (const file of files) {
 			expect(file).toBeTruthy()
 			collected.push(file)

package/tests/{ingnoreFunction.old.ts → ignoreFunction.test.ts}

@@ -1,33 +1,7 @@
 import { describe, expect } from '@jest/globals'
 import { Glob, Path } from 'glob'
-import { ignoreFunc } from '../src/glob'
 import path from 'path'
-import { minimatch } from 'minimatch'
-
-const sep = path.sep
-
-describe('includes or not', () => {
-	it('paths includes', () => {
-		expect(
-			path
-				.normalize(
-					'D:\\vvv-local\\www\\phpeighttwo\\public_html\\wp-content\\plugins\\makePot\\tests\\fixtures'
-				)
-				.includes('tests')
-		).toBe(true)
-		expect(
-			path.normalize(
-				path.relative(
-					'D:\\vvv-local\\www\\phpeighttwo\\public_html\\wp-content\\plugins\\makePot\\tests\\fixtures',
-					'tests'
-				)
-			)
-		).toBe('..')
-		expect(
-			minimatch(path.normalize('block/SvgControls.tsx'), 'block/**')
-		).toBe(true)
-	})
-})
+import { ignoreFunc } from '../src/fs/glob'
 
 const tests = [
 	{
@@ -61,7 +35,7 @@ const tests = [
 		result: [
 			'theme.json',
 			'svgTools.ts',
-			'plugin-header.php',
+			'sourcedir.php',
 			'package.json',
 			'file2.txt',
 			'vendor' + path.sep + 'index.php',
@@ -75,7 +49,7 @@ const tests = [
 		result: [
 			'theme.json',
 			'svgTools.ts',
-			'plugin-header.php',
+			'sourcedir.php',
 			'package.json',
 			'file2.txt',
 			'file.php',
@@ -111,7 +85,7 @@ describe('testing the ignoreFunc used to ignore files', () => {
 					ignored: (p: Path) => ignoreFunc(p, test.exclude),
 				},
 				nodir: true,
-				cwd: path.join(process.cwd(), test.src),
+				cwd: path.join(test.src),
 			})
 
 			for (const dir of dirs) {

package/tests/jsonParse.ts

@@ -1,61 +1,51 @@
-import { describe, expect } from '@jest/globals'
-import { parseJsonFile } from '../src/extractors/json'
-import fs from 'fs'
-
-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: [],
-				},
-			},
-			'block title': {
-				title: {
-					comments: {
-						reference: 'block/block.json',
-					},
-					msgctxt: 'block title',
-					msgid: 'title',
-					msgstr: [],
-				},
-			},
-		}
-
-		const result = await parseJsonFile({
-			sourceCode: fs.readFileSync(
-				'tests/fixtures/block/block.json',
-				'utf8'
-			),
-			filename: 'block.json',
-			filepath: 'block/block.json',
-		})
-
-		expect(result).toEqual(expected)
-	})
-})
+import { describe, expect } from '@jest/globals'
+import { parseJsonFile } from '../src/extractors/json'
+import fs from 'fs'
+
+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',
+		})
+
+		expect(result).toEqual(expected)
+	})
+})

package/tests/{extract-2.test.ts → tree.test.ts}

@@ -1,7 +1,55 @@
 import { describe, expect } from '@jest/globals'
 import { doTree } from '../src/parser/tree'
+import fs from 'fs'
+
+import path from 'path'
+
+describe('doTree js', () => {
+	const filepath = 'tests/fixtures/block/javascript.js'
+	let filePath: string
+	let fileContent: string
+	beforeAll(() => {
+		filePath = path.join(process.cwd(), filepath)
+		console.log('My file path is: ' + filePath)
+		fileContent = fs.readFileSync(filePath, 'utf8')
+	})
+	test('Should parse TSX file and extract strings', () => {
+		const fileParsed = doTree(fileContent, filepath)
+		expect(fileParsed).toMatchSnapshot()
+	})
+})
+
+describe('doTree php', () => {
+	const filepath = 'tests/fixtures/sourcedir/file.php'
+	let filePath: string
+	let fileContent: string
+	beforeAll(() => {
+		filePath = path.join(process.cwd(), filepath)
+		console.log('My file path is: ' + filePath)
+		fileContent = fs.readFileSync(filePath, 'utf8')
+	})
+	test('Should parse TSX file and extract strings', () => {
+		const fileParsed = doTree(fileContent, filepath)
+		expect(fileParsed).toMatchSnapshot()
+	})
+})
+
+describe('doTree tsx file', () => {
+	const filepath = 'tests/fixtures/block/SvgControls.tsx'
+	let filePath: string
+	let fileContent: string
+	beforeAll(() => {
+		filePath = path.join(process.cwd(), filepath)
+		console.log('My file path is: ' + filePath)
+		fileContent = fs.readFileSync(filePath, 'utf8')
+	})
+	test('Should parse TSX file and extract strings', () => {
+		const fileParsed = doTree(fileContent, filepath)
+		expect(fileParsed).toMatchSnapshot()
+	})
+})
 
-describe('getStrings-extra', () => {
+describe('doTree php test file', () => {
 	/** see wp cli tests */
 	it('should extract translations and comments from code content', () => {
 		const content = `<?php
@@ -90,15 +138,14 @@ describe('getStrings-extra', () => {
 
 		const filename = 'filename.php'
 
-		const r = doTree(content, filename)
+		const r = doTree(content, filename).blocks
 		const res = Object.values(r)[0]
-		const translations = Object.keys(res)
-		const comments = Object.entries(res).filter(
-			([x, translation]) => !!translation.comments?.translator
-		)
 
-		expect(translations.length).toBeGreaterThanOrEqual(19)
-		expect(comments.length).toBeGreaterThanOrEqual(8)
+		/** TODO: fix this test - btw i counted 19 blocks and 8 comments in the test file */
+		expect(r.map((block) => block).length).toBeGreaterThanOrEqual(19)
+		expect(
+			r.filter((block) => block.comments).length
+		).toBeGreaterThanOrEqual(8)
 		expect(res).toMatchSnapshot()
 	})
 })

package/tsconfig.json

@@ -1,8 +1,8 @@
 {
 	"compilerOptions": {
-		"module": "commonjs",
-		"target": "ES2015",
-		"lib": [ "Es6" ],
+		"module": "NodeNext",
+		"target": "ES2021",
+		"lib": [ "es2021" ],
 		"noImplicitAny": true,
 		"removeComments": true,
 		"preserveConstEnums": true,

package/.github/workflows/node.js.yml

@@ -1,33 +0,0 @@
-# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
-
-name: Node.js CI
-
-on:
-  push:
-    branches: [ "master" ]
-  pull_request:
-    branches: [ "master" ]
-
-jobs:
-  build:
-
-    runs-on: ${{ matrix.os }}
-
-    strategy:
-      matrix:
-        node-version: [lts/*, latest]
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-    - run: npm install
-    - run: npm run build --if-present
-    - run: npm test
-

package/.github/workflows/tsDoc.yml

@@ -1,52 +0,0 @@
-# Simple workflow for deploying static content to GitHub Pages
-name: TypeDoc generation
-
-on:
-  release:
-    branches: [ "master" ]
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
-
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-jobs:
-  # Single deploy job since we're just deploying
-  deploy:
-    name: Deploy Documentation
-
-    # Deploy to the github-pages environment
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-
-    # Specify runner + deployment step
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: TypeDoc Action
-        uses: erikyo/tsdoc-action@v1
-        with:
-          source_dir: ./src/**/*
-          output_dir: ./docs
-          skipErrorChecking: true
-          darkHighlightTheme: dark-plus
-          basePath: ./src/
-
-      - name: Setup Pages
-        uses: actions/configure-pages@v3
-
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v2
-        with:
-          # Upload entire repository
-          path: './docs'
-
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v2

package/lib/cliArgs.d.ts

@@ -1,4 +0,0 @@
-import yargs from 'yargs';
-import { Args } from './types';
-export declare function getArgs(): Args;
-export declare function parseCliArgs(args: yargs.PositionalOptions & yargs.Options & yargs.Arguments): Args;