testing locales and npm init

.github/workflows/pack.yml

···
         uses: actions/setup-node@v2.5.2
         
       - name: Setup NPM packages
-        run: npm i adm-zip
+        run: npm install
         
       - name: Pack extension
-        run: node pack.js
+        run: npm run build
         
       - name: Upload for Firefox
         uses: actions/upload-artifact@v3.1.2

.github/workflows/test.yml

···
+name: Test locales
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ] 
+
+jobs:
+  test:
+
+    runs-on: windows-latest
+
+    steps:
+      - name: Checkout Source Tree
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v2.5.2
+        
+      - name: Setup NPM packages
+        run: npm install
+        
+      - name: Test locales
+        run: npm run test

.gitignore

···
-_metadata/
+_metadata/
+node_modules/
+package-lock.json

_locales/ar/messages.json

···
 {
-    "ext_description": { "message": "امتداد جديد يعيد مظهرامتداد جديد يعيد مظهر Twitter القديم.", "translator_note": "There is still some confusion if Twitter is to be written as تويتر or Twitter. For now I have arbritarirly put it the latter. Also note that 'tweet' in official translation is given literally as chirp so I had changed it to تويت, and that this is not a mistake" },
+    "ext_description": { "message": "امتداد جديد يعيد مظهرامتداد جديد يعيد مظهر Twitter القديم.", "note": "There is still some confusion if Twitter is to be written as تويتر or Twitter. For now I have arbritarirly put it the latter. Also note that 'tweet' in official translation is given literally as chirp so I had changed it to تويت, and that this is not a mistake" },
     "timeline": { "message": "الجدول الزمني" },
     "loading": { "message": "جار التحميل" },
     "tweets": { "message": "تغريدات" },
···
     "profile": { "message": "الملف الشخصيّ" },
     "settings": { "message": "الإعدادات" },
     "lists": { "message": "القوائم" },
-    "تحدي": { "message": "قائمة" },
+    "list": { "message": "قائمة" },
     "bookmarks": { "message": "العلامات المرجعية" },
     "manage_accounts": { "message": "إدارة الحسابات" },
     "logout": { "message": "تسجيل خروج" },

_locales/ko/messages.json

···
     "who_to_follow": { "message": "팔로우 추천", "description": "Max 19 characters, you can use word 'People' if no space" },
     "refresh": { "message": "새로고침" },
     "view_all": { "message": "모두 보기" },
-    "running": { "message": "", "memo": "Korean Remove Running message because of grammer differance" },
+    "running": { "message": "", "note": "Korean Remove Running message because of grammer differance" },
     "created_by": { "message": "제작자", "example": "->Created by<- dimden" },
     "website": { "message": "웹사이트" },
     "help": { "message": "고객지원", "description": "noun" },
···
     "replying_to_tweet": { "message": "트윗에 대한 답글" },
     "upload_media_btn": { "message": "[미디어 업로드]" },
     "cancel_btn": { "message": "[취소]" },
-    "quote": { "message": "인용","memo":"원래 인용하기가 맞을지도" },
+    "quote": { "message": "인용", "note":"원래 인용하기가 맞을지도" },
     "reply_example": { "message": "답글로 초멘나사이는 적지 마세요" },
     "quote_example": { "message": "추가 내용" },
     "error_sending_tweet": { "message": "트윗 전송 오류" },
···
     "block_sure_desc": { "message": "이제 @$SCREEN_NAME$ 님은 더이상 나를 팔로우 하거나 쪽지를 보낼 수 없습니다.", "placeholders": { "screen_name": { "content": "CoolPerson2000" } } },
     "blocked_by_user" : { "message": "@$SCREEN_NAME$ 님이 나를 차단했습니다.", "placeholders": { "screen_name": { "content": "CoolPerson2000" } } },
     "why_you_cant_see_block_user": { "message": "@$SCREEN_NAME$ 님을 팔로우 하거나 @$SCREEN_NAME$ 님의 트윗을 볼 수 없습니다", "placeholders": { "screen_name": { "content": "CoolPerson2000" } } }
-    
 }

pack.js

···
     const entries = await fsp.readdir(src, { withFileTypes: true });
     await fsp.mkdir(dest);
     for (let entry of entries) {
-        if(entry.name === '.git' || entry.name === '.github' || entry.name === '_metadata') continue;
+        if(entry.name === '.git' || entry.name === '.github' || entry.name === '_metadata' || entry.name === 'node_modules') continue;
         const srcPath = path.join(src, entry.name);
         const destPath = path.join(dest, entry.name);
         if (entry.isDirectory()) {
···
     fs.unlinkSync('../OldTwitterFirefox/scripts/background_v2.js');
     fs.unlinkSync('../OldTwitterFirefox/.gitignore');
     fs.unlinkSync('../OldTwitterTempChrome/.gitignore');
+    fs.unlinkSync('../OldTwitterFirefox/test.js');
+    fs.unlinkSync('../OldTwitterTempChrome/test.js');
+    fs.unlinkSync('../OldTwitterFirefox/package.json');
+    fs.unlinkSync('../OldTwitterTempChrome/package.json');
+    fs.unlinkSync('../OldTwitterFirefox/package-lock.json');
+    fs.unlinkSync('../OldTwitterTempChrome/package-lock.json');
 
     let layouts = fs.readdirSync('../OldTwitterFirefox/layouts');
     for (let layout of layouts) {

package.json

···
+{
+  "name": "oldtwitter",
+  "version": "0.0.0",
+  "description": "Extension to return old Twitter layout from 2015.",
+  "main": "pack.js",
+  "scripts": {
+    "test": "node test.js",
+    "build": "node pack.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dimdenGD/OldTwitter.git"
+  },
+  "keywords": [
+    "twitter",
+    "twitter-client",
+    "chrome-extension",
+    "firefox-addons",
+    "chrome",
+    "firefox-extension",
+    "chromium-extension"
+  ],
+  "author": "dimden",
+  "license": "UNLICENSED",
+  "bugs": {
+    "url": "https://github.com/dimdenGD/OldTwitter/issues"
+  },
+  "homepage": "https://github.com/dimdenGD/OldTwitter#readme",
+  "dependencies": {
+    "adm-zip": "^0.5.10"
+  }
+}

test.js

···
+// Tests locale files
+
+const fs = require('fs');
+const path = require('path');
+
+const validKey = /^[a-zA-Z0-9_@]+$/;
+const placeholdersRegex = /\$[a-zA-Z0-9_@]+\$/g;
+const validFieldKeys = ['name', 'message', 'description', 'example', 'placeholders'];
+
+const locales = 
+    fs.readdirSync(path.join(__dirname, '_locales'), { withFileTypes: true })
+        .filter(dirent => dirent.isDirectory())
+        .map(dirent => dirent.name);
+
+let errors = false;
+
+for(let localeName of locales) {
+    let locale;
+
+    try {
+        locale = JSON.parse(fs.readFileSync(path.join(__dirname, '_locales', localeName, 'messages.json')));
+    } catch(e) {
+        console.error(`(Critical) Error parsing _locales/${localeName}/messages.json`, e);
+        errors = true;
+        continue;
+    }
+    
+    let keys = Object.keys(locale);
+    for(let key of keys) {
+        if(!validKey.test(key)) {
+            console.error(`Invalid key "${key}" in _locales/${localeName}/messages.json`);
+            errors = true;
+        }
+        if(key.length > 80) {
+            console.error(`Key "${key}" is too long in _locales/${localeName}/messages.json`);
+            errors = true;
+        }
+    }
+
+    if(!locale.ext_description) {
+        console.error(`Missing "ext_description" in _locales/${localeName}/messages.json`);
+        errors = true;
+    }
+
+    if(locale.ext_description.length > 132) {
+        console.error(`"ext_description" is too long in _locales/${localeName}/messages.json`);
+        errors = true;
+    }
+
+    for(let fieldName in locale) {
+        let field = locale[fieldName];
+        let keys = Object.keys(field);
+        
+        for(let key of keys) {
+            if(!validFieldKeys.includes(key)) {
+                console.error(`Invalid key "${key}" on "${fieldName}" in _locales/${localeName}/messages.json`);
+                errors = true;
+            }
+        }
+
+        if(typeof field.message !== 'string') {
+            console.error(`Missing "message" on "${fieldName}" in _locales/${localeName}/messages.json`);
+            errors = true;
+        }
+
+        let placeholders = field.message.match(placeholdersRegex);
+        if(placeholders) {
+            if(!field.placeholders) {
+                console.error(`Missing "placeholders" on "${fieldName}" in _locales/${localeName}/messages.json`);
+                errors = true;
+            } else {
+                placeholders = placeholders.map(placeholder => placeholder.slice(1, -1).toLowerCase());
+                for(let placeholder of placeholders) {
+                    if(!field.placeholders[placeholder]) {
+                        console.error(`Missing placeholder "${placeholder}" on "${fieldName}" in _locales/${localeName}/messages.json`);
+                        errors = true;
+                    }
+                }
+            }
+        }
+    }
+}
+
+if(errors) {
+    process.exit(1);
+}
+
+console.log('All locale files are valid.');