salat 4.3.0 → 4.6.1

package/README.md

@@ -1,275 +1,94 @@
-# Salat [![npm version](https://badge.fury.io/js/salat.svg)](https://badge.fury.io/js/salat)
+# 🧭 salat-cli
 
-PLEASE SUPPORT THIS REPO WITH A STAR ⭐🌟💫
+> Daily Moroccan prayers time, right in your console, at the tip of your fingers. ✨
 
-## Description
+A modern, visually rich CLI for checking prayer times in Morocco, built with **React** and **Ink**.
 
-> Daily prayer time in all the cities in [Morocco](https://www.google.com/search?q=morocco) , directly in your terminal, at the tip of your fingers
+[![npm version](https://img.shields.io/npm/v/salat.svg)](https://www.npmjs.com/package/salat)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-**A stupid simple Command line utility to get the daily prayers time for all the citiy in Morocco**
+---
 
-The source of the data is [the Moroccan Ministery Website](http://www.habous.gov.ma)
+## 🚀 Features
 
-## Getting started
+- **Live Countdown**: "Remaining" time updates every second in real-time.
+- **Rich UI**: Beautiful terminal interface with colors and borders.
+- **Morocco Focused**: Supports 190+ cities across Morocco.
+- **Smart Caching**: Local storage caching to minimize API calls.
+- **Developer Friendly**: Built with TypeScript and Commander.js.
 
-```bash
-npx salat [cityName]
-```
-
-Please note that if the cityName contains space of `'` you need to use quotes, example
+## 📦 Installation
 
 ```bash
-npx salat "el jadida"
-npx salat "L'msid"
+npm install -g salat
 ```
 
-## City List
-
-This is an exhaustive list of the supported cities :
-
-- Agadir
-- Ahfir
-- Ain Aouda
-- Aïn Chaïr
-- Ait El Kak
-- Ait Ourir
-- Akayouar
-- Akdal Amelchil
-- Akdez
-- Akhefnir
-- Akka
-- Aknoul
-- Akoudal Amelchil Midelt
-- Amkala
-- Amsmrir
-- Araich
-- Arbaoua
-- Arfoud
-- Asa
-- Askin
-- Asoul
-- Assila
-- Azemmour
-- Azilal
-- Azrou
-- Bab Bared
-- Ben Ahmed
-- Ben Slimane
-- Bengrir
-- Beni Adrar
-- Beni Ansar
-- Beni Mellal
-- Beni Tejit
-- Berkane
-- Berrchid
-- Bir Anzaran
-- Bir Kandour
-- Bouanan
-- Bouarfa
-- Bouikra
-- Bouizkaren
-- Boujdour
-- Boukrae
-- Boulmane
-- Boumalen Dadas
-- Bourd
-- Bouskoura
-- Bouznika
-- Casablanca
-- Chefchaouan
-- Chichaoua
-- Dakhla
-- Debdou
-- Demnat
-- Deryouche
-- El Brouj
-- El Gara
-- El Hajeb
-- El Jabha
-- El Jadida
-- El Kasba
-- El Mahbes
-- El Menzel
-- Enif
-- Erich
-- Errachidia
-- Essaouira
-- Ezak
-- Fem Lehsan
-- Fem Zkid
-- Ferkhana
-- Fes
-- Fezouane
-- Figuig
-- Fnideq
-- Fquih Ben Salah
-- Geltat Zamour
-- Guelmim
-- Guercif
-- Hoceima
-- Igherem
-- Ikes
-- Imelchil
-- Imin Telat
-- Imntanout
-- Imouzzer Kandar
-- Jerada
-- Kalaat Megouna
-- Kalaat Sraghna
-- Kares
-- Kariat Ba Mohammed
-- Kasbah Tadla
-- Katara
-- Kelmima
-- Kénitra
-- Ketama
-- Khemis Sidi Abd Jelil
-- Khemis Zemamra
-- Khémissat
-- Khenifra
-- Khouribga
-- Ksar El Kebir
-- Ksar El Sghir
-- Ksar Ich
-- L'msid
-- Laayoune
-- Laayoune Sidi Mellouk
-- Lagouira
-- Marrakech
-- Martil
-- Mediek
-- Meknes
-- Melilla
-- Meskoura
-- Metmata
-- Midelt
-- Misour
-- Mohammedia
-- Moulay Bouaza
-- Moulay Bousselham
-- Moulay Yacoub
-- Nador
-- Oualidia
-- Ouazane
-- Oued Amlil
-- Oued Law
-- Oued Zam
-- Oujda
-- Oulad Ayad
-- Oulad Tayma
-- Oulmes
-- Ourzazate
-- Ousered
-- Rabat
-- Ras Alma
-- Remani
-- Rhamna
-- Ribate El Kheir
-- Risani
-- Safi
-- Saïdia
-- Sebta
-- Sefrou
-- Selouane
-- Settat
-- Sidi Benour
-- Sidi Ghanem
-- Sidi Ifni
-- Sidi Kacém
-- Sidi Slimane
-- Sidi Yahya Gharb
-- Smara
-- Souq Arbiâ Gharb
-- Tafntan
-- Tafougalt
-- Tafraouet
-- Tahla
-- Tahla
-- Talouine
-- Talsint
-- Tamslouhet
-- Tanger
-- Tantan
-- Taounat
-- Taourirt
-- Tarfaya
-- Taroudant
-- Tasltanet
-- Tata
-- Taza
-- Tazarin
-- Tefariti
-- Temnar
-- Tendrara
-- Tenghir
-- Tenjedad
-- Tetouan
-- Tiflet
-- Tindit
-- Tisa
-- Tisenet
-- Tizi Ousli
-- Tiznit
-- Toulkoult
-- Yefrin
-- Yousofia
-- Zagoura
-- Zaouiat Ahansal
-- Zaouiat Moulay Ibrahim
-- Zayou
-- Zerhoune
+## 🛠 Usage
 
-Alternatively You can also install it globally
+Simply run `salat` to see prayer times for the default city (Marrakech), or specify a city.
 
 ```bash
-# Install
+# Get prayer times for the default city
+salat
 
-$ npm i -g salat
+# Get prayer times for a specific city
+salat times Rabat
 
-# Run with default city
+# Run once and exit (no live timer)
+salat -1
 
-$ salat
+# Show a rich visual guide
+salat guide
 
-# Run with custom city
-
-$ salat [cityName]
+# List all available cities
+salat cities
 ```
 
-## Output
+### CLI Help
 
-```bash
-# The programs prints to the console the prayers' time for the current day in the default city as shown bellow:
-```
+```text
+Usage: salat [options] [command]
 
-![screen 1](images/screenShot1.png)
-![screen 2](images/screenShot2.png)
-![screen 3](images/screenShot3.png)
+Daily Moroccan prayers time, right in your console
 
-## Change the default city
+Options:
+  -V, --version           output the version number
+  -h, --help              display help for command
+
+Commands:
+  times [options] [city]  Get prayer times for a city
+  guide                   Show a rich visual guide to using salat-cli
+  cities                  Display the list of available city names
+  help [command]          display help for command
+```
 
-- The default city is :heart: [Marrakech](https://www.google.com/search?q=marrakech) :heart:, set as a value for the `DEFAULT_CITY` variable in `./constants.js`
+## 🏗 Dependencies
 
-- You can change it by replacing `Marrakech` by your city name according to the values from `./data/cities.json`
+This project is built on the shoulders of giants:
 
-## Help
+- [**Ink**](https://github.com/vadimdemedes/ink) - React for interactive command-line apps.
+- [**Commander.js**](https://github.com/tj/commander) - The complete solution for node.js command-line interfaces.
+- [**date-fns**](https://date-fns.org/) - Modern JavaScript date utility library.
+- [**node-fetch**](https://github.com/node-fetch/node-fetch) - A light-weight module that brings `window.fetch` to Node.js.
+- [**domino**](https://github.com/fent/domino) - Server-side DOM implementation for parsing API responses.
+- [**node-localstorage**](https://github.com/lmaccherone/node-localstorage) - LocalStorage implementation for Node.js.
 
-- Please keep in mind that this is a work in progress in a very early stages, any help is appreciated and more than welcome.
+## 🤝 Contributing
 
-- If you think this piece of code is anyhow useful, please feel free to `contribute`, `star` :star::star: and `share` 🙏 🙏
+Contributions are welcome! Whether it's a bug fix, a new feature, or better documentation.
 
-## Todo
+1.  **Fork** the project.
+2.  **Clone** your fork: `git clone https://github.com/kafiln/salat-cli.git`
+3.  **Install** dependencies: `npm install`
+4.  **Live Development**: `npm run dev`
+5.  **Build**: `npm run build`
+6.  **Test**: `npm test`
+7.  **Submit** a Pull Request.
 
-- [x] Use a default city
-- [x] Use localstorage-like api for caching purposes
-- [ ] Improve performance
-- [ ] Add unit tests
-- [x] Add a documentation site
-- [ ] Command to set the default city
-- [ ] Command to display the list of available cities
-- [ ] Command to display the time table for the whole month
+## ⭐ Show your support
 
-## License
+If this project helped you, please consider giving it a **Star** on GitHub! It means a lot.
 
-This project is under the MIT license.
+---
 
-### Built With 💖 in Ramadan
+Built with ❤️ by [Kafil NASDAMI](https://github.com/kafiln)

package/dist/app.js

@@ -1,19 +1,16 @@
 #!/usr/bin/env node
-// Project's dependencies
-import { render } from "ink";
-import React from "react";
-import App from "./ui.js"; // Note the .js extension for ESM imports
-import { Command } from "commander";
 // Project's setup
 process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";
+import { citiesCommand } from "#commands/cities";
+import { guideCommand } from "#commands/guide";
+import { timesCommand } from "#commands/times";
+import { Command } from "commander";
 const program = new Command();
 program
     .name("salat")
     .description("Daily Moroccan prayers time, right in your console")
-    .version("4.2.0")
-    .argument("[city]", "City name")
-    .option("-1, --once", "Run once and exit", false)
-    .action((city, options) => {
-    render(React.createElement(App, { cityNameArg: city, once: options.once }));
-});
+    .version("4.6.0")
+    .addCommand(timesCommand, { isDefault: true })
+    .addCommand(guideCommand)
+    .addCommand(citiesCommand);
 program.parse();

package/dist/commands/cities.js

@@ -0,0 +1,11 @@
+import CitiesApp from "#components/CitiesApp";
+import { Command } from "commander";
+import { render } from "ink";
+import React from "react";
+export const citiesCommand = new Command("cities")
+    .description("Display the list of available city names")
+    .option("-1, --once", "Run once and exit", true) // Default to true for a static list
+    .action(() => {
+    // We always run this "once" because it's just a list
+    render(React.createElement(CitiesApp));
+});

package/dist/commands/guide.js

@@ -0,0 +1,10 @@
+import HelpApp from "#components/HelpApp";
+import { Command } from "commander";
+import { render } from "ink";
+import React from "react";
+export const guideCommand = new Command("guide")
+    .description("Show a rich visual guide to using salat-cli")
+    .option("-1, --once", "Run once and exit", false)
+    .action(() => {
+    render(React.createElement(HelpApp));
+});

package/dist/commands/times.js

@@ -0,0 +1,11 @@
+import App from "#components/TimesApp";
+import { Command } from "commander";
+import { render } from "ink";
+import React from "react";
+export const timesCommand = new Command("times")
+    .description("Get prayer times for a city")
+    .argument("[city]", "City name")
+    .option("-1, --once", "Run once and exit", false)
+    .action((city, options) => {
+    render(React.createElement(App, { cityNameArg: city, once: options.once }));
+});

package/dist/components/CitiesApp.js

@@ -0,0 +1,10 @@
+import { jsxs as _jsxs, jsx as _jsx } from "react/jsx-runtime";
+import { Box, Text } from "ink";
+import citiesData from "../data/cities.json" with { type: "json" };
+const CitiesApp = () => {
+    const cities = citiesData;
+    // Sort cities alphabetically
+    const sortedCities = [...cities].sort((a, b) => a.name.localeCompare(b.name));
+    return (_jsxs(Box, { flexDirection: "column", padding: 1, children: [_jsx(Box, { marginBottom: 1, children: _jsxs(Text, { bold: true, color: "cyan", children: ["\uD83C\uDF0D Available Cities in Morocco (", cities.length, ")"] }) }), _jsx(Box, { flexDirection: "row", flexWrap: "wrap", children: sortedCities.map((city) => (_jsxs(Box, { width: 25, marginBottom: 0, children: [_jsx(Text, { color: "gray", children: "- " }), _jsx(Text, { children: city.name })] }, city.id))) }), _jsx(Box, { marginTop: 1, children: _jsxs(Text, { color: "gray", children: ["Tip: Use these names with the 'times' command, e.g., 'salat times ", sortedCities[0]?.name, "'"] }) })] }));
+};
+export default CitiesApp;

package/dist/components/HelpApp.js

@@ -0,0 +1,6 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { Box, Text } from "ink";
+const HelpApp = () => {
+    return (_jsxs(Box, { flexDirection: "column", padding: 1, borderStyle: "round", borderColor: "cyan", children: [_jsx(Box, { marginBottom: 1, justifyContent: "center", children: _jsx(Text, { bold: true, color: "cyan", children: "\u2728 SALAT CLI GUIDE \u2728" }) }), _jsxs(Box, { flexDirection: "column", marginBottom: 1, children: [_jsx(Text, { bold: true, underline: true, children: "Usage:" }), _jsx(Text, { children: "  $ salat [command] [options]" })] }), _jsxs(Box, { flexDirection: "column", marginBottom: 1, children: [_jsx(Text, { bold: true, underline: true, children: "Commands:" }), _jsxs(Box, { marginLeft: 2, flexDirection: "column", children: [_jsxs(Box, { children: [_jsx(Box, { width: 20, children: _jsx(Text, { color: "yellow", children: "times [city]" }) }), _jsx(Text, { children: "Show prayer times (default)" })] }), _jsxs(Box, { children: [_jsx(Box, { width: 20, children: _jsx(Text, { color: "yellow", children: "guide" }) }), _jsx(Text, { children: "Show this rich help page" })] }), _jsxs(Box, { children: [_jsx(Box, { width: 20, children: _jsx(Text, { color: "yellow", children: "cities" }) }), _jsx(Text, { children: "Display the list of available city names" })] })] })] }), _jsxs(Box, { flexDirection: "column", marginBottom: 1, children: [_jsx(Text, { bold: true, underline: true, children: "Options:" }), _jsxs(Box, { marginLeft: 2, flexDirection: "column", children: [_jsxs(Box, { children: [_jsx(Box, { width: 20, children: _jsx(Text, { color: "green", children: "-1, --once" }) }), _jsx(Text, { children: "Run once and exit" })] }), _jsxs(Box, { children: [_jsx(Box, { width: 20, children: _jsx(Text, { color: "green", children: "-v, --version" }) }), _jsx(Text, { children: "Show version" })] }), _jsxs(Box, { children: [_jsx(Box, { width: 20, children: _jsx(Text, { color: "green", children: "-h, --help" }) }), _jsx(Text, { children: "Show standard text help" })] })] })] }), _jsxs(Box, { flexDirection: "column", borderStyle: "single", borderColor: "gray", paddingX: 1, children: [_jsx(Text, { italic: true, color: "gray", children: "Example:" }), _jsx(Text, { color: "white", children: "  $ salat Rabat --once" }), _jsx(Text, { color: "white", children: "  $ salat guide" })] }), _jsx(Box, { marginTop: 1, justifyContent: "flex-end", children: _jsx(Text, { color: "gray", children: "Tip: Press Ctrl+C to exit the live timer." }) })] }));
+};
+export default HelpApp;

package/dist/{ui.js → components/TimesApp.js}

@@ -1,12 +1,12 @@
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import { LOCAL_STORAGE_PATH } from "#constants";
-import { getCityId, getCityName, getData, getNextPrayer, parsePrayerTimesFromResponse, tConv24, } from "#utils";
+import { LOCAL_STORAGE_PATH } from "#services/constants";
+import { getCityId, getCityName, getData, getNextPrayer, parsePrayerTimesFromResponse, tConv24, } from "#services/utils";
 import { Box, Text, useApp } from "ink";
 import { useEffect, useState } from "react";
 // @ts-ignore
 import { format } from "date-fns";
 import { LocalStorage } from "node-localstorage";
-import citiesData from "./data/cities.json" with { type: "json" };
+import citiesData from "../data/cities.json" with { type: "json" };
 const cities = citiesData;
 const localStorage = new LocalStorage(LOCAL_STORAGE_PATH);
 const App = ({ cityNameArg, once }) => {

package/dist/{utils.js → services/utils.js}

@@ -1,8 +1,8 @@
-import { API_URL, DEFAULT_CITY, NOT_FOUND_ERROR } from "#constants";
+import { API_URL, DEFAULT_CITY, NOT_FOUND_ERROR } from "#services/constants";
 import { addDays, differenceInSeconds, format, parse } from "date-fns";
 import domino from "domino";
 import fetch from "node-fetch";
-import prayersData from "./data/prayers.json" with { type: "json" };
+import prayersData from "../data/prayers.json" with { type: "json" };
 export const getCityName = (arg, cities) => {
     if (arg == null)
         return DEFAULT_CITY;

package/dist/{utils.test.js → services/utils.test.js}

@@ -1,5 +1,5 @@
-import * as constants from '#constants';
-import { getCityId, getCityName, getNextPrayer, parsePrayerTimesFromResponse } from '#utils';
+import * as constants from '#services/constants';
+import { getCityId, getCityName, getNextPrayer, parsePrayerTimesFromResponse } from '#services/utils';
 import { parseISO } from 'date-fns';
 import { describe, expect, it, vi } from 'vitest';
 // Mock cities data

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "salat",
-  "version": "4.3.0",
+  "version": "4.6.1",
   "imports": {
     "#*": "./dist/*.js"
   },
@@ -11,6 +11,9 @@
     "salat": "dist/app.js"
   },
   "type": "module",
+  "files": [
+    "dist"
+  ],
   "dependencies": {
     "commander": "^14.0.3",
     "date-fns": "^4.1.0",
@@ -22,7 +25,7 @@
   },
   "scripts": {
     "dev": "node --no-warnings --loader ts-node/esm src/app.ts",
-    "build": "tsc",
+    "build": "tsc && chmod +x dist/app.js",
     "start": "node dist/app.js",
     "prestart": "npm run build",
     "prepublishOnly": "npm run build",

package/src/app.ts

@@ -1,25 +0,0 @@
-#!/usr/bin/env node
-
-// Project's dependencies
-import { render } from "ink";
-import React from "react";
-import App from "./ui.js"; // Note the .js extension for ESM imports
-
-import { Command } from "commander";
-
-// Project's setup
-process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";
-
-const program = new Command();
-
-program
-  .name("salat")
-  .description("Daily Moroccan prayers time, right in your console")
-  .version("4.2.0")
-  .argument("[city]", "City name")
-  .option("-1, --once", "Run once and exit", false)
-  .action((city, options) => {
-    render(React.createElement(App, { cityNameArg: city, once: options.once }));
-  });
-
-program.parse();

package/src/constants.ts

@@ -1,13 +0,0 @@
-export const API_URL = "https://www.habous.gov.ma/prieres/horaire-api.php";
-
-export const BANNER = ``;
-
-export const NOT_FOUND_ERROR = `
-  Your city was not found in the list
-  Using the default city
-  ----------------------
-  You may need to check the spelling
-  `;
-
-export const DEFAULT_CITY = "Marrakech";
-export const LOCAL_STORAGE_PATH = "./storage";