aric/qibla
1
0
Fork 0
mirror of https://github.com/acamarata/qibla.git synced 2026-06-30 19:04:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore: align repository structure with portfolio documentation standards

Browse source
This commit is contained in:
Aric Camarata 2026-05-15 15:27:43 -04:00
parent be0513f89f
commit 2fcf3d3201
6 changed files with 42 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

0
.wiki/API-Reference.md → .github/wiki/API-Reference.md vendored
View file

0
.wiki/Architecture.md → .github/wiki/Architecture.md vendored
View file

0
.wiki/Home.md → .github/wiki/Home.md vendored
View file

4
.github/workflows/wiki-sync.yml vendored
View file

@ -3,7 +3,7 @@ name: Sync Wiki
on: on:
push: push:
branches: [main] branches: [main]
paths: [".wiki/**"] paths: [".github/wiki/**"]
workflow_dispatch: workflow_dispatch:
permissions: permissions:
@ -29,7 +29,7 @@ jobs:
- name: Sync wiki pages - name: Sync wiki pages
if: steps.clone_wiki.outputs.wiki_exists == 'true' if: steps.clone_wiki.outputs.wiki_exists == 'true'
run: | run: |
cp .wiki/*.md .wiki-remote/ cp .github/wiki/*.md .wiki-remote/
cd .wiki-remote cd .wiki-remote
git config user.name "github-actions[bot]" git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com" git config user.email "github-actions[bot]@users.noreply.github.com"

36
src/index.ts
View file

@ -10,14 +10,17 @@
* @module * @module
*/ */
/** Latitude of the Ka'bah center, Masjid al-Haram, Mecca (degrees north). */ export * from "./types.js";
export const KAABA_LAT = 21.422511;
/** Longitude of the Ka'bah center, Masjid al-Haram, Mecca (degrees east). */ import {
export const KAABA_LNG = 39.82615; KAABA_LAT,
KAABA_LNG,
/** Mean radius of the Earth in kilometers (WGS-84 volumetric mean). */ EARTH_RADIUS_KM,
export const EARTH_RADIUS_KM = 6371; COMPASS_ABBR,
COMPASS_NAMES,
type CompassAbbr,
type CompassName,
} from "./types.js";
const DEG = Math.PI / 180; const DEG = Math.PI / 180;
@ -50,26 +53,7 @@ export function qiblaAngle(lat: number, lng: number): number {
return (Math.atan2(y, x) / DEG + 360) % 360; return (Math.atan2(y, x) / DEG + 360) % 360;
} }
/** Eight-point compass abbreviations. */
const COMPASS_ABBR = ["N", "NE", "E", "SE", "S", "SW", "W", "NW"] as const;
/** Eight-point compass full names. */
const COMPASS_NAMES = [
"North",
"Northeast",
"East",
"Southeast",
"South",
"Southwest",
"West",
"Northwest",
] as const;
/** Compass abbreviation type. */
export type CompassAbbr = (typeof COMPASS_ABBR)[number];
/** Compass full name type. */
export type CompassName = (typeof COMPASS_NAMES)[number];
/** /**
* Eight-point compass abbreviation for a bearing. * Eight-point compass abbreviation for a bearing.

30
src/types.ts Normal file
View file

@ -0,0 +1,30 @@
/** Latitude of the Ka'bah center, Masjid al-Haram, Mecca (degrees north). */
export const KAABA_LAT = 21.422511;
/** Longitude of the Ka'bah center, Masjid al-Haram, Mecca (degrees east). */
export const KAABA_LNG = 39.82615;
/** Mean radius of the Earth in kilometers (WGS-84 volumetric mean). */
export const EARTH_RADIUS_KM = 6371;
/** Eight-point compass abbreviations. */
export const COMPASS_ABBR = ["N", "NE", "E", "SE", "S", "SW", "W", "NW"] as const;
/** Eight-point compass full names. */
export const COMPASS_NAMES = [
"North",
"Northeast",
"East",
"Southeast",
"South",
"Southwest",
"West",
"Northwest",
] as const;
/** Compass abbreviation type. */
export type CompassAbbr = (typeof COMPASS_ABBR)[number];
/** Compass full name type. */
export type CompassName = (typeof COMPASS_NAMES)[number];