feat: require node >=14, bump deps, redis is now optional, setup github actions

titanism · titanism · commit b92d2f3693ed · 2022-06-13T18:08:59.000-05:00
diff --git a/.commitlintrc.js b/.commitlintrc.js
@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional']
+};
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1 @@
+!.*.js
diff --git a/.gitattributes b/.gitattributes
@@ -1 +1 @@
-* text=auto
+* text=auto eol=lf
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
diff --git a/.github/scripts/decrypt_secret.sh b/.github/scripts/decrypt_secret.sh
@@ -0,0 +1,8 @@
+#!/bin/sh
+
+# Decrypt the file
+mkdir $HOME/secrets
+# --batch to prevent interactive command
+# --yes to assume "yes" for questions
+gpg --quiet --batch --yes --decrypt --passphrase="$LARGE_SECRET_PASSPHRASE" \
+--output $HOME/secrets/my_secret.json .github/secrets/my_secret.json.gpg
diff --git a/.github/secrets/gapp-credentials.json.gpg b/.github/secrets/gapp-credentials.json.gpg
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,32 @@
+name: CI
+on:
+  - push
+  - pull_request
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+        node_version:
+          - 14
+          - 16
+          - 18
+    name: Node ${{ matrix.node_version }} on ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Decrypt large secret
+        run: ./.github/scripts/decrypt_secret.sh
+        env:
+          LARGE_SECRET_PASSPHRASE: ${{ secrets.LARGE_SECRET_PASSPHRASE }}
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node_version }}
+      - name: Install dependencies
+        run: npm install
+      - name: Run tests
+        env:
+          GOOGLE_APPLICATION_CREDENTIALS: $HOME/secrets/my_secret.json
+        run: npm run test
diff --git a/.gitignore b/.gitignore
@@ -4,5 +4,12 @@
 node_modules
 coverage
 .nyc_output
-locales
+locales/
 package-lock.json
+yarn.lock
+
+Thumbs.db
+tmp/
+temp/
+*.lcov
+.env
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit $1
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install lint-staged && npm test
diff --git a/.lintstagedrc.js b/.lintstagedrc.js
@@ -0,0 +1,5 @@
+module.exports = {
+  "*.md": filenames => filenames.map(filename => `remark ${filename} -qfo`),
+  'package.json': 'fixpack',
+  '*.js': 'xo --fix'
+};
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+package-lock=false
diff --git a/.prettierrc.js b/.prettierrc.js
@@ -0,0 +1,5 @@
+module.exports = {
+  singleQuote: true,
+  bracketSpacing: true,
+  trailingComma: 'none'
+};
diff --git a/.remarkrc.js b/.remarkrc.js
@@ -0,0 +1,3 @@
+module.exports = {
+  plugins: ['preset-github']
+};
diff --git a/.travis.yml b/.travis.yml
diff --git a/.xo-config.js b/.xo-config.js
@@ -0,0 +1,5 @@
+module.exports = {
+  prettier: true,
+  space: true,
+  extends: ['xo-lass']
+};
diff --git a/README.md b/README.md
@@ -1,23 +1,20 @@
 # mandarin
 
-[![build status](https://img.shields.io/travis/niftylettuce/mandarin.svg)](https://travis-ci.org/niftylettuce/mandarin)
-[![code coverage](https://img.shields.io/codecov/c/github/niftylettuce/mandarin.svg)](https://codecov.io/gh/niftylettuce/mandarin)
+[![build status](https://github.com/ladjs/mandarin/actions/workflows/ci.yml/badge.svg)](https://github.com/ladjs/mandarin/actions/workflows/ci.yml)
 [![code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
 [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 [![made with lass](https://img.shields.io/badge/made_with-lass-95CC28.svg)](https://lass.js.org)
-[![license](https://img.shields.io/github/license/niftylettuce/mandarin.svg)](LICENSE)
+[![license](https://img.shields.io/github/license/ladjs/mandarin.svg)](LICENSE)
 
 > Automatic i18n markdown translation and i18n phrase translation using Google Translate
 
-> **v2.0.0**: We have integrated Redis as a requirement for caching Google Translate responses (to save you money)
->
-> **v1.0.0**: We now use the official Node.js Google Translate package `@google-cloud/translate`
-
 
 ## Table of Contents
 
 * [Install](#install)
 * [Requirements](#requirements)
+  * [Redis](#redis)
+  * [Google Application Credentials](#google-application-credentials)
 * [Usage](#usage)
 * [Contributors](#contributors)
 * [License](#license)
@@ -31,16 +28,20 @@
 npm install mandarin
 ```
 
-[yarn][]:
 
-```sh
-yarn add mandarin
-```
+## Requirements
 
+### Redis
 
-## Requirements
+You will need to have [Redis][] installed in order for caching to work properly.
 
-You will need to have [Redis][] installed.
+If you do not plan to use Redis, then set `redis: false` as an option.
+
+### Google Application Credentials
+
+You will also need Google Application Credentials, and you will need to set them as environment variables (e.g. `GOOGLE_APPLICATION_CREDENTIALS=/home/user/Downloads/service-account-file.json`).
+
+For more information on Google Application credentials, see <https://cloud.google.com/docs/authentication/getting-started#setting_the_environment_variable>.
 
 
 ## Usage
@@ -162,8 +163,6 @@ GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/[FILE_NAME].json" node app.
 
 [npm]: https://www.npmjs.com/
 
-[yarn]: https://yarnpkg.com/
-
 [i18n]: https://github.com/ladjs/i18n
 
 [redis]: https://redis.io/
diff --git a/client_secrets.json.enc b/client_secrets.json.enc
diff --git a/index.js b/index.js
@@ -1,5 +1,6 @@
-const path = require('path');
 const fs = require('fs');
+const path = require('path');
+const process = require('process');
 
 // const formatSpecifiers = require('format-specifiers');
 const Redis = require('@ladjs/redis');
@@ -57,6 +58,9 @@ class Mandarin {
         }),
         i18n: false,
         //
+        // NOTE: you can pass `GOOGLE_APPLICATION_CREDENTIALS` as an environment variable
+        //       or you can pass individual environment variables
+        //
         // OPTIONAL:
         // see all commented options from this following link:
         // https://googleapis.dev/nodejs/translate/5.0.1/v2_index.js.html
@@ -81,12 +85,17 @@ class Mandarin {
 
     if (!this.config.i18n) throw new Error('i18n instance option required');
 
-    // setup redis
-    this.redisClient = new Redis(
-      this.config.redis,
-      this.config.logger,
-      this.config.redisMonitor
-    );
+    // initialize redis
+    this.redisClient =
+      this.config.redis === false
+        ? false
+        : _.isPlainObject(this.config.redis)
+        ? new Redis(
+            this.config.redis,
+            this.config.logger,
+            this.config.redisMonitor
+          )
+        : this.config.redis;
 
     // setup google translate with api key
     this.client = new v2.Translate(this.config.clientConfig);
@@ -214,9 +223,10 @@ class Mandarin {
       if (locale === i18n.config.defaultLocale) return file;
 
       const translationsRequired = _.intersection(
-        _.uniq(
-          _.concat(_.values(i18n.config.phrases), _.values(defaultLocaleFile))
-        ),
+        _.uniq([
+          ..._.values(i18n.config.phrases),
+          ..._.values(defaultLocaleFile)
+        ]),
         _.values(file)
       );
 
@@ -251,15 +261,16 @@ class Mandarin {
 
         // lookup translation result from cache
         const key = `${locale}:${revHash(phrase)}`;
-        let translation = await this.redisClient.get(key);
+        let translation;
+        if (this.redisClient) translation = await this.redisClient.get(key);
         debug('translation', translation);
 
         // get the translation results from Google
         if (!_.isString(translation)) {
           debug('getting translation', key);
           [translation] = await this.client.translate(safePhrase, locale);
           debug('got translation', translation);
-          await this.redisClient.set(key, translation);
+          if (this.redisClient) await this.redisClient.set(key, translation);
         }
 
         // replace `|` pipe character because translation will
diff --git a/package.json b/package.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = {`
	`2`	`+ extends: ['@commitlint/config-conventional']`
	`3`	`+};`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = {`
	`2`	`+ plugins: ['preset-github']`
	`3`	`+};`