Add X-PHONETIC-ORG field and the number of items next to group name (#529)

* Add X-PHONETIC-ORG field to enable alphabetical sorting on English language systems

* Add the number of items in each group next to its nam

* chore: replace hardcoded usernames with variables

Author: lunanfo

.github/workflows/release.yml

@@ -29,11 +29,13 @@ jobs:
         env:
           DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCKER_USERNAME: ${{ vars.Docker_USERNAME }}
+          GITHUB_USERNAME: ${{ github.actor }}
         run: |
           IMAGE_VERSION=`cat package.json | jq -r '.version'`
-          echo $DOCKER_TOKEN | docker login -u metowolf --password-stdin
-          docker build -t metowolf/vcards:$IMAGE_VERSION .
-          docker push metowolf/vcards:$IMAGE_VERSION
-          echo $GITHUB_TOKEN | docker login ghcr.io -u metowolf --password-stdin
-          docker build -t ghcr.io/metowolf/vcards:$IMAGE_VERSION .
-          docker push ghcr.io/metowolf/vcards:$IMAGE_VERSION
+          echo $DOCKER_TOKEN | docker login -u $DOCKER_USERNAME --password-stdin
+          docker build -t $DOCKER_USERNAME/vcards:$IMAGE_VERSION .
+          docker push $DOCKER_USERNAME/vcards:$IMAGE_VERSION
+          echo $GITHUB_TOKEN | docker login ghcr.io -u $GITHUB_USERNAME --password-stdin
+          docker build -t ghcr.io/$GITHUB_USERNAME/vcards:$IMAGE_VERSION .
+          docker push ghcr.io/$GITHUB_USERNAME/vcards:$IMAGE_VERSION

package.json

@@ -25,6 +25,7 @@
     "image-size": "^1.0.2",
     "joi": "^17.9.2",
     "js-yaml": "^4.1.0",
+    "pinyin-pro": "^3.26.0",
     "pretty-bytes": "^6.1.1",
     "read-chunk": "^4.0.3",
     "vcards-js": "^2.10.0"

src/gulpfile.js

@@ -58,7 +58,13 @@ const createRadicale = () => {
       return fs.statSync(path.join('temp', f)).isDirectory();
     })
   folders.map(function(folder){
-    fs.writeFileSync(path.join('temp', folder, '/.Radicale.props'), '{"D:displayname": "' + folder + '", "tag": "VADDRESSBOOK"}')
+    const fileCount = fs.readdirSync(path.join('temp', folder))
+      .filter(file => file.endsWith('.vcf'))
+      .length;
+    fs.writeFileSync(
+      path.join('temp', folder, '/.Radicale.props'), 
+      `{"D:displayname": "${folder}(${fileCount})", "tag": "VADDRESSBOOK"}`
+    )
   })
   return gulp.src('temp/**', {})
 }

src/plugins/vcard-ext.js

@@ -2,6 +2,7 @@ import fs from 'fs'
 import yaml from 'js-yaml'
 import vCardsJS from 'vcards-js'
 import {execSync} from 'child_process'
+import addPhoneticField from '../utils/pinyin.js'
 
 const plugin = (file, _, cb) => {
   const path = file.path
@@ -26,6 +27,7 @@ const plugin = (file, _, cb) => {
 
   let formatted = vCard.getFormattedString()
   formatted = formatted.replace(/REV:[\d\-:T\.Z]+/, 'REV:' + rev)
+  formatted = addPhoneticField(formatted, 'ORG')
   file.contents = Buffer.from(formatted)
   cb(null, file)
 }

src/plugins/vcard.js

@@ -1,6 +1,7 @@
 import fs from 'fs'
 import yaml from 'js-yaml'
 import vCardsJS from 'vcards-js'
+import addPhoneticField from '../utils/pinyin.js'
 
 const plugin = (file, _, cb) => {
   const path = file.path
@@ -21,7 +22,9 @@ const plugin = (file, _, cb) => {
     })
   }
   vCard.photo.embedFromFile(path.replace('.yaml', '.png'))
-  file.contents = Buffer.from(vCard.getFormattedString())
+  let formatted = vCard.getFormattedString()
+  formatted = addPhoneticField(formatted, 'ORG')
+  file.contents = Buffer.from(formatted)
   cb(null, file)
 }
 

src/utils/pinyin.js

@@ -0,0 +1,16 @@
+import { pinyin } from 'pinyin-pro'
+
+const addPhoneticField = (text, fieldName) => {
+  const regex = new RegExp(`${fieldName};CHARSET=UTF-8:(.*)\r?\n`, 'g');
+  return text.replace(regex, (match, value) => {
+    const hasChinese = /[\u4e00-\u9fa5]/.test(value);
+    const pinyinText = hasChinese ?
+      pinyin(value, { toneType: 'none', nonZh: 'consecutive', type: 'array' })
+        .map(item => item[0].toUpperCase() + item.slice(1))
+        .join(' ')
+      : value;
+    return `${match}X-PHONETIC-${fieldName};CHARSET=UTF-8:${pinyinText}\n`;
+  });
+};
+
+export default addPhoneticField;

yarn.lock

@@ -2351,6 +2351,11 @@ pinkie@^2.0.0:
   resolved "https://registry.yarnpkg.com/pinkie/-/pinkie-2.0.4.tgz#72556b80cfa0d48a974e80e77248e80ed4f7f870"
   integrity sha512-MnUuEycAemtSaeFSjXKW/aroV7akBbY+Sv+RkyqFjgAe73F+MR0TBWKBRDkmfWq/HiFmdavfZ1G7h4SPZXaCSg==
 
+pinyin-pro@^3.26.0:
+  version "3.26.0"
+  resolved "https://registry.yarnpkg.com/pinyin-pro/-/pinyin-pro-3.26.0.tgz#9e3b8a9f848263b81552d56e9319f520f7709ad6"
+  integrity sha512-HcBZZb0pvm0/JkPhZHWA5Hqp2cWHXrrW/WrV+OtaYYM+kf35ffvZppIUuGmyuQ7gDr1JDJKMkbEE+GN0wfMoGg==
+
 pkg-conf@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/pkg-conf/-/pkg-conf-4.0.0.tgz#63ace00cbacfa94c2226aee133800802d3e3b80c"