@wp-blocks/make-pot 1.0.1 → 1.0.2

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

@@ -1,76 +1,85 @@
-import { describe, expect } from '@jest/globals'
-import { Args, DomainType } from '../src/types'
-import { getFiles } from '../src/glob'
-import { getStrings } from '../src/parser/process'
-
-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)
-
-		expect(dataExtracted).toMatchSnapshot()
-	})
-	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)
-	})
-})
+import { describe, expect } from '@jest/globals'
+import { Args, DomainType } from '../src/types'
+import { getFiles } from '../src/fs/glob'
+import { getStrings } from '../src/parser/process'
+
+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)
+
+		expect(dataExtracted).toMatchSnapshot()
+	})
+})
+
+describe('getFiles', () => {
+	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 = [
+			{
+				'': {
+					description: {
+						comments: {
+							extracted: 'description',
+							reference: 'tests\\fixtures\\block\\block.json',
+						},
+						msgctxt: undefined,
+						msgid: 'description',
+						msgid_plural: '',
+						msgstr: [],
+					},
+					keywords: {
+						comments: {
+							extracted: 'keywords',
+							reference: 'tests\\fixtures\\block\\block.json',
+						},
+						msgctxt: undefined,
+						msgid: 'keywords',
+						msgid_plural: '',
+						msgstr: [],
+					},
+					title: {
+						comments: {
+							extracted: 'title',
+							reference: 'tests\\fixtures\\block\\block.json',
+						},
+						msgctxt: undefined,
+						msgid: 'title',
+						msgid_plural: '',
+						msgstr: [],
+					},
+				},
+			},
+		]
+		expect(dataExtracted).toMatchObject(expected)
+	})
+})

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

@@ -1,128 +1,126 @@
-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)
-	})
-})
-
-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 { 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)
+			}
+		})
+	})
+})

package/tests/{jsonParse.ts → jsonParse.test.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

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