Add translatedBy to surahs.json

.rubocop.yml

@@ -2,9 +2,11 @@
 # Defaults
 AllCops:
   TargetRubyVersion: 3.2
+  Exclude:
+    - submodules/**/*
   Include:
     - Rakefile.rb
-    - tasks/*.rake
+    - rake/tasks/*.rake
     - nanoc/rules/*.rules
     - nanoc/rules/**/**/*.rules
     - nanoc/lib/*.rb

README.md

@@ -34,13 +34,14 @@ the website from source:
 
 Alhamdulillah.
 
-* Thanks to the following graphic artists:
+* Thanks to the graphic artists:
     - [RefreshIcon](/src/js/components/Icon.tsx)
       by
       [Muhammad Haq](https://freeicons.io/profile/823)
 
-* Thanks to the following translators:
+* Thanks to the translators:
     - English (The Clear Quran) by Dr. Mustafa Khattab
+    - Farsi by Hussein Taji Kal Dari
 
 ## License
 

Rakefile.rb

@@ -13,6 +13,7 @@ rescue LoadError
 end
 load "rake/tasks/format.rake"
 load "rake/tasks/nanoc.rake"
+load "rake/tasks/t.rake"
 
 desc "Serve the website on localhost"
 task :server, [:protocol] do |_t, args|

documentation/add-new-language.txt

@@ -19,3 +19,9 @@ The process:
   (/src/json/t.json)
   (/src/json/surahs.json)
   (/src/json/<locale>/<surahId>/{info,surah}.json)
+
+Tip:
+
+'/src/json/<locale>/<surahId>/info.json' can be generated
+automatically from the contents of '/src/json/surahs.json'
+via: rake t:surahs.json.

packages/typescript/Quran/src/index.ts

@@ -19,6 +19,7 @@ type TSurah = {
   readonly name: string;
   readonly numberOfAyah: number;
   readonly roman: { name: string; slug: string };
+  readonly translatedBy: string | null;
 };
 
 type TAyah = {
@@ -55,7 +56,8 @@ class Surah {
   readonly name: string;
   readonly numberOfAyah: number;
   readonly roman: {name: string, slug: string};
-  readonly ayat: TAyat
+  readonly ayat: TAyat;
+  readonly translatedBy: string | null;
 
   constructor(self: TSurah) {
     this.id = self.id;
@@ -63,6 +65,7 @@ class Surah {
     this.numberOfAyah = self.numberOfAyah;
     this.roman = self.roman;
     this.ayat = [];
+    this.translatedBy = self.translatedBy;
     return this;
   }
 }

rake/tasks/nanoc.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 namespace :nanoc do
   require "bundler/setup"
   root = File.realpath File.join(__dir__, "..", "..")
@@ -24,7 +26,7 @@ namespace :nanoc do
   end
 
   desc "Produce the build/ directory on-demand"
-  task watch: ['nanoc:build'] do
+  task watch: ["nanoc:build"] do
     Dir.chdir(root) do
       require "listen"
       srcdir = File.join(root, "src")

rake/tasks/t.rake

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+namespace :t do
+  desc "Generate /json/<locale>/<surahid>/info.json from surahs.json"
+  task :"surahs.json" do
+    require "json"
+    path   = File.join(Dir.getwd, "src", "json", "surahs.json")
+    surahs = JSON.parse(File.read(path))
+    surahs.keys.each do |locale|
+      surahs[locale].each.with_index(1) do |surah, index|
+        target = File.join(Dir.getwd, "src", "json", locale, index.to_s, "info.json")
+        File.write(target, JSON.pretty_generate(surah))
+      end
+    end
+  end
+end

src/js/components/LanguageSelect.tsx

@@ -16,7 +16,10 @@ export function LanguageSelect({ locale }: Props) {
         return (
           <Select.Option
             key={i}
-            className={classNames("flex h-6 w-20 justify-center no-underline mb-1 rounded", l.direction)}
+            className={classNames(
+              "flex h-6 w-20 justify-center no-underline mb-1 rounded",
+              l.direction,
+            )}
             value={l.name}
             href={l.name === locale.name ? undefined : href}
           >

src/js/main/surah-index.tsx

@@ -1,9 +1,8 @@
+import { Surah, TSurah, Quran } from "Quran";
 import React from "react";
 import ReactDOM from "react-dom/client";
-import { Surah, TSurah, TLocale } from "Quran";
 import { T } from "~/lib/t";
 import { SurahIndex } from "~/components/SurahIndex";
-import { Quran } from "Quran";
 
 (function () {
   const root: HTMLElement = document.querySelector(".root")!;

src/js/main/surah-stream.tsx

@@ -1,4 +1,4 @@
-import { Quran, Surah, Ayah, TSurah, TLocale } from "Quran";
+import { Quran, Surah, Ayah, TSurah } from "Quran";
 import React from "react";
 import ReactDOM from "react-dom/client";
 import { T } from "~/lib/t";

src/json/ar/1/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Fatihah",
     "slug": "al-fatihah"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/10/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Yunus",
     "slug": "yunus"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/100/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-'Adiyat",
     "slug": "al-adiyat"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/101/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Qari'ah",
     "slug": "al-qariah"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/102/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "At-Takathur",
     "slug": "at-takathur"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/103/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-'Asr",
     "slug": "al-asr"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/104/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Humazah",
     "slug": "al-humazah"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/105/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Fil",
     "slug": "al-fil"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/106/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Quraysh",
     "slug": "quraysh"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/107/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Ma'un",
     "slug": "al-maun"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/108/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Kawthar",
     "slug": "al-kawthar"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/109/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Kafirun",
     "slug": "al-kafirun"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/11/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Hud",
     "slug": "hud"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/110/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "An-Nasr",
     "slug": "an-nasr"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/111/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Masad",
     "slug": "al-masad"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/112/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Ikhlas",
     "slug": "al-ikhlas"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/113/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Falaq",
     "slug": "al-falaq"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/114/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "An-Nas",
     "slug": "an-nas"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/12/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Yusuf",
     "slug": "yusuf"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/13/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Ar-Ra'd",
     "slug": "ar-rad"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/14/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Ibrahim",
     "slug": "ibrahim"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/15/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Hijr",
     "slug": "al-hijr"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/16/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "An-Nahl",
     "slug": "an-nahl"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/17/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Isra",
     "slug": "al-isra"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/18/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Kahf",
     "slug": "al-kahf"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/19/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Maryam",
     "slug": "maryam"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/2/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Baqarah",
     "slug": "al-baqarah"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/20/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Taha",
     "slug": "taha"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/21/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Anbya",
     "slug": "al-anbya"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/22/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Hajj",
     "slug": "al-hajj"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/23/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Mu'minun",
     "slug": "al-muminun"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/24/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "An-Nur",
     "slug": "an-nur"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/25/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Furqan",
     "slug": "al-furqan"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/26/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Ash-Shu'ara",
     "slug": "ash-shuara"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/27/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "An-Naml",
     "slug": "an-naml"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/28/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Qasas",
     "slug": "al-qasas"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/29/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-'Ankabut",
     "slug": "al-ankabut"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/3/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Ali 'Imran",
     "slug": "ali-imran"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/30/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Ar-Rum",
     "slug": "ar-rum"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/31/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Luqman",
     "slug": "luqman"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/32/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "As-Sajdah",
     "slug": "as-sajdah"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/33/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Ahzab",
     "slug": "al-ahzab"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/34/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Saba",
     "slug": "saba"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/35/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Fatir",
     "slug": "fatir"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/36/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Ya-Sin",
     "slug": "ya-sin"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/37/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "As-Saffat",
     "slug": "as-saffat"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/38/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Sad",
     "slug": "sad"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/39/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Az-Zumar",
     "slug": "az-zumar"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/4/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "An-Nisa",
     "slug": "an-nisa"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/40/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Ghafir",
     "slug": "ghafir"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/41/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Fussilat",
     "slug": "fussilat"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/42/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Ash-Shuraa",
     "slug": "ash-shuraa"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/43/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Az-Zukhruf",
     "slug": "az-zukhruf"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/44/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Ad-Dukhan",
     "slug": "ad-dukhan"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/45/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Jathiyah",
     "slug": "al-jathiyah"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/46/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Ahqaf",
     "slug": "al-ahqaf"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/47/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Muhammad",
     "slug": "muhammad"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/48/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Fath",
     "slug": "al-fath"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/49/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Hujurat",
     "slug": "al-hujurat"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/5/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Ma'idah",
     "slug": "al-maidah"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/50/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Qaf",
     "slug": "qaf"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/51/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Adh-Dhariyat",
     "slug": "adh-dhariyat"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/52/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "At-Tur",
     "slug": "at-tur"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/53/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "An-Najm",
     "slug": "an-najm"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/54/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Qamar",
     "slug": "al-qamar"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/55/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Ar-Rahman",
     "slug": "ar-rahman"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/56/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Waqi'ah",
     "slug": "al-waqiah"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/57/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Hadid",
     "slug": "al-hadid"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/58/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Mujadila",
     "slug": "al-mujadila"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/59/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Hashr",
     "slug": "al-hashr"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/6/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-An'am",
     "slug": "al-anam"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/60/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Mumtahanah",
     "slug": "al-mumtahanah"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/61/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "As-Saf",
     "slug": "as-saf"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/62/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Jumu'ah",
     "slug": "al-jumuah"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/63/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Munafiqun",
     "slug": "al-munafiqun"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/64/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "At-Taghabun",
     "slug": "at-taghabun"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/65/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "At-Talaq",
     "slug": "at-talaq"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/66/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "At-Tahrim",
     "slug": "at-tahrim"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/67/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Mulk",
     "slug": "al-mulk"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/68/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Qalam",
     "slug": "al-qalam"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/69/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Haqqah",
     "slug": "al-haqqah"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/7/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-A'raf",
     "slug": "al-araf"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/70/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Ma'arij",
     "slug": "al-maarij"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/71/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Nuh",
     "slug": "nuh"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/72/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Jinn",
     "slug": "al-jinn"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/73/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Muzzammil",
     "slug": "al-muzzammil"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/74/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Muddaththir",
     "slug": "al-muddaththir"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/75/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Qiyamah",
     "slug": "al-qiyamah"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/76/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Insan",
     "slug": "al-insan"
-  }
+  },
+  "translatedBy": null
 }

src/json/ar/77/info.json

@@ -5,5 +5,6 @@
   "roman": {
     "name": "Al-Mursalat",
     "slug": "al-mursalat"
-  }
+  },
+  "translatedBy": null
 }