docs: updates on workflows

Added information on documentation

.github/workflows/codespell.yaml

@@ -19,7 +19,7 @@ jobs:
       - name: codespell
         uses: codespell-project/actions-codespell@master
         with:
-          skip: .git,*.png,*.jpg,*.svg,*.sum,*.json,*.lock
+          skip: .git,*.png,*.jpg,*.svg,*.sum,*.json,*.lock,*.js,*.html,*.yml
           ignore_words_list: aks,keyserver,atleast,dne,ser,ist,files',ba,dum,iam,te,parm
           check_filenames: true
           check_hidden: true

.github/workflows/opengraph-card.yml

@@ -41,7 +41,9 @@ jobs:
             full_path="${full_path}&heights=$i"
           done
 
+          mkdir -p images
           echo "$full_path"
+
           curl "$full_path" > ./images/opengraph-card.png
         shell: bash
 

typings/standard-types.ts

@@ -0,0 +1,4 @@
+/**
+ * Optional {@link T} or null/undefined type
+ */
+export type Optional<T> = T | null | undefined

typings/types.ts

@@ -1,28 +1,19 @@
+import { Optional } from './standard-types'
+
 export enum HeroPattern {
-    plus = 'plus',
-    topography = 'topography',
-    texture = 'texture',
-    hideout = 'hideout',
-    fallingTriangles = 'fallingTriangles',
-    iLikeFood = 'iLikeFood',
-    fourPointStars = 'fourPointStars',
-    brickWall = 'brickWall',
-    wiggle = 'wiggle',
     jigsaw = 'jigsaw',
-    bubbles = 'bubbles',
-    floatingCogs = 'floatingCogs',
-    leaf = 'leaf',
-    rain = 'rain',
-    polkaDots = 'polkaDots',
-    ticTacToe = 'ticTacToe',
     overcast = 'overcast',
     formalInvitation = 'formalInvitation',
+    topography = 'topography',
+    texture = 'texture',
     jupiter = 'jupiter',
     architect = 'architect',
     cutout = 'cutout',
+    hideout = 'hideout',
     graphPaper = 'graphPaper',
     yyy = 'yyy',
     squares = 'squares',
+    fallingTriangles = 'fallingTriangles',
     pianoMan = 'pianoMan',
     pieFactory = 'pieFactory',
     dominos = 'dominos',
@@ -33,6 +24,7 @@ export enum HeroPattern {
     stampCollection = 'stampCollection',
     deathStar = 'deathStar',
     churchOnSunday = 'churchOnSunday',
+    iLikeFood = 'iLikeFood',
     overlappingHexagons = 'overlappingHexagons',
     bamboo = 'bamboo',
     bathroomFloor = 'bathroomFloor',
@@ -47,25 +39,32 @@ export enum HeroPattern {
     xEquals = 'xEquals',
     anchorsAway = 'anchorsAway',
     bevelCircle = 'bevelCircle',
+    brickWall = 'brickWall',
     fancyRectangles = 'fancyRectangles',
     heavyRain = 'heavyRain',
     overlappingCircles = 'overlappingCircles',
+    plus = 'plus',
     roundedPlusConnected = 'roundedPlusConnected',
     volcanoLamp = 'volcanoLamp',
+    wiggle = 'wiggle',
+    bubbles = 'bubbles',
     cage = 'cage',
     connections = 'connections',
     current = 'current',
     diagonalStripes = 'diagonalStripes',
     flippedDiamonds = 'flippedDiamonds',
+    floatingCogs = 'floatingCogs',
     glamorous = 'glamorous',
-    houndstooth = 'houndstooth',
+    leaf = 'leaf',
     linesInMotion = 'linesInMotion',
     moroccan = 'moroccan',
     morphingDiamonds = 'morphingDiamonds',
     rails = 'rails',
+    rain = 'rain',
     skulls = 'skulls',
     squaresInSquares = 'squaresInSquares',
     stripes = 'stripes',
+    ticTacToe = 'ticTacToe',
     zigZag = 'zigZag',
     aztec = 'aztec',
     bankNote = 'bankNote',
@@ -83,6 +82,7 @@ export enum HeroPattern {
     overlappingDiamonds = 'overlappingDiamonds',
     parkayFloor = 'parkayFloor',
     pixelDots = 'pixelDots',
+    polkaDots = 'polkaDots',
     signal = 'signal',
     slantedStars = 'slantedStars',
     wallpaper = 'wallpaper',
@@ -131,11 +131,6 @@ export enum CategoryPattern {
     portuguese = 'portuguese',
 }
 
-/**
- * Optional {@link T} or null/undefined type
- */
-export type Optional<T> = T | null | undefined
-
 export type QuoteData = {
     /**
      * Quote identifier
@@ -151,8 +146,6 @@ export type QuoteData = {
     author: string
 }
 
-export type QuoteMapper = { [K in CategoryPattern]: QuoteData[] }
-
 export interface ParsedRequest {
     /**
      * Quote category
@@ -260,10 +253,3 @@ export interface ProfileOptions {
      */
     readonly indexOptions: IndexOptions
 }
-
-/**
- * Profile configuration options.
- */
-export type ConfigOptions = {
-    readonly [K in Profile]: ProfileOptions
-}

utils/bg-hero.ts

@@ -1,13 +1,14 @@
 import * as pattern from 'hero-patterns'
 
-import { HeroPattern, Optional } from '../typings/types'
+import { Optional } from '../typings/standard-types'
+import { HeroPattern } from '../typings/types'
 import { randomEnum, strToEnum } from './commons'
 
 type PatternOperator = (fill: string, opacity: string) => string
 
-type PatternMapper = { [K in HeroPattern]: PatternOperator }
+type PatternMapper = Record<HeroPattern, PatternOperator>
 
-const patternMapper: PatternMapper = strToEnum(Object.values(HeroPattern), value => pattern[value])
+const patternMapper: Readonly<PatternMapper> = strToEnum(Object.values(HeroPattern), value => pattern[value])
 
 const getPattern = (pattern: Optional<HeroPattern>, opacity: string, colorPattern: string): string => {
     const patternOperator: PatternOperator = pattern

utils/config.ts

@@ -1,4 +1,6 @@
-import { ConfigOptions } from '../typings/types'
+import { Profile, ProfileOptions } from '../typings/types'
+
+export type ConfigOptions = Record<Profile, ProfileOptions>
 
 export const CONFIG: Readonly<ConfigOptions> = {
     dev: {

utils/env.ts

@@ -1,8 +1,8 @@
 import { ProfileOptions } from '../typings/types'
 import { CONFIG } from './config'
 
-const getProfileOptions = (): ProfileOptions => {
+const getProfile = (): ProfileOptions => {
     return process.env.AWS_LAMBDA_FUNCTION_VERSION ? CONFIG.prod : CONFIG.dev
 }
 
-export const profile = getProfileOptions()
+export const profile = getProfile()

utils/quote.ts

@@ -1,13 +1,14 @@
+import gradient from 'gradient-string'
+import randomColor from 'randomcolor'
+
+import { Optional } from '../typings/standard-types'
 import {
     CategoryPattern,
     ColorOptions,
     ImageOptions,
-    Optional,
     ParsedRequest,
     QuoteData,
 } from '../typings/types'
-import gradient from 'gradient-string'
-import randomColor from 'randomcolor'
 
 import { getSearchResults, idx } from './search'
 import { capitalize, delim, mergeProps, randomElement, randomEnum, toFormatString } from './commons'

utils/quotes.ts

@@ -45,9 +45,11 @@ import * as wisdom from '../data/wisdom_quotes.json'
 import * as writing from '../data/writing_quotes.json'
 
 import { mergeProps } from './commons'
-import { QuoteMapper } from '../typings/types'
+import { CategoryPattern, QuoteData } from '../typings/types'
 
-const getQuoteData = (): QuoteMapper =>
+export type QuoteMapper = Record<CategoryPattern, QuoteData[]>
+
+const getQuotes = (): QuoteMapper =>
     mergeProps<QuoteMapper>(
         anger,
         books,
@@ -96,4 +98,4 @@ const getQuoteData = (): QuoteMapper =>
         writing
     )
 
-export const quotes = getQuoteData()
+export const quotes = getQuotes()

utils/search.ts

@@ -4,12 +4,12 @@ import { join } from 'path'
 import boxen from 'boxen'
 import cron from 'node-cron'
 
-import { quotes } from './quotes'
-
 import { CategoryPattern } from '../typings/types'
 import { ensureDirExists, tempDir } from './commons'
 import { profile } from './env'
 
+import { quotes } from './quotes'
+
 const task = cron.schedule('0 * * * *', () => {
     console.log(
         boxen('Running task every 60 minutes on index search', {