Discource-C/discourse
1
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2025-02-19 01:46:01 +00:00
Code Issues Packages Projects Releases Wiki Activity
discourse/app/assets/javascripts/discourse-i18n/package.json

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

37 lines
680 B
JSON
Raw Normal View History

DEV: convert I18n pseudo package into real package (discourse-i18n) (#23867) Currently, `window.I18n` is defined in an old school hand written script, inlined into locale/*.js by the Rails asset pipeline, and then the global variable is shimmed into a pseudo AMD module later in `module-shims.js`. This approach has some problems – for one thing, when we add a new V2 addon (e.g. in #23859), Embroider/Webpack is stricter about its dependencies and won't let you `import from "I18n";` when `"I18n"` isn't listed as one of its `dependencies` or `peerDependencies`. This moves `I18n` into a real package – `discourse-i18n`. (I was originally planning to keep the `I18n` name since it's a private package anyway, but NPM packages are supposed to have lower case names and that may cause problems with other tools.) This package defines and exports a regular class, but also defines the default global instance for backwards compatibility. We should use the exported class in tests to make one-off instances without mutating the global instance and having to clean it up after the test run. However, I did not attempt that refactor in this PR. Since `discourse-i18n` is now included by the app, the locale scripts needs to be loaded after the app chunks. Since no "real" work happens until later on when we kick things off in the boot script, the order in which the script tags appear shouldn't be a problem. Alternatively, we can rework the locale bundles to be more lazy like everything else, and require/import them into the app. I avoided renaming the imports in this commit since that would be quite noisy and drowns out the actual changes here. Instead, I used a Webpack alias to redirect the current `"I18n"` import to the new package for the time being. In a separate commit later on, I'll rename all the imports in oneshot and remove the alias. As always, plugins and the legacy bundles (admin/wizard) still relies on the runtime AMD shims regardless. For the most part, I avoided refactoring the actual I18n code too much other than making it a class, and some light stuff like `var` into `let`. However, now that it is in a reasonable format to work with (no longer inside the global script context!) it may also be a good opportunity to refactor and make clear what is intended to be public API vs internal implementation details. Speaking of, I took the librety to make `PLACEHOLDER`, `SEPARATOR` and `I18nMissingInterpolationArgument` actual constants since it seemed pretty clear to me those were just previously stashed on to the `I18n` global to avoid polluting the global namespace, rather than something we expect the consumers to set/replace.
2023-10-12 06:44:01 -07:00
{
"name": "discourse-i18n",
"version": "1.0.0",
"private": true,
"description": "Discourse's i18n",
"author": "Discourse <team@discourse.org>",
"license": "GPL-2.0-only",
"keywords": [
"ember-addon"
],
"exports": {
".": "./src/index.js",
"./addon-main.js": "./addon-main.cjs"
},
"files": [
"addon-main.cjs",
"src"
],
"dependencies": {
Build(deps): Bump the embroider group (#24391) Bumps the embroider group in /app/assets/javascripts with 5 updates: | Package | From | To | | --- | --- | --- | | [@embroider/test-setup](https://github.com/embroider-build/embroider/tree/HEAD/packages/test-setup) | `3.0.2` | `3.0.3` | | [@embroider/compat](https://github.com/embroider-build/embroider/tree/HEAD/packages/compat) | `3.2.3` | `3.3.1` | | [@embroider/core](https://github.com/embroider-build/embroider/tree/HEAD/packages/core) | `3.3.0` | `3.4.1` | | [@embroider/webpack](https://github.com/embroider-build/embroider/tree/HEAD/packages/webpack) | `3.2.0` | `3.2.1` | | [@embroider/addon-shim](https://github.com/embroider-build/embroider/tree/HEAD/packages/addon-shim) | `1.8.6` | `1.8.7` | Updates `@embroider/test-setup` from 3.0.2 to 3.0.3 - [Release notes](https://github.com/embroider-build/embroider/releases) - [Changelog](https://github.com/embroider-build/embroider/blob/main/CHANGELOG.md) - [Commits](https://github.com/embroider-build/embroider/commits/HEAD/packages/test-setup) Updates `@embroider/compat` from 3.2.3 to 3.3.1 - [Release notes](https://github.com/embroider-build/embroider/releases) - [Changelog](https://github.com/embroider-build/embroider/blob/main/CHANGELOG.md) - [Commits](https://github.com/embroider-build/embroider/commits/HEAD/packages/compat) Updates `@embroider/core` from 3.3.0 to 3.4.1 - [Release notes](https://github.com/embroider-build/embroider/releases) - [Changelog](https://github.com/embroider-build/embroider/blob/main/CHANGELOG.md) - [Commits](https://github.com/embroider-build/embroider/commits/HEAD/packages/core) Updates `@embroider/webpack` from 3.2.0 to 3.2.1 - [Release notes](https://github.com/embroider-build/embroider/releases) - [Changelog](https://github.com/embroider-build/embroider/blob/main/CHANGELOG.md) - [Commits](https://github.com/embroider-build/embroider/commits/HEAD/packages/webpack) Updates `@embroider/addon-shim` from 1.8.6 to 1.8.7 - [Release notes](https://github.com/embroider-build/embroider/releases) - [Changelog](https://github.com/embroider-build/embroider/blob/main/CHANGELOG.md) - [Commits](https://github.com/embroider-build/embroider/commits/HEAD/packages/addon-shim) --- updated-dependencies: - dependency-name: "@embroider/test-setup" dependency-type: direct:development update-type: version-update:semver-patch dependency-group: embroider - dependency-name: "@embroider/compat" dependency-type: direct:development update-type: version-update:semver-minor dependency-group: embroider - dependency-name: "@embroider/core" dependency-type: direct:development update-type: version-update:semver-minor dependency-group: embroider - dependency-name: "@embroider/webpack" dependency-type: direct:development update-type: version-update:semver-patch dependency-group: embroider - dependency-name: "@embroider/addon-shim" dependency-type: direct:production update-type: version-update:semver-patch dependency-group: embroider ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-11-16 12:31:25 +01:00
"@embroider/addon-shim": "^1.8.7"
DEV: convert I18n pseudo package into real package (discourse-i18n) (#23867) Currently, `window.I18n` is defined in an old school hand written script, inlined into locale/*.js by the Rails asset pipeline, and then the global variable is shimmed into a pseudo AMD module later in `module-shims.js`. This approach has some problems – for one thing, when we add a new V2 addon (e.g. in #23859), Embroider/Webpack is stricter about its dependencies and won't let you `import from "I18n";` when `"I18n"` isn't listed as one of its `dependencies` or `peerDependencies`. This moves `I18n` into a real package – `discourse-i18n`. (I was originally planning to keep the `I18n` name since it's a private package anyway, but NPM packages are supposed to have lower case names and that may cause problems with other tools.) This package defines and exports a regular class, but also defines the default global instance for backwards compatibility. We should use the exported class in tests to make one-off instances without mutating the global instance and having to clean it up after the test run. However, I did not attempt that refactor in this PR. Since `discourse-i18n` is now included by the app, the locale scripts needs to be loaded after the app chunks. Since no "real" work happens until later on when we kick things off in the boot script, the order in which the script tags appear shouldn't be a problem. Alternatively, we can rework the locale bundles to be more lazy like everything else, and require/import them into the app. I avoided renaming the imports in this commit since that would be quite noisy and drowns out the actual changes here. Instead, I used a Webpack alias to redirect the current `"I18n"` import to the new package for the time being. In a separate commit later on, I'll rename all the imports in oneshot and remove the alias. As always, plugins and the legacy bundles (admin/wizard) still relies on the runtime AMD shims regardless. For the most part, I avoided refactoring the actual I18n code too much other than making it a class, and some light stuff like `var` into `let`. However, now that it is in a reasonable format to work with (no longer inside the global script context!) it may also be a good opportunity to refactor and make clear what is intended to be public API vs internal implementation details. Speaking of, I took the librety to make `PLACEHOLDER`, `SEPARATOR` and `I18nMissingInterpolationArgument` actual constants since it seemed pretty clear to me those were just previously stashed on to the `I18n` global to avoid polluting the global namespace, rather than something we expect the consumers to set/replace.
2023-10-12 06:44:01 -07:00
},
"engines": {
"node": "16.* || >= 18",
"npm": "please-use-yarn",
"yarn": ">= 1.21.1"
},
"ember": {
"edition": "octane"
},
"ember-addon": {
"version": 2,
"type": "addon",
"main": "addon-main.cjs",
"app-js": {}
}
}
Reference in New Issue Copy Permalink