@goodcastle/api-plugin-translations-es v0.22.14

api-plugin-translations

Summary

This plugin provides a Boilerplate for creating an npm plugin for the Reaction API.

The Developer Certificate of Origin and License sections can stay as they are, assuming Apache 2 license is used (our preferred license). All other sections of this README should be updated to reflect your plugin.

CREATING TRANSLATIONS

• some plugin translations are inside in the same plugin project, for this reason, you must make sure if the translations will be better inside this api-plugin-translation proyect or not, try to clone all plugins and search the words to locate them in the correct proyect.
• the storefront translations are in goodcommerce-storefront/translations/locales/language/common.js

1. clone the api-plugin-translations repo inside goodcommerce-plataform
2. # cd api-plugin-translations
3. create a folder in src/i18n/
4. create the language files and the index that exports them (example in src/i18n/products/ or in any other folder)
5. include that folder in src /i18n/index.js

testing your translations (DO NOT COMMIT/PUSH/MERGE THIS CHANGES)

1. once the translations are created you have to add that pluging path to the api: # cd goodcommerce

2. modify the docker-compose.dev.yml file:

   inside service:api:volumes add this line (change path/to/proyect):

   - /home/path/to/proyect/goodcommerce-plataform/api-plugin-translations-es:/usr/local/src/app/node_modules/@goodcastle/api-plugin-translations-es

3. delete the @goodcastle/api-plugin-translations-es plugin in package.json
4. restart api container. docker-compose down && docker-compose up -d
5. is necessary reset the api container whenever something changes in api-plugin-translations-es

HOW USE IT IN ADMIN

on an JS file:

import i18next from "i18next"; or import { i18next } from "/client/api";

.....

i18next.t("admin.dataTable.allFilters", "All filters")

.....

(this translation is in api-plugin-translations-es/src/i18n/globals/es.json)

Included in this example plugin

./gitlab-ci.yml

CI script that enable Gitlab to run tests, lint, and semantic release your package.

src/

The src folder is where you'll put all the plugin files. An index.js with a bear-bones registerPlugin is included.

.gitignore

A basic gitignore file

.nvmrc

.nvmrc sets your plugin to use Node v12.14.1

babel.config.cjs

If your plugin includes linting and tests, this file is required to allow esmodules to run correctly.

jest.config.cjs

If your plugin includes tests, this file is required to allow esmodules to run correctly. You'll need to update the transformIgnorePatterns and moduleNameMapper sections to include any esmodule npm packages used in your plugin.

License.md

If your plugin uses Apache 2 licensing, you can leave this file as-is. If another type of licensing is used, you need to update this file, and the README, accordingly.

package.json

The provided package.json is set up to install all needed packages and config for linting, testing, and semantic-release. You'll need to update the name, description, and add any new dependencies your plugin files use.

index.js

The entrypoint file for your npm package, will most likely just export your plugin registration from the src folder.