first commit

Author: septs

.github/workflows/test.yaml

@@ -0,0 +1,18 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
+name: Test FormatJS Webpack Loader
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+      - run: npm ci
+      - run: npm test

.gitignore

@@ -0,0 +1,3 @@
+/dist
+/node_modules
+/*.tgz

.mocharc.json

@@ -0,0 +1,6 @@
+{
+  "require": ["tsx"],
+  "recursive": true,
+  "extension": [".ts"],
+  "spec": "tests/**/*.spec.ts"
+}

.npmignore

@@ -0,0 +1,5 @@
+/.vscode
+/src
+/tests
+/.*rc.json
+/tsconfig.json

.nvmrc

@@ -0,0 +1 @@
+v22.13.0

.prettierrc.json

@@ -0,0 +1,5 @@
+{
+  "printWidth": 120,
+  "singleQuote": true,
+  "semi": false
+}

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.ts": "always"
+  }
+}

LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2025 Nice-Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,119 @@
+# @nice-labs/formatjs-webpack-loader
+
+A webpack loader for [FormatJS](https://formatjs.io), precompiles ICU MessageFormat strings, improve performance by avoiding runtime parsing of ICU messages.
+
+## Features
+
+- Through Webpack loader precompile ICU MessageFormat strings
+- Integrates seamlessly with webpack build process.
+
+## Installation
+
+```bash
+npm install --save-dev @nice-labs/formatjs-webpack-loader
+```
+
+## Usage
+
+Add the loader to your webpack configuration:
+
+```typescript
+import * as path from 'node:path'
+import type { Configuration } from 'webpack'
+
+export default {
+  // ...
+  module: {
+    rules: [
+      // ...
+      {
+        test: /\.json$/,
+        loader: require.resolve('@nice-labs/formatjs-webpack-loader'),
+        options: {
+          // Loader options here
+        },
+        include: [
+          // Specify the directories or files to include
+          path.resolve(__dirname, 'src', 'locales'),
+        ],
+      },
+      // ...
+    ],
+  },
+  // ...
+} satisfies Configuration
+```
+
+in the above example, the loader is applied to all `.json` files in the `src/locales` directory.
+
+in your source code, you can import the messages like this:
+
+```typescript
+import messages from './locales/en-US.json'
+// stored file format: Record<string, MessageDescriptor>
+//   used file format: Record<string, MessageFormatElement[]>
+```
+
+Precompiled files do not need to be stored or tracked in codebase, this webpack loader will handle it for you
+
+## Loader Options
+
+### **`format`** (optional, default: `default`)
+
+The format of the input. It can be one of the following:
+
+- [`default`]
+- [`lokalise`]
+- `simple`: flattern object
+- [`smartling`]
+- [`transifex`]
+
+[`default`]: https://formatjs.github.io/docs/react-intl/api/#message-descriptor
+[`lokalise`]: https://docs.lokalise.com/en/articles/3229161-structured-json
+[`smartling`]: https://help.smartling.com/hc/en-us/articles/360008000733-JSON
+[`transifex`]: https://help.transifex.com/en/articles/6220899-structured-json
+
+### **`pseudo-locale`** (optional, default: unset)
+
+The pseudo locale to use for the input. It can be one of the following:
+
+- `xx-LS`: Append `'S' * 25` at the end to simulate long string
+- `xx-AC`: `toUpperCase` everything
+- `xx-HA`: Prefix `[javascript]` to the message
+- `en-XA`: Convert letter to **hebrew letter**
+- `en-XB`: Convert letter to **accented letter**
+
+See <https://github.com/formatjs/formatjs/issues/2165#issuecomment-701738341>
+
+### **`ignoreTag`** (optional, default: `false`)
+
+Whether to treat HTML/XML tags as string literal instead of parsing them as tag token.
+When this is false we only allow simple tags without any attributes
+
+### **`requiresOtherClause`** (optional, default: `false`)
+
+Should `select`, `selectordinal`, and `plural` arguments always include the `other` case clause.
+
+### **`shouldParseSkeletons`** (optional, default: `false`)
+
+Whether to parse number/datetime skeleton into [Intl.NumberFormatOptions] and [Intl.DateTimeFormatOptions], respectively.
+
+[Intl.NumberFormatOptions]: https://formatjs.github.io/docs/intl/#formatnumber
+[Intl.DateTimeFormatOptions]: https://formatjs.github.io/docs/intl/#formatdate
+
+## Resource Query
+
+### **`pseudo-locale`**
+
+for example:
+
+```ts
+import messages from './locales/en-US.json?pseudo-locale=xx-LS'
+// pseudo locale will be applied to the messages
+```
+
+more see <https://webpack.js.org/concepts/loaders/>
+
+## LICENSE
+
+[MIT LICENSE](LICENSE.txt)