Skip to content

InfantAjayVenus/manda-kasaayam

Repository files navigation

மண்ட கசாயம்

English README.en.md

மண்ட கசாயம் என்பது தினசரி குறிப்புகளை தானியங்கு ஒழுங்கமைப்பு மற்றும் பணி கண்காணிப்புடன் நிர்வகிக்கும் முனைய பயனர் இடைமுகம் (TUI) பயன்பாடாகும். இது உங்கள் குறிப்புகளை சுத்தமாகவும் ஒழுங்காகவும் வைத்திருக்க உதவுகிறது, மேலும் முடிக்கப்படாத பணிகளை ஒருபோதும் இழக்காமல் இருக்க உறுதி செய்கிறது.

அம்சங்கள்

  • தினசரி குறிப்புகள்: ஒவ்வொரு நாளும் YYYY-MM-DD.md வடிவத்தில் புதிய மார்க்டவுன் கோப்பை உருவாக்குகிறது
  • தானியங்கு ஒழுங்கமைப்பு: முந்தைய நாள் குறிப்புகளை ஒழுங்கமைக்கப்பட்ட YYYY/MM/ அடைவு கட்டமைப்புக்கு நகர்த்துகிறது
  • பணி தொடர்ச்சி: முந்தைய நாட்களில் இருந்து முடிக்கப்படாத பணிகளை (- [ ]) தானாக முன்னோக்கி கொண்டு செல்கிறது
  • பணி தொடர்ச்சி (மீண்டும்): எல்லா வரலாறு குறிப்புகளிலிருந்தும் முடிக்கப்படாத பணிகளை தேதி இணைப்புகளை பின்தொடர்ந்து இழுக்கிறது
  • ஸ்மார்ட் நேர மூலங்கள்: குறிப்புகளை மீண்டும் திறக்கும் போது சமீபத்திய நேர மூலத்தை புதுப்பிக்கிறது; திருத்தங்களுக்குப் பிறகு பிரிப்பான்களைச் சேர்க்கிறது
  • ஊடாடும் TUI: manda do உடன் பணிகளை நிர்வகிக்கும் முனைய அடிப்படையிலான இடைமுகம்
  • மார்க்டவுன் முன்னோட்டம்: எடிட்டரைத் திறக்காமல் உங்கள் குறிப்புகளைப் பார்க்க manda see
  • விருப்ப கிட் ஒருங்கிணைப்பு: மாற்றங்களை தானாக கமிட் செய்ய முடியும் (முடக்கலாம்)
  • வழிசெலுத்தல் ஆதரவு: முன்னோட்ட முறையில் விசைப்பலகை வழிசெலுத்தலுடன் குறிப்புகளை உலாவுக

நிறுவல்

விருப்பம் 1: npm இலிருந்து நிறுவு (பரிந்துரைக்கப்படுகிறது)

# உலகளவில் நிறுவு
npm install -g manda-kasaayam

# அல்லது pnpm உடன் நிறுவு
pnpm add -g manda-kasaayam

# அல்லது yarn உடன் நிறுவு
yarn global add manda-kasaayam

விருப்பம் 2: மூலத்திலிருந்து நிறுவு

  1. இந்த களஞ்சியத்தை குளோன் செய்யுங்கள்:
git clone https://github.com/yourusername/manda-kasaayam.git
cd manda-kasaayam
  1. சார்புகளை நிறுவுங்கள்:
pnpm install
  1. பயன்பாட்டை உருவாக்குங்கள்:
pnpm build
  1. சூழல் மாறிகளை அமைக்கவும் (கீழே உள்ள கட்டமைப்பைப் பார்க்கவும்)

  2. உங்கள் ஷெல் பாத்தையில் சேர்க்கவும் (விருப்பமானது):

export PATH="$PATH:/path/to/manda-kasaayam/bin"

விருப்பம் 3: வளர்ச்சி நிறுவல்

உள்ளூர்வளர்ச்சி மற்றும் சோதனைக்கு:

# குளோன் செய்து நிறுவு
git clone https://github.com/yourusername/manda-kasaayam.git
cd manda-kasaayam
pnpm install

# சோதனைக்கு உலகளவில் இணைக்கவும்
pnpm link --global

# முடிந்ததும், இணைப்பை நீக்கு
pnpm unlink --global

பயன்பாடு

அடிப்படை பயன்பாடு

இன்றைய குறிப்பைத் திறக்க:

manda

பணி நிர்வாகம்

ஊடாடும் பணி மேலாளரைத் தொடங்கு:

manda do

நேற்றைய பணிகளை நிர்வகிக்க:

manda do --yester

ஒரு குறிப்பிட்ட தேதிக்கு பணிகளை நிர்வகிக்க:

manda do --date 2025-11-25

பணி மேலாளர் கட்டுப்பாடுகள்:

  • ↑↓ அல்லது j/k: பணிகளுக்கு இடையே வழிசெலுத்து
  • Space அல்லது Enter: பணி முடிந்ததை மாற்று
  • g/G: முதல்/கடைசி பணிக்கு செல்ல
  • q அல்லது ESC: வெளியேறு

குறிப்பு முன்னோட்டம்

இன்றைய குறிப்பை முன்னோட்டமிடு:

manda see

நேற்றைய குறிப்பை முன்னோட்டமிடு:

manda see --yester

ஒரு குறிப்பிட்ட தேதியை முன்னோட்டமிடு:

manda see --date 2025-11-25

முன்னோட்ட கட்டுப்பாடுகள்:

  • ↑↓ அல்லது j/k: உள்ளடக்கத்தை உருள்
  • அல்லது h: முந்தைய நாள்
  • அல்லது l: அடுத்த நாள்
  • e: குறிப்பைத் திருத்து (இன்றைய குறிப்பு மட்டுமே)
  • g/G: மேல்/கீழே செல்ல
  • q அல்லது ESC: வெளியேறு

வழிசெலுத்தல் இருக்கும் குறிப்புகளுக்கு இடையே மட்டுமே செயல்படுகிறது.

உதவி

உதவி தகவலைக் காட்சி:

manda --help

கட்டமைப்பு

உங்கள் .zshrc, .bashrc, அல்லது ஷெல் சுயவிவரத்தில் இந்த சூழல் மாறிகளை அமைக்கவும்:

தேவையானது

  • MANDA_DIR: (தேவையானது) உங்கள் குறிப்புகள் அடைவுக்கான முழு பாதை

விருப்பமானது

  • EDITOR: உங்கள் விருப்பமான உரை எடிட்டர் (இயல்புநிலை: nvim)
  • BRANCH: கிட் கிளை பெயர் (இயல்புநிலை: main)
  • REMOTE: கிட் தொலை பெயர் (இயல்புநிலை: origin)
  • GIT_ENABLED: தானியங்கு கிட் கமிட்களை முடக்க (false என அமைக்கவும்) (இயல்புநிலை: true)

எடுத்துக்காட்டு:

export MANDA_DIR="/Users/your_username/Documents/notes"
export EDITOR="vim"
export BRANCH="main"
export REMOTE="origin"

அடைவு கட்டமைப்பு

பயன்பாடு உங்கள் குறிப்புகளை தானாக ஒழுங்கமைக்கிறது:

notes/
├── 2025-11-29.md          # இன்றைய குறிப்பு (ரூட்டில்)
├── 2025/
│   ├── 01/
│   │   ├── 2025-01-31.md  # ஜனவரி குறிப்புகள்
│   │   └── 2025-01-30.md
│   ├── 02/
│   │   └── 2025-02-28.md  # பிப்ரவரி குறிப்புகள்
│   └── 11/
│       ├── 2025-11-28.md  # நேற்றைய குறிப்பு (இங்கே நகர்த்தப்பட்டது)
│       └── 2025-11-27.md
└── .git/                  # கிட் களஞ்சியம்

குறிப்பு வடிவம்

தினசரி குறிப்பு கட்டமைப்பு

# 2025-11-29

[2025-11-28](2025-11-28.md)

- [ ] நேற்றிலிருந்து முடிக்கப்படாத பணி

---

[09:00]
காலை கூட்ட குறிப்புகள்

[10:30]
திட்டம் X இல் வேலை செய்

## பணிகள்

- [ ] இன்றுக்கு புதிய பணி
- [x] முடிக்கப்பட்ட பணி

பணி வடிவம்

நிலையான GitHub Flavored Markdown பணி பட்டியல்களைப் பயன்படுத்துங்கள்:

- [ ] முடிக்கப்படாத பணி
- [x] முடிக்கப்பட்ட பணி

நேர மூலங்கள்

நீங்கள் ஒரு குறிப்பைத் திறக்கும் போது பயன்பாடு தானாக நேர மூலங்களைச் சேர்க்கிறது:

[09:00]
[10:30]
[14:45]

பணிப்பாய்வு

  1. உங்கள் நாளைத் தொடங்குங்கள்: இன்றைய குறிப்பைத் திறக்க manda இயக்கவும்
  2. பணிகளை மதிப்பாய்வு செய்யுங்கள்: எல்லா முந்தைய குறிப்புகளிலிருந்து முடிக்கப்படாத பணிகள் தானாக சேர்க்கப்படுகின்றன
  3. நேர மூலங்களைச் சேர்க்கவும்: சமீபத்திய நேர மூலம் மீண்டும் திறக்கும் போது புதுப்பிக்கப்படுகிறது; திருத்தங்களுக்குப் பிறகு பிரிப்பான்கள் சேர்க்கப்படுகின்றன
  4. முன்னேற்றத்தைக் கண்காணிக்கவும்: பணிகளை ஊடாடும் வகையில் நிர்வகிக்க manda do பயன்படுத்தவும்
  5. குறிப்புகளை முன்னோட்டமிடு: திருத்தாமல் குறிப்புகளை விரைவாக மதிப்பாய்வு செய்ய manda see பயன்படுத்தவும்
  6. தானியங்கு ஒழுங்கமைப்பு: நேற்றைய குறிப்பு YYYY/MM/ அடைவுகளுக்கு நகர்த்தப்படுகிறது
  7. கிட் ஒத்திசைவு: மாற்றங்கள் தானாக கமிட் செய்யப்பட்டு புஷ் செய்யப்படுகின்றன (இயக்கப்பட்டிருந்தால்)

வளர்ச்சி

தொழில்நுட்ப அடுக்கு

  • மொழி: TypeScript
  • TUI கட்டமைப்பு: Ink
  • CLI பாகுபடுத்தல்: Commander.js
  • கிட் ஒருங்கிணைப்பு: simple-git
  • சோதனை: Vitest மற்றும் ink-testing-library

வளர்ச்சிக்கான விரைவான தொடக்கம்

# குளோன் செய்து அமைக்கவும்
git clone https://github.com/yourusername/manda-kasaayam.git
cd manda-kasaayam
pnpm install

# சூழலை அமைக்கவும்
export MANDA_DIR="./dump"  # சோதனை அடைவு
export EDITOR="code"       # அல்லது உங்கள் விருப்பமான எடிட்டர்

# வளர்ச்சியில் இயக்கவும்
pnpm dev

# அல்லது நேரடியாக இயக்கவும்
pnpm start -- --help

சோதனைகளை இயக்குதல்

# எல்லா சோதனைகளையும் இயக்கு
pnpm test

# கண்காணிப்பு முறையில் சோதனைகளை இயக்கு
pnpm test:watch

# குறிப்பிட்ட சோதனை கோப்பை இயக்கு
pnpm test test/domain/note.service.test.ts

# கவரேஜ் உடன் சோதனைகளை இயக்கு
pnpm test --coverage

உருவாக்குதல்

# பயன்பாட்டை உருவாக்கு
pnpm build

# வளர்ச்சி முறையில் இயக்கு
pnpm dev

# உருவாக்கப்பட்ட CLI ஐ சோதிக்கவும்
node dist/main.js --help

CLI நிறுவலை சோதித்தல்

# உள்ளூர் தொகுப்பை சோதிக்கவும்
./docs/test-cli.sh

# அல்லது கைமுறையாக சோதிக்கவும்
npm pack
mkdir test-install && cd test-install
pnpm add ./docs/manda-kasaayam-1.0.0.tgz
npx manda --help
cd .. && rm -rf test-install

கட்டிடக்கலை

பயன்பாடு அடுக்கு அடிப்படையிலான கட்டிடக்கலைக்கு பின்பற்றுகிறது:

src/
├── commands/        # CLI கட்டளை கையாளுபவர்கள்
├── components/      # React TUI கூறுகள்
├── domain/          # வணிக தர்க்கம் மற்றும் சேவைகள்
├── services/        # வெளிப்புற சேவை ஒருங்கிணைப்புகள்
└── main.ts          # பயன்பாட்டின் நுழைவு புள்ளி

முக்கிய கூறுகள்

  • கட்டளைகள்: CLI உள்ளீட்டை கையாளுகின்றன மற்றும் சேவைகளை ஒருங்கிணைக்கின்றன
  • டொமைன்: குறிப்பு நிர்வாகத்திற்கான முக்கிய வணிக தர்க்கம்
  • சேவைகள்: வெளிப்புற ஒருங்கிணைப்புகள் (கோப்பு அமைப்பு, கிட், எடிட்டர்)
  • கூறுகள்: React மற்றும் Ink உடன் கட்டப்பட்ட மீண்டும் பயன்படுத்தக்கூடிய TUI கூறுகள்

CI/CD மற்றும் வெளியீடு

இந்த திட்டம் npm க்கு தானியங்கு சோதனை மற்றும் வெளியீட்டுக்கு GitHub Actions ஐப் பயன்படுத்துகிறது.

பணிப்பாய்வு அம்சங்கள்

  • தானியங்கு சோதனை: Node.js 18, 20, மற்றும் 22 இல் சோதனைகளை இயக்குகிறது
  • தானியங்கு வெளியீடு: GitHub வெளியீடுகளை உருவாக்கும் போது npm க்கு வெளியிடுகிறது
  • சார்பு கேச்சிங்: pnpm கேச் மூலம் விரைவான உருவாக்கங்கள்
  • பாதுகாப்பு: GitHub ரகசியங்களில் சேமிக்கப்பட்ட npm டோக்கன்களைப் பயன்படுத்துகிறது

வெளியீட்டு செயல்முறை

  1. package.json இல் பதிப்பைப் புதுப்பிக்கவும்:

    npm version patch  # அல்லது minor, major
  2. மாற்றங்களையும் குறிச்சொற்களையும் புஷ் செய்யவும்:

    git push origin main --tags
  3. GitHub இல் புதிய வெளியீட்டை உருவாக்கவும்:

    • Releases → Create a new release க்குச் செல்லவும்
    • உருவாக்கப்பட்ட குறிச்சொல்லைத் தேர்ந்தெடுக்கவும்
    • பணிப்பாய்வு தானாக npm க்கு வெளியிடும்

வெளியீட்டுக்கு அமைப்பு

விரிவான அமைப்பு வழிமுறைகளுக்கு GITHUB_ACTIONS_SETUP.md பார்க்கவும்.

பங்களிப்பு

  1. களஞ்சியத்தை ஃபோர்க் செய்யுங்கள்
  2. ஒரு அம்ச கிளையை உருவாக்குங்கள்
  3. உங்கள் மாற்றங்களைச் செய்யுங்கள்
  4. புதிய செயல்பாட்டுக்கு சோதனைகளைச் சேர்க்கவும்
  5. எல்லா சோதனைகளும் தேர்ச்சி பெறுவதை உறுதிசெய்யுங்கள்
  6. ஒரு புல் ரிக்வெஸ்ட் சமர்ப்பிக்கவும்

வளர்ச்சி வழிகாட்டுதல்கள்

  • இருக்கும் குறியீடு நடை மற்றும் முறைகளைப் பின்பற்றுங்கள்
  • புதிய அம்சங்களுக்கு சோதனைகளைச் சேர்க்கவும்
  • தேவைக்கேற்ப ஆவணங்களைப் புதுப்பிக்கவும்
  • TypeScript ஐ கடுமையாகப் பயன்படுத்துங்கள்
  • AGENTS.md இல் விவரிக்கப்பட்ட Outside-In TDD அணுகுமுறையைப் பின்பற்றுங்கள்

உரிமம்

இந்த திட்டம் ISC உரிமத்தின் கீழ் உரிமம் பெற்றது - விவரங்களுக்கு LICENSE கோப்பைப் பார்க்கவும்.

சரிசெய்தல்

பொதுவான சிக்கல்கள்

"MANDA_DIR சூழல் மாறி அமைக்கப்படவில்லை"

  • MANDA_DIR சூழல் மாறியை அமைத்துள்ளீர்கள் என்பதை உறுதிசெய்யுங்கள்
  • அதை உங்கள் சுயவிவரத்தில் சேர்த்த பிறகு உங்கள் ஷெல்லை மறுதொடக்கம் செய்யுங்கள்

"கட்டளை கிடைக்கவில்லை: manda"

  • பயன்பாடு உருவாக்கப்பட்டுள்ளது என்பதை உறுதிசெய்யுங்கள் (pnpm build)
  • மூல நிறுவலுக்கு திட்ட அடைவை உங்கள் PATH இல் சேர்க்கவும்
  • அல்லது npm வழியாக நிறுவப்பட்டிருந்தால் npx manda பயன்படுத்தவும்

கிட் புஷ் தோல்வியடைகிறது

  • உங்கள் கிட் தொலை கட்டமைப்பைச் சரிபார்க்கவும்
  • களஞ்சியத்தில் புஷ் அணுகல் உள்ளது என்பதை உறுதிசெய்யுங்கள்
  • REMOTE சூழல் மாறி சரியானது என்பதை சரிபார்க்கவும்

உதவி பெறுதல்

  • GitHub இல் இருக்கும் சிக்கல்களைச் சரிபார்க்கவும்
  • உங்கள் சிக்கலின் விவரங்களுடன் புதிய சிக்கலை உருவாக்கவும்
  • உங்கள் OS, ஷெல், மற்றும் தொடர்புடைய கட்டமைப்பைச் சேர்க்கவும்
  • கட்டளை வரி உதவிக்கு manda --help பயன்படுத்தவும்

பதிப்பு வரலாறு

விரிவான பதிப்பு வரலாறுக்கு GitHub Releases பக்கத்தைப் பார்க்கவும்.

தொடர்புடைய ஆவணங்கள்

  • AGENTS.md - வளர்ச்சி முறை மற்றும் TDD அணுகுமுறை
  • DEVELOPMENT.md - விரிவான வளர்ச்சி அமைப்பு
  • GITHUB_ACTIONS_SETUP.md - CI/CD அமைப்பு வழிகாட்டி
  • INSTALL.md - நிறுவல் சரிசெய்தல்
  • REBUILD.md - மறு உருவாக்க வழிமுறைகள்

About

A CLI tool for personal journaling and task management

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •