jsphoon

ASCII Art Phase of the Moon (TypeScript version)

---

The original version of this was by Jef Poskanzer jef@mail.acme.com (Twitter: @jef_poskanzer) written in Pascal in 1979.

It's been translated by him into C, then by @igor_chubin into Python, and now by me into TypeScript.

I'm basing this one off of the Python version.

Usage

I'm aiming for options to be mostly similar to the Python version usage over here on pyphoon's readme.

[ ] = optional flag
[ <> ] = required arg to flag
[ <> = X ] = default value if flag is not supplied

jsphoon [--lines <LINES=23>] [--language <LANGUAGE=en>]
        [--hemisphere <"north","south"=north>] [--date <DATE=now>]
        [--show-hemisphere-text] [--no-text] [--no-color]

supported locales: "ar", "be", "bg", "ca", "cs", "da", "de", "en", "et", "el", "es", "eo", "fi", "fr", "hr", "hy", "ia", "it", "ko", "kn", "ja", "lt", "nl", "ru", "pl", "pt", "ro", "sk", "sr", "sv", "th", "uk", "zh_TW", "nb", "nn", "cy", "tr"

supported dates: 
— any ISO Date
    - "2021-04-24"
    - "2021-04-24T05:20"
— UNIX timestamp, in ms
    - 1688134732982

Note that there is no help command as of v0.1.

Installation

Currently, you'll have to:

git clone https://github.com/PineappleRind/jsphoon
cd jsphoon
bun i
bun src/main.ts

JSPhoon uses the Bun runtime for faster installation times and TypeScript support out-of-the-box.

Contributing

Project Structure

src/
├── calculations/
├── constants/
├── frontend/
├── moons/
├── utils/
├── main.ts
└── printMoon.ts

test/
└── *.test.ts

Here's what everything does.

• src/calculations/ contains the main astronomical calculations. This was formerly in pyphoon's astro module.

• src/constants/ contains some constants to help in various calculations and determining settings.

• src/frontend/ is honestly just an umbrella for anything user-facing. It contains things like colorization (what the user sees), parsing settings (what the user gives), and localization (how the user understands).

• src/moons/ contains the raw ASCII of moons at various resolutions (column count). Sometimes, a moon won't look correct. Maybe that's because the entire thing is shifted a bit to the left or right via spaces. I just use trial and error to find the correct offset.

• src/utils/ contains various helper functions and types for everyone, e.g. Julian date conversions and math shorthands.

• src/main.ts is the entry point. It ties everything together.

• src/printMoon.ts gets information from various calculations, applies it to a moon, and prints it along with some metadata.

• test/*.test.ts are testing files. You can run the tests with bun test. They usually correspond to the folder (or file, if it's directly in src/) they're helping to test; utils.test.ts helps with testing everything in src/utils, and calculations.test.ts helps with testing everything in src/calculations.

How can I help?

Here's some information on contributing to Open Source in general. A lot of it applies here.

tl;dr your average open source project, you can open issues on anything pertaining to this project or PRs if you want to contribute something code-related