npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@brizy/plugin-cms

v1.0.3-beta2

Published

CMS with Advanced Custom Fields

Downloads

3

Readme

Build env vars

  • APP_ORIGIN - You don't need it, is something internal
  • APP_LOCALE - Specify app display language code. E.g.: en, fr

Github deployment

There are moments when you need the deployment of your PR on github to have some specific environment variables, with other values then the default provided or secrets.

For this yu need to create a .sh file with your branch name in .github/workflows/ci_cd/env, and there specify the variables your want to overwrite.

E.g.

Let's say that your branch name is 3456-shopify-gold-subscription Create a file .github/workflows/ci_cd/env/3456-shopify-gold-subscription.sh. Add content:

#!/usr/bin/env bash

APP_LOCALE="FR_fr"

Localization

Localization allows to translate static strings from project in different languages, depending on locale code.

Localization usage

In this project the locale code is in Conext.locale parameter. It can be passed via post message by editor (usually in production), in locale property, or by environment variable: APP_LOCALE

In order to make strings translatable, we need to use the t function.

For rect components we use useTranslation hook.

import { useTranslation } from "~/locale/useTranslation";

function MyComponent() {
  const { t } = useTranslation();
  
  return <div>{t("Hello World!!!")}</div>
}

In case we need t function outside of a React component, we need to pass the t function as parameter. In case that function is called from a react component, sure we will take the t functin from useTranslation hook and pass it. In cas the function is called from an observable middleware or reducer, then usually middlewares and reducers get this function as dependecy. See already implemented observables. Note: We are trying to make all string translable from components. So make sure to avoid translating from reducers or middlewares.

Interpolation

If you want to fill the static string with some dynamic content, then you need to do proper interpolation:

import { useTranslation } from "~/locale/useTranslation";

function MyComponent({ firstName, lastName }) {
  const { t } = useTranslation();
  
  return <div>{t("Hello {{firstName}} {{lastName}}! How are you?", {firstName, lastName})}</div>
}

Generate translatable strings

All translatable strings are saved in /locales/default.json. In case new strings are added, we need to mae sure that they ar added in this file too. They should not be added in default.json manually, there is a special command for this npm run i18n.

Whenever you add new translatable strings, before you commit your changes run npm run i18n. Make sure the command did run properly and end with code 0. If something goes wrong, it will give an error. Unfortunately the error message is not descriptive at all. So you have to find the error by your self. Scroll in terminal logs generated by npm run i18n

Usually the log line look something like this:

[read]    /home/h/www/brizy-cms-ui/src/utils/sideBarTab.ts

But when something wrong happens it will look like this:

[error]    /home/h/www/brizy-cms-ui/src/utils/sideBarTab.ts
[warning]    /home/h/www/brizy-cms-ui/src/utils/sideBarTab.ts

Open the file and find out wat's wrong with t function usage. The common mistake is to use t string templates that have variables. You need to fix this by using proper interpolation. (Check out Interpolation section).