Skip to content

Commit d63d37b

Browse files
committed
chore: initial commit と༼ ◕_◕ と ༽
0 parents  commit d63d37b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+8256
-0
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
- [ ] Get the list of word categories (themes) in the `words` directory where each category has a corresponding `words/<list>.txt` file.
2+
3+
- [ ] For each category, run the command to generate the export files:
4+
5+
```bash
6+
bun run ./scripts/generate.ts <list> <ClassName>
7+
```
8+
9+
Where `<list>` is the name of the words list (e.g., `cities`, `animals`) and `<ClassName>` is the name of the class representing each item in the list (e.g., `City`, `Animal`, etc.).
10+
11+
- [ ] Update `exports` in `package.json` to ensure that it contains all the word lists with the default export for each category pointing to `<list>-20.ts` (default) file. These exports need to support Bun, Deno, TypeScript, types, and ESM.
12+
13+
- [ ] Update the list of themes in `cli.ts`; use `./words/<list>-100.js` as the default theme for each category.
14+
15+
- [ ] Update the "Word Lists" section in `README.md` to ensure that the list of categories and the top 10 words for each category are accurate and up-to-date.
16+
17+
- [ ] Format the generated files using Prettier:
18+
19+
```bash
20+
bun prettier --write .
21+
```

.claude/commands/generate-words.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Your task is to generate a curated list of exactly 100 words for a given theme or category.
2+
3+
**Theme or Category:** $ARGUMENTS
4+
5+
Load existing list from `words/<list>.txt` file, if it exists to see if you can improve this list by adding, removing, or re-ordering items (just small incremental updates). If the file does not exist, create a new one.
6+
7+
Follow these rules strictly:
8+
9+
**1. Word Constraints:**
10+
11+
- **Length:** Every word must be 7 characters long or shorter (i.e., less than 8 characters).
12+
- **Simplicity:** Use only single, non-compound words. For example, for the theme 'weather', use 'rain' and 'snow', but not 'thunderstorm'.
13+
- **Purity:** Do not include abbreviations, acronyms, slang, or proper nouns (like brands, 'USA', 'UK', etc.).
14+
15+
**2. List Ordering:**
16+
The list must be sorted by the following criteria, in this specific order of priority:
17+
18+
- **Primary Criterion - Memorability (Weight: 0.5):** Place the most common, fundamental, and evocative words first. These should be high-frequency words that are strongly associated with the theme and easy to recall.
19+
- **Secondary Criterion - Shortness (Weight: 0.3):** When words have a similar level of memorability, the shorter word must come first.
20+
- **Tertiary Criterion - Easy to Spell (Weight 0.2):** If two words are equally memorable and of the same length, the one that is easier to spell should come first.
21+
22+
Please generate only the final, numbered list of 100 words.
23+
24+
Save it to `words/<list>.txt` file, one word per line without any additional formatting or prefixes.
25+
26+
Run `bun prettier --write words/<list>.txt` to format the file after generating the list.

.github/FUNDING.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# GitHub Sponsors configuration
2+
github: koistya

.github/copilot-instructions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
#file:../CLAUDE.md

.github/workflows/main.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: CI/CD
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v4
15+
16+
# https://github.com/oven-sh/setup-bun
17+
- uses: oven-sh/setup-bun@v2
18+
with:
19+
bun-version: latest
20+
21+
# https://github.com/actions/cache
22+
- uses: actions/cache@v4
23+
with:
24+
path: |
25+
~/.bun/install/cache
26+
key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lock') }}
27+
28+
- run: bun install --frozen-lockfile
29+
30+
- run: bun prettier --check .
31+
32+
- run: bun eslint .
33+
34+
- run: bun test

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules/
2+
*.log
3+
.env*
4+
.DS_Store
5+
dist/
6+
build/

.vscode/settings.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"editor.defaultFormatter": "esbenp.prettier-vscode",
3+
"editor.formatOnSave": true,
4+
"editor.tabSize": 2,
5+
"cSpell.words": ["codenames", "kriasoft"]
6+
}

0 commit comments

Comments
 (0)