@wp-blocks/make-pot 1.0.2 → 1.2.0

package/tests/getFiles.test.ts

@@ -1,114 +1,114 @@
-import { describe, expect } from '@jest/globals'
-import { getFiles } from '../src/fs/glob'
-import { Args, DomainType } from '../src/types'
-import path from 'path'
-import { parseCliArgs } from '../src/cli/parseCli'
-
-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)
-	})
-})
+import { describe, expect } from '@jest/globals'
+import { getFiles } from '../src/fs/glob'
+import { Args, DomainType } from '../src/types'
+import path from 'path'
+import { parseCliArgs } from '../src/cli/parseCli'
+
+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)
+		const 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)
+		const 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/ignoreFunction.test.ts

@@ -1,126 +1,102 @@
-import { describe, expect } from '@jest/globals'
-import { Glob, Path } from 'glob'
-import path from 'path'
-import { minimatch } from 'minimatch'
-import { ignoreFunc } from '../src/fs/glob'
-
-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)
-	})
-})
-
-const tests = [
-	{
-		title: 'defaults',
-		src: '.',
-		exclude: [
-			'.git',
-			'node_modules',
-			'vendor',
-			'build',
-			'dist',
-			'uploads',
-			'Gruntfile.js',
-			'webpack.config.js',
-			'**/*.min.js',
-			'tsconfig.js',
-			'**.test.**',
-			'tests',
-			'coverage',
-			'**/extractors**',
-			'**/*.js.map',
-			'**/lib/c**.d.ts',
-			'**/**tt**',
-		],
-		result: 20,
-	},
-	{
-		title: 'exclude file.php',
-		src: 'tests/fixtures/sourcedir',
-		exclude: ['file.php'],
-		result: [
-			'theme.json',
-			'svgTools.ts',
-			'plugin-header.php',
-			'package.json',
-			'file2.txt',
-			'vendor' + path.sep + 'index.php',
-			'node_modules' + path.sep + 'module' + path.sep + 'block.json',
-		],
-	},
-	{
-		title: 'exclude node_modules and vendor',
-		src: 'tests/fixtures/sourcedir',
-		exclude: ['node_modules', 'vendor'],
-		result: [
-			'theme.json',
-			'svgTools.ts',
-			'plugin-header.php',
-			'package.json',
-			'file2.txt',
-			'file.php',
-		],
-	},
-	{
-		title: 'globstar path',
-		src: 'tests/fixtures',
-		exclude: ['**/*.php', '**/*.json', 'block/**'],
-		result: 15,
-	},
-	{
-		title: 'should exclude globstar',
-		src: 'tests/fixtures/',
-		exclude: ['**'],
-		result: [],
-	},
-	{
-		title: 'should remove excluded patterns',
-		src: 'tests/fixtures/node_modules',
-		exclude: [],
-		result: ['block.json'],
-	},
-]
-
-describe('testing the ignoreFunc used to ignore files', () => {
-	tests.forEach((test) => {
-		it('should ignore files ' + test.title, () => {
-			const foundDirs: string[] = []
-
-			const dirs = new Glob('**', {
-				ignore: {
-					ignored: (p: Path) => ignoreFunc(p, test.exclude),
-				},
-				nodir: true,
-				cwd: path.join(process.cwd(), test.src),
-			})
-
-			for (const dir of dirs) {
-				foundDirs.push(dir)
-			}
-
-			if (typeof test.result === 'number') {
-				expect(foundDirs.length).toBeGreaterThanOrEqual(test.result)
-			} else {
-				expect(foundDirs).toStrictEqual(test.result)
-			}
-		})
-	})
-})
+import { describe, expect } from '@jest/globals'
+import { Glob, Path } from 'glob'
+import path from 'path'
+import { ignoreFunc } from '../src/fs/glob'
+
+const tests = [
+	{
+		title: 'defaults',
+		src: '.',
+		exclude: [
+			'.git',
+			'node_modules',
+			'vendor',
+			'build',
+			'dist',
+			'uploads',
+			'Gruntfile.js',
+			'webpack.config.js',
+			'**/*.min.js',
+			'tsconfig.js',
+			'**.test.**',
+			'tests',
+			'coverage',
+			'**/extractors**',
+			'**/*.js.map',
+			'**/lib/c**.d.ts',
+			'**/**tt**',
+		],
+		result: 20,
+	},
+	{
+		title: 'exclude file.php',
+		src: 'tests/fixtures/sourcedir',
+		exclude: ['file.php'],
+		result: [
+			'theme.json',
+			'svgTools.ts',
+			'sourcedir.php',
+			'package.json',
+			'file2.txt',
+			'vendor' + path.sep + 'index.php',
+			'node_modules' + path.sep + 'module' + path.sep + 'block.json',
+		],
+	},
+	{
+		title: 'exclude node_modules and vendor',
+		src: 'tests/fixtures/sourcedir',
+		exclude: ['node_modules', 'vendor'],
+		result: [
+			'theme.json',
+			'svgTools.ts',
+			'sourcedir.php',
+			'package.json',
+			'file2.txt',
+			'file.php',
+		],
+	},
+	{
+		title: 'globstar path',
+		src: 'tests/fixtures',
+		exclude: ['**/*.php', '**/*.json', 'block/**'],
+		result: 15,
+	},
+	{
+		title: 'should exclude globstar',
+		src: 'tests/fixtures/',
+		exclude: ['**'],
+		result: [],
+	},
+	{
+		title: 'should remove excluded patterns',
+		src: 'tests/fixtures/node_modules',
+		exclude: [],
+		result: ['block.json'],
+	},
+]
+
+describe('testing the ignoreFunc used to ignore files', () => {
+	tests.forEach((test) => {
+		it('should ignore files ' + test.title, () => {
+			const foundDirs: string[] = []
+
+			const dirs = new Glob('**', {
+				ignore: {
+					ignored: (p: Path) => ignoreFunc(p, test.exclude),
+				},
+				nodir: true,
+				cwd: path.join(test.src),
+			})
+
+			for (const dir of dirs) {
+				foundDirs.push(dir)
+			}
+
+			if (typeof test.result === 'number') {
+				expect(foundDirs.length).toBeGreaterThanOrEqual(test.result)
+			} else {
+				expect(foundDirs).toStrictEqual(test.result)
+			}
+		})
+	})
+})

package/tests/tree.test.ts

@@ -138,15 +138,14 @@ describe('doTree php test file', () => {
 
 		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/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;