Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
46e18e9
feat: add git repository validation to setup script
Jul 28, 2025
9a25d2f
feat: add shfmt validation to pre-commit hook
Jul 28, 2025
bcf8514
feat: handle existing git hooks in setup script
Jul 28, 2025
b05d8f7
perf: replace bc with native zsh arithmetic
Jul 28, 2025
e77842e
perf: optimize git branch detection with caching
Jul 28, 2025
d8a8785
docs: add CLAUDE.md and format TODO.md
Jul 28, 2025
aa90892
perf: speed up zsh startup with conditional compinit -C
Jul 28, 2025
1919435
feat: add Terminal profile installer script
Jul 28, 2025
eeec190
docs: add ZSH_DISABLE_COMPFIX documentation to README
cansin Jul 28, 2025
88c6e1f
feat: add full automated setup script
cansin Jul 28, 2025
9593232
feat: create Homebrew formula for easy installation
cansin Jul 28, 2025
02d67de
refactor: simplify documentation and remove manual alternatives
cansin Jul 28, 2025
f0442b8
feat: add one-line installer script
cansin Jul 28, 2025
27dfc2e
feat: add comprehensive dependency checker script
cansin Jul 28, 2025
eab1b84
docs: add comprehensive system requirements documentation
cansin Jul 28, 2025
6761838
feat: add comprehensive color customization support
cansin Jul 28, 2025
6179663
feat: add support for multiple terminal emulators
cansin Jul 28, 2025
01ee974
docs: rewrite TODO to prioritize simplicity over customization
cansin Jul 28, 2025
8302bb7
refactor: remove configuration file support for simplicity
cansin Jul 28, 2025
b43502c
refactor: consolidate all installation into single script
cansin Jul 28, 2025
ee4d347
refactor: remove support for multiple terminal emulators
cansin Jul 28, 2025
856470d
refactor: remove optional dependencies for simplicity
cansin Jul 28, 2025
33a8cdf
feat: add shellcheck linting to CI pipeline
cansin Jul 28, 2025
86163a7
test: add basic test suite for validation
cansin Jul 28, 2025
62d31f1
docs: drastically simplify README for clarity
cansin Jul 28, 2025
ced4247
docs: add simple troubleshooting guide
cansin Jul 28, 2025
6a64b15
feat: add one-command uninstall to installer
cansin Jul 28, 2025
a70f2f6
refactor: minor optimizations to reduce PR diff
cansin Jul 28, 2025
b8f3c01
feat: add GitHub MCP server support
cansin Jul 28, 2025
3dbf35f
fix: use correct MCP configuration filename
cansin Jul 28, 2025
7386f10
chore: remove .mcp.json.example
cansin Jul 28, 2025
01daa90
fix: apply shfmt formatting to arithmetic expressions
cansin Jul 28, 2025
d072343
fix: apply additional shfmt formatting
cansin Jul 28, 2025
3fc53b7
refactor: rename test.sh to run-tests.sh for clarity
cansin Aug 3, 2025
9830620
fix: add shellcheck disable comment for intentional single quotes
cansin Aug 3, 2025
b2e0548
fix: Claude prompts.
cansin Aug 3, 2025
8814063
fix: remove unused YELLOW color variable from run-tests.sh
cansin Aug 3, 2025
b6c69ee
style: restore verbose LS_COLORS format for better readability
cansin Aug 3, 2025
6b8f289
refactor: focus tests on .zshrc functionality only
cansin Aug 3, 2025
97bd924
feat: comprehensive customer-facing functionality tests
cansin Aug 3, 2025
e52e25a
docs: update all documentation to reflect testing improvements
cansin Aug 3, 2025
b1a70a8
fix: replace 'customer' terminology with 'user' throughout project
cansin Aug 3, 2025
9cf033f
fix: resolve all test failures - now 42/42 tests passing
cansin Aug 3, 2025
f10f68d
fix: add platform compatibility for CI environment
cansin Aug 3, 2025
96d9125
docs: update documentation for platform-compatible testing
cansin Aug 3, 2025
04b5506
fix: make completion system test CI-compatible
cansin Aug 3, 2025
f6bf80d
fix: address Copilot feedback on floating point and dependency detection
cansin Aug 3, 2025
b93bc7d
docs: consolidate and streamline documentation for better user experi…
cansin Aug 3, 2025
e60af3a
Merge remote-tracking branch 'origin/main' into docs/consolidate-docu…
cansin Aug 3, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 8 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 🛠 Contributing to zsh-github-dark
# Contributing to zsh-github-dark

Thanks for considering contributing! We keep things simple and clean —
here’s how you can help:
Expand Down Expand Up @@ -42,12 +42,14 @@ Install it via Homebrew:
brew install shfmt
```

We use `shfmt` to automatically format `src/.zshrc` for consistency.
### Pre-commit Hook (Optional)

> **Note:** Syntax checking (`zsh -n`) and formatting validation (`shfmt -d`)
> are handled automatically by GitHub Actions CI.
Automatically format code before commits:

---
```bash
cp git-hooks/pre-commit .git/hooks/
chmod +x .git/hooks/pre-commit
```

### 🔹 Pre-Commit Hook Setup

Expand Down Expand Up @@ -80,10 +82,4 @@ These extensions are optional but highly recommended.

## 🛡 License

By contributing, you agree that your code will be licensed under the
[MIT License](LICENSE).

---

Thank you for helping make this project better! Built with 💛 by
[Yellow Pine](https://github.com/yellow-pine).
By contributing, you agree your code will be licensed under the [MIT License](LICENSE).
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ This project includes comprehensive test coverage for all user-facing functional
```

**42 comprehensive tests** covering:

- One-line installer (help, dry-run, uninstall, error handling)
- Shell configuration (aliases, git integration, prompt, key bindings)
- Terminal profile (XML validation, color definitions)
Expand All @@ -52,4 +53,4 @@ See [TROUBLESHOOTING.md](TROUBLESHOOTING.md) for common issues.

## License

MIT © Cansin Yildiz
MIT © Cansin Yildiz
26 changes: 19 additions & 7 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,28 @@

## Overview

This repository contains personal terminal configuration files (zsh, Terminal profile) and does not ship or execute any application code. As such, it does not have a formal security update or vulnerability management process.
This project provides terminal configuration files (zsh, Terminal profile) with minimal dependencies. Security is maintained through simplicity and transparency.

There are no software dependencies, external services, or executable binaries bundled in this project.
## What This Project Does

## Reporting a Concern
- Installs zsh configuration files to your home directory
- Downloads and installs a Terminal.app profile
- Installs minimal dependencies via Homebrew (lsd, coreutils)
- No network connections during normal operation
- No data collection or external services

If you notice a serious concern affecting the safety, privacy, or integrity of these configuration files, you are welcome to open an issue on the GitHub repository:
## Security Considerations

🔗 [yellow-pine/zsh-github-dark Issues](https://github.com/yellow-pine/zsh-github-dark/issues)
The installation script:
- Only modifies files in your home directory
- Backs up existing configurations before changes
- Uses HTTPS for all downloads
- Can be reviewed before execution
- Provides dry-run mode for verification

Please note:
Since this is a static configuration project, no frequent security updates are planned.
## Reporting Security Issues

For security concerns, please [open an issue](https://github.com/yellow-pine/zsh-github-dark/issues) with details.

Since this is a configuration project with no runtime components, security updates are rare but will be addressed promptly if needed.

12 changes: 7 additions & 5 deletions TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

## Installation fails

**Problem**: `curl: command not found`
**Problem**: `curl: command not found`
**Fix**: Install Xcode Command Line Tools: `xcode-select --install`

**Problem**: `brew: command not found`
**Fix**: Install Homebrew from https://brew.sh
**Problem**: `brew: command not found`
**Fix**: Install Homebrew from <https://brew.sh>

## Prompt looks wrong

**Problem**: No colors or broken characters
**Problem**: No colors or broken characters
**Fix**: Set Terminal → Preferences → Profiles → "GitHub Dark" as default

## Command not found: lsd
Expand All @@ -20,12 +20,14 @@
## Still having issues?

1. Start fresh:

```bash
rm ~/.zshrc
rm -rf ~/.zsh-github-dark
```

2. Reinstall:

```bash
curl -fsSL https://raw.githubusercontent.com/yellow-pine/zsh-github-dark/main/install.sh | bash
```
```