Merge branch 'develop' of github.com:privatenumber/webpack-localize-assets-plugin

Author: privatenumber

.github/workflows/release.yml

@@ -11,19 +11,27 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/checkout@v3
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version-file: '.nvmrc'
+
+    - name: Setup pnpm
+      uses: pnpm/[email protected]
       with:
-        node-version: 14.x
-    - name: Install dependencies
-      run: npx ci
+        version: 7
+        run_install: true
+
     - name: Test
-      run: npm run test # Produces distribution via pretest
+      run: pnpm test # Produces distribution via pretest
+
     - name: Lint
-      run: npm run lint
+      run: pnpm lint
+
     - name: Release
       env:
         GH_TOKEN: ${{ secrets.GH_TOKEN }}
         NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-      run: npx semantic-release
+      run: pnpm dlx semantic-release

.github/workflows/test.yml

@@ -2,29 +2,37 @@ name: Test
 
 on:
   push:
-    branches: [develop]
+    branches: develop
   pull_request:
-    branches: [master, develop]
 
 jobs:
   test:
     name: Test
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        node-version: [12.x, 14.x]
-
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/checkout@v3
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v3
       with:
-        node-version: ${{ matrix.node-version }}
-    - name: Install dependencies
-      run: npx ci
-    - name: Test
-      run: npm run test
+        node-version-file: '.nvmrc'
+
+    - name: Setup pnpm
+      uses: pnpm/[email protected]
+      with:
+        version: 7
+        run_install: true
+
     - name: Lint
-      run: npm run lint
+      run: pnpm lint
+
+    - name: Type check
+      run: pnpm type-check
+
+    - name: Build
+      run: pnpm build
+
+    - name: Test
+      run: pnpm test

.npmrc

@@ -0,0 +1 @@
+shell-emulator=true

.nvmrc

@@ -1 +1 @@
-v14.16.1
+v16.17.0

README.md

@@ -58,10 +58,10 @@ Required
 
 Type:
 ```ts
-{
+type Locales = {
     [locale: string]: string | {
-        [stringKey: string]: string;
-    };
+        [stringKey: string]: string
+    }
 }
 ```
 
@@ -72,30 +72,36 @@ The key should be the locale name, and the value can either be _the path to the
 Using a JSON path has the advantage of automatically detecting changes across compilations, which is useful in development.
 
 Example:
-```json5
-{
-    en: './locales/en.json',
-    es: './locales/es.json',
-    ...
-}
+```js
+new LocalizeAssetsPlugin({
+    locales: {
+        en: './locales/en.json',
+        es: './locales/es.json'
+        // ...
+    }
+    // ...
+})
 ```
 
 Or:
 
-```json5
-{
-    en: {
-        helloWorld: 'Hello World!',
-        goodbyeWorld: 'Goodbye World!',
-        ...
-    },
-    es: {
-        helloWorld: '¡Hola Mundo!',
-        goodbyeWorld: '¡Adiós Mundo!',
-        ...
-    },
-    ...
-}
+```js
+new LocalizeAssetsPlugin({
+    locales: {
+        en: {
+            helloWorld: 'Hello World!',
+            goodbyeWorld: 'Goodbye World!'
+            // ...
+        },
+        es: {
+            helloWorld: '¡Hola Mundo!',
+            goodbyeWorld: '¡Adiós Mundo!'
+            // ...
+        }
+        // ...
+    }
+    // ...
+})
 ```
 
 #### functionName
@@ -106,7 +112,7 @@ Default: `__`
 The function name to use to detect localization string keys.
 
 ```js
-const message = __('helloWorld'); // => 'Hello world!'
+const message = __('helloWorld') // => 'Hello world!'
 ```
 #### throwOnMissing
 Type: `boolean`
@@ -130,23 +136,23 @@ Enable to see warnings when unused string keys are found.
 ### localizeCompiler
 Type:
 ```ts
-Record<
-    string, // localizer function name (eg. __)
-    (
+type LocalizeCompiler = {
+    // localizer function name (eg. __)
+    [functionName: string]: (
         this: LocalizeCompilerContext,
         localizerArguments: string[],
         localeName: string,
     ) => string
->
+}
 ```
 
 Default:
 ```ts
-{
+const localizeCompiler = {
     __(localizerArguments) {
-        const [key] = localizerArguments;
-        const keyResolved = this.resolveKey();
-        return keyResolved ? JSON.stringify(keyResolved) : key;
+        const [key] = localizerArguments
+        const keyResolved = this.resolveKey()
+        return keyResolved ? JSON.stringify(keyResolved) : key
     }
 }
 ```

jest.config.js

@@ -22,20 +22,35 @@
 	"files": [
 		"dist"
 	],
-	"main": "dist/index.js",
+	"main": "./dist/index.cjs",
+	"types": "./dist/index.d.ts",
+	"imports": {
+		"#webpack-localize-assets-plugin": {
+			"types": "./src/index.d.ts",
+			"development": "./src/index.ts",
+			"default": "./dist/index.cjs"
+		},
+		"webpack": {
+			"webpack5": "webpack5",
+			"default": "webpack"
+		},
+		"webpack/*": {
+			"webpack5": "webpack5/*",
+			"default": "webpack/*"
+		}
+	},
 	"scripts": {
+		"prepare": "simple-git-hooks",
 		"lint": "eslint .",
-		"build": "tsc",
-		"typecheck": "tsc --noEmit",
-		"pretest": "npm run build",
-		"test": "npm run test:wp4 && npm run test:wp5",
-		"test:wp4": "jest",
-		"test:wp5": "WEBPACK=5 jest"
+		"build": "pkgroll --target node12.20 --minify",
+		"type-check": "tsc --noEmit",
+		"dev": "tsx watch --loader alias-imports -C development -C webpack5 tests",
+		"test": "pnpm test:wp4 && pnpm test:wp5",
+		"test:wp4": "tsx --loader alias-imports tests",
+		"test:wp5": "tsx --loader alias-imports --conditions webpack5 tests"
 	},
-	"husky": {
-		"hooks": {
-			"pre-commit": "npm run build && lint-staged && npm test"
-		}
+	"simple-git-hooks": {
+		"pre-commit": "pnpm build && pnpm lint-staged && pnpm test"
 	},
 	"lint-staged": {
 		"*.{js,ts}": "eslint"
@@ -46,34 +61,42 @@
 	"dependencies": {
 		"@types/estree": "^0.0.50",
 		"acorn": "^8.6.0",
-		"astring": "^1.8.1",
+		"astring": "^1.8.3",
 		"has-own-prop": "^2.0.0",
-		"magic-string": "^0.25.7",
+		"magic-string": "^0.27.0",
 		"source-map": "^0.7.3",
 		"webpack-sources": "^2.2.0"
 	},
 	"devDependencies": {
-		"@pvtnbr/eslint-config": "^0.6.1",
+		"@pvtnbr/eslint-config": "^0.33.0",
 		"@types/estree": "^0.0.50",
-		"@types/jest": "^27.0.3",
 		"@types/mini-css-extract-plugin": "^2.4.0",
 		"@types/webpack": "^4.41.32",
 		"@types/webpack-manifest-plugin": "^3.0.5",
+		"@types/webpack-sources": "^3.2.0",
+		"alias-imports": "^1.0.0",
 		"css-loader": "^5.2.4",
-		"es-jest": "^1.5.0",
-		"eslint": "^7.32.0",
-		"husky": "^4.3.8",
-		"jest": "^27.3.1",
+		"eslint": "^8.28.0",
 		"lint-staged": "^12.1.2",
+		"manten": "^0.6.0",
 		"mini-css-extract-plugin": "^1.6.0",
+		"pkgroll": "^1.5.0",
+		"simple-git-hooks": "^2.8.0",
 		"tempy": "^1.0.1",
-		"typescript": "^4.5.2",
+		"terser-webpack-plugin": "^5.3.6",
+		"tsx": "^3.12.1",
+		"typescript": "^4.9.3",
 		"webpack": "4.42.0",
 		"webpack-manifest-plugin": "^3.1.1",
-		"webpack-test-utils": "^1.1.0",
+		"webpack-test-utils": "^2.1.0",
 		"webpack5": "npm:[email protected]"
 	},
 	"eslintConfig": {
 		"extends": "@pvtnbr"
+	},
+	"pnpm": {
+		"patchedDependencies": {
+			"[email protected]": "patches/[email protected]"
+		}
 	}
 }

package.json

@@ -0,0 +1,12 @@
+diff --git a/package.json b/package.json
+index a37dc0a9959d745b2ef53e3c5432304580ac30aa..1a56d24a079924ab86c141fa8e91133be43689a6 100644
+--- a/package.json
++++ b/package.json
+@@ -6,6 +6,7 @@
+   "module": "./dist/astring.mjs",
+   "types": "./astring.d.ts",
+   "exports": {
++    "types": "./astring.d.ts",
+     "import": "./dist/astring.mjs",
+     "require": "./dist/astring.js",
+     "browser": "./dist/astring.min.js"