hili-lipsum v3.2.1

hili-lipsum

Hilichurlian language lorem ipsum generator and web scraper using data from the Genshin Impact Fandom Wiki at https://genshin-impact.fandom.com/wiki/Hilichurlian/Lexicon.

Data Structure

The "npm run scrape" web scraper script extracts Hilichurlian language data from https://genshin-impact.fandom.com/wiki/Hilichurlian/Lexicon into an array of JSON Objects under the "data" key.

It has the following format and structure:

Example

{
  "metadata": {
    "source": "https://genshin-impact.fandom.com/wiki/Hilichurlian/Lexicon",
    "title": "Hilichurlian Language Dictionary",
    "description": "Dictionary of Hilichurlian words and their English translations exctracted from the source URL.",
    "date_created": "2024-10-19T08:11:48.917Z"
  },
  "data": [
    {
      "word": "da",
      "eng": "good/very good, affirmation, very (emphasis)",
      "cn": "",
      "notes": "Can be used as praise"
    },
    ...
  ]
}

Checkout the full web-scraped data in the /data/hilichurlianDB.json file for more information.

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Requirements

The following requirements were used for this project. Feel free to use other dependencies and versions as needed.

1. Windows 10 OS
2. NodeJS LTS v20 or higher

   Recommended:
   node: v20.15.0
   npm: v10.7.0

Content

• hili-lipsum
• Data Structure
• Contributing
• Requirements
• Content
• Installation
• Available Scripts
  • npm run scrape
  • npm run hipsum
  • npm run lint
  • npm run lint:fix
• Usage with Docker
  • Preparing the Local Image
  • Using the Docker Image
• Class Usage
  • Hilichurl Class
  • Hilipsum Class
• Deployment with GitHub Actions

Installation

1. Clone this repository. git clone https://github.com/weaponsforge/hili-lipsum.git

2. Install dependencies. npm install

3. Create a .env file from the .env.example file. Use the default value for HILICHURLIAN_TEXT_URL.

   Variable Name	Description
   HILICHURLIAN_TEXT_URL	Target web page to scrape, containing Hilichurilian words definition.Default value is: https://genshin-impact.fandom.com/wiki/Hilichurlian/Lexicon You can reference other Hilichurlian words wiki or web page to scrape, but be be sure to make the necessary adjustments on the web scraping logic on /src/classes/hilichurl/hilichurl.js - scrapewords() and formatwords() methods.

Available Scripts

npm run scrape

Download, scrape and format hilichurlian words from the HILICHURLIAN_TEXT_URL .env variable. Writes the extracted and formatted words into a /hilichurlianDB-<TIMESTAMP>.json file.

npm run hipsum

• Generates a random ipsum-like Hilichurlian sentence consisting of 15 words by default.

• Generates a random Hilichurlian sentence consisting of N words if provided with the --wordcount flag:

  npm run hipsum --wordcount=100

npm run lint

Lint JavaScript source codes.

npm run lint:fix

Fix JavaScript lint errors.

npm run scrape:debug

Sets the IS_DOCKER=true environment variable before running the npm run scrape script to enable debugging with VSCode inside a container.

This command runs only in a Linux environment.

npm run create:declaration

Generates TypeScript declaration .d.ts files from the CommonJS JavaScript classes and scripts.

npm test

Run tests defined in the __tests__ directory.

Usage with Docker

Pulling and using the Docker image requires a .env variable before proceeding. Create a .env first from the .env.example file as instructed in the Installation section.

Preparing the Local Image

Obtain the development Docker image using any of the two (2) options. Navigate to the repository's root directory using a terminal, then run:

• Pull the Pre-Built Docker Image docker compose -f docker-compose.dev.yml pull

• Build the Local Image docker compose -f docker-compose.dev.yml build

Using the Docker Image

1. Run the development container. docker compose -f docker-compose.dev.yml up

2. Run the Available Scripts using the container. For example: docker exec -it weaponsforge-hili-lipsum npm run scrape

Class Usage

Hilichurl Class

The Hilichurl Class allows to specify a local JSON file to use as a word dictionary. The JSON file should follow the format in /data/hilichurlianDB.json

const { Hilichurl } = require('./src/lib/classes/hilichurl')
const path = require('path')

// Use the the following if installed via npm
// const { Hhilichurl } = require('hili-lipsum')

const main = async () => {
  try {
    // Instantiate a new Hilichurl class with local JSON data
    const dataPath = path.join(__dirname, 'data', 'hilichurlianDB.json')
    const hilichurl = new Hilichurl(dataPath)

    // Load new local JSON data
    hilichurl.loadrecords(dataPath)

    // Generate a random-word sentence
    const sentence = hilichurl.lipsum(40)
    console.log(sentence)

    // Download and replace the current word dictionary
    await hilichurl.fetchrecords()

    // Write the word dictionary to a JSON file
    hilichurl.writerecords()
  } catch (err) {
    console.log(err.message)
  }
}

main()

Hilipsum Class

The Hilipsum class is a sub-class of Hilichurl. It automatically loads the local JSON word dictionary (/data/hilichurlianDB.json) on initialization.

const { Hilipsum } = require('./src/lib/classes/hilipsum')

// Use the the following if installed via npm
// const { Hilipsum } = require('hili-lipsum')

const hiLipsum = new Hilipsum()

// Generate a random hilichurlian sentence
console.log(hiLipsum.lipsum())

Deployment with GitHub Actions

This repository deploys the latest local development Docker image to Docker Hub. It publishes the latest tag version to the NPM registry on the creation of new Release/Tags from the master branch.

Add the following GitHub Secrets and Variables to enable deployment to Docker Hub and the NPM registry.

Docker Hub https://hub.docker.com/r/weaponsforge/hili-lipsum

NPM Registry https://www.npmjs.com/package/hili-lipsum

GitHub Secrets

GitHub Variables

@weaponsforge 20220805 20241018