Skip to content

Commit a6d918c

Browse files
committed
feat(syntax): adopt import syntax for modular file references
Replace markdown links with @path/to/file Import syntax across: - global/CLAUDE.md and project/CLAUDE.md - All SKILL.md files in project/.claude/skills/ and plugin/skills/ Import syntax provides: - More intuitive file references - Up to 5 levels of recursive imports - Support for relative and absolute paths Closes #61
1 parent 0bc906c commit a6d918c

15 files changed

Lines changed: 153 additions & 150 deletions

File tree

README.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Claude Configuration Backup & Deployment System
22

33
<p align="center">
4-
<a href="https://github.com/kcenon/claude-config/releases"><img src="https://img.shields.io/badge/version-1.3.0-blue.svg" alt="Version"></a>
4+
<a href="https://github.com/kcenon/claude-config/releases"><img src="https://img.shields.io/badge/version-1.4.0-blue.svg" alt="Version"></a>
55
<a href="LICENSE"><img src="https://img.shields.io/badge/license-BSD--3--Clause-green.svg" alt="License"></a>
66
<a href="https://github.com/kcenon/claude-config/actions/workflows/validate-skills.yml"><img src="https://github.com/kcenon/claude-config/actions/workflows/validate-skills.yml/badge.svg" alt="CI"></a>
77
</p>
@@ -448,11 +448,12 @@ This configuration includes Claude Code Skills for auto-discovery of guidelines
448448

449449
### Progressive Disclosure Pattern
450450

451-
Skills use the Progressive Disclosure pattern for token efficiency:
451+
Skills use the Progressive Disclosure pattern with Import syntax for token efficiency:
452452

453453
1. **SKILL.md**: Contains only essential information (~50 lines)
454454
2. **reference/**: Symlinks to detailed guideline files
455-
3. **On-Demand loading**: Claude reads reference files only when necessary
455+
3. **Import Syntax**: Use `@path/to/file` for on-demand loading (supports up to 5 levels deep)
456+
4. **On-Demand loading**: Claude reads reference files only when necessary
456457

457458
```
458459
skills/coding-guidelines/
@@ -468,6 +469,24 @@ skills/coding-guidelines/
468469
- Initial load tokens: ~5000 → ~1000 (80% reduction)
469470
- 1-level deep references for reliable loading
470471
- Simplified path maintenance
472+
- Import syntax provides intuitive file references
473+
474+
### Import Syntax
475+
476+
The `@path/to/file` Import syntax (introduced in v1.4.0) provides:
477+
- More intuitive file references than traditional markdown links
478+
- Support for up to 5 levels of recursive Import
479+
- Both relative and absolute path support
480+
- Automatic ignoring within code blocks
481+
482+
**Example:**
483+
```markdown
484+
# CLAUDE.md
485+
## Core Guidelines
486+
@claude-guidelines/environment.md
487+
@claude-guidelines/workflow.md
488+
@claude-guidelines/coding-standards/general.md
489+
```
471490

472491
### Skill Structure
473492

@@ -484,8 +503,8 @@ allowed-tools: Read, Grep, Glob # Optional: restrict tools
484503
- Use case 1
485504
- Use case 2
486505

487-
## Quick Reference
488-
- [Link to guideline](reference/guideline.md)
506+
## Reference Documents (Import Syntax)
507+
@reference/guideline.md
489508
```
490509

491510
</details>
@@ -825,11 +844,18 @@ curl -sSL -H "Authorization: token YOUR_TOKEN" \
825844

826845
## Version
827846

828-
- **Version**: 1.3.0
829-
- **Last Updated**: 2026-01-15
847+
- **Version**: 1.4.0
848+
- **Last Updated**: 2026-01-22
830849

831850
### Changelog
832851

852+
#### v1.4.0 (2026-01-22)
853+
- Adopted Import syntax (`@path/to/file`) for modular references
854+
- Replaced markdown links with Import syntax for better token efficiency
855+
- Supports recursive imports up to 5 levels deep
856+
- Updated all CLAUDE.md files (global and project) to use Import syntax
857+
- Updated all SKILL.md files to use Import syntax for reference documents
858+
833859
#### v1.3.0 (2026-01-15)
834860
- Added `/release` command for automated changelog generation
835861
- Added `/branch-cleanup` command for merged and stale branches

global/CLAUDE.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,15 @@
22

33
This is the global configuration for all Claude Code sessions. These settings apply across all projects unless overridden by project-specific `CLAUDE.md` files.
44

5-
## Configuration Modules
5+
## Configuration Modules (Import Syntax)
66

7-
The configuration is organized into focused modules for better token efficiency:
7+
The configuration is organized into focused modules using `@path/to/file` Import syntax:
88

99
### Core Settings
10-
11-
- **[Token Management](token-management.md)** - Token usage display, cost tracking, and optimization strategies
12-
- **[Conversation Language](conversation-language.md)** - Input/output language preferences and translation policies
13-
- **[Git Identity](git-identity.md)** - User information for git commits
14-
- **[Commit Settings](commit-settings.md)** - Commit and PR attribution policy (no Claude references)
10+
@token-management.md
11+
@conversation-language.md
12+
@git-identity.md
13+
@commit-settings.md
1514

1615
## Priority Rules
1716

@@ -51,6 +50,9 @@ To modify these settings:
5150

5251
## Version History
5352

53+
- **1.3.0** (2026-01-22): Adopted Import syntax (`@path/to/file`) for modular references
54+
- Replaced markdown links with Import syntax
55+
- Supports recursive imports up to 5 levels deep
5456
- **1.2.0** (2026-01-15): CLAUDE.md optimization for official best practices compliance
5557
- Simplified project/CLAUDE.md (212 → ~85 lines)
5658
- Added emphasis expressions for key rules
@@ -62,5 +64,5 @@ To modify these settings:
6264

6365
---
6466

65-
*Last updated: 2026-01-15*
66-
*Version: 1.2.0*
67+
*Last updated: 2026-01-22*
68+
*Version: 1.3.0*

plugin/skills/api-design/SKILL.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,17 @@ description: Provides API design guidelines for REST, GraphQL, versioning, loggi
1313
- Implementing rate limiting or authentication
1414
- Code review for API endpoints
1515

16-
## Quick Reference
16+
## Reference Documents (Import Syntax)
1717

1818
### API Design
19-
20-
- [API Design](reference/api-design.md)
19+
@reference/api-design.md
2120

2221
### Architecture
23-
24-
- [Architecture and Design](reference/architecture.md)
22+
@reference/architecture.md
2523

2624
### Observability
27-
28-
- [Logging Standards](reference/logging.md)
29-
- [Observability](reference/observability.md)
25+
@reference/logging.md
26+
@reference/observability.md
3027

3128
## Core Principles
3229

plugin/skills/coding-guidelines/SKILL.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,19 @@ description: Provides comprehensive coding standards for quality, naming convent
1212
- Bug fixes requiring code changes
1313
- Refactoring tasks
1414

15-
## Quick Reference
15+
## Reference Documents (Import Syntax)
1616

1717
### Core Standards
18-
19-
- [General Coding Standards](reference/general.md)
20-
- [Code Quality](reference/quality.md)
18+
@reference/general.md
19+
@reference/quality.md
2120

2221
### Error & Safety
23-
24-
- [Error Handling](reference/error-handling.md)
25-
- [Memory Management](reference/memory.md)
22+
@reference/error-handling.md
23+
@reference/memory.md
2624

2725
### Performance
28-
29-
- [Concurrency](reference/concurrency.md)
30-
- [Performance](reference/performance.md)
26+
@reference/concurrency.md
27+
@reference/performance.md
3128

3229
## Core Principles
3330

plugin/skills/documentation/SKILL.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,16 @@ description: Provides documentation standards for README, API docs, code comment
1414
- Cleaning up and organizing project files
1515
- Setting up linting and formatting tools
1616

17-
## Quick Reference
17+
## Reference Documents (Import Syntax)
1818

1919
### Documentation Standards
20-
21-
- [Documentation Standards](reference/documentation.md)
20+
@reference/documentation.md
2221

2322
### Language Conventions
24-
25-
- [Code and Documentation Language](reference/communication.md)
23+
@reference/communication.md
2624

2725
### Project Cleanup
28-
29-
- [Cleanup and Finalization](reference/cleanup.md)
26+
@reference/cleanup.md
3027

3128
## Core Principles
3229

plugin/skills/performance-review/SKILL.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,11 @@ Profiling → Identify bottlenecks → Optimize → Verify
4545
- [ ] Cache invalidation policy
4646
- [ ] Cache hit rate monitoring
4747

48-
## Reference
49-
50-
- [Performance Guidelines](reference/performance.md)
51-
- [Memory Management](reference/memory.md)
52-
- [Concurrency](reference/concurrency.md)
53-
- [Monitoring](reference/monitoring.md)
48+
## Reference Documents (Import Syntax)
49+
@reference/performance.md
50+
@reference/memory.md
51+
@reference/concurrency.md
52+
@reference/monitoring.md
5453

5554
## Caution
5655

plugin/skills/project-workflow/SKILL.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,23 @@ description: Provides workflow guidelines for problem-solving, git commits, GitH
1313
- Managing builds and dependencies
1414
- Setting up testing infrastructure
1515

16-
## Quick Reference
16+
## Reference Documents (Import Syntax)
1717

1818
### Workflow
19-
20-
- [Workflow Guidelines](reference/workflow.md)
21-
- [Question Handling](reference/question-handling.md)
22-
- [Problem Solving](reference/workflow-problem-solving.md)
23-
- [Performance Analysis](reference/performance-analysis.md)
19+
@reference/workflow.md
20+
@reference/question-handling.md
21+
@reference/workflow-problem-solving.md
22+
@reference/performance-analysis.md
2423

2524
### GitHub
26-
27-
- [GitHub Issue Guidelines (5W1H)](reference/github-issue-5w1h.md)
28-
- [GitHub PR Guidelines (5W1H)](reference/github-pr-5w1h.md)
29-
- [Git Commit Format](reference/git-commit-format.md)
25+
@reference/github-issue-5w1h.md
26+
@reference/github-pr-5w1h.md
27+
@reference/git-commit-format.md
3028

3129
### Project Management
32-
33-
- [Problem-Solving Principles](reference/problem-solving.md)
34-
- [Build and Dependency Management](reference/build.md)
35-
- [Testing Strategy](reference/testing.md)
30+
@reference/problem-solving.md
31+
@reference/build.md
32+
@reference/testing.md
3633

3734
## Core Principles
3835

plugin/skills/security-audit/SKILL.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,10 @@ allowed-tools: Read, Grep, Glob
3434
- [ ] Permission verification
3535
- [ ] Resource access control
3636

37-
## Reference
38-
39-
- [Security Guidelines](reference/security.md)
40-
- [Error Handling (Security)](reference/error-handling.md)
41-
- [API Security](reference/api-design.md)
37+
## Reference Documents (Import Syntax)
38+
@reference/security.md
39+
@reference/error-handling.md
40+
@reference/api-design.md
4241

4342
## OWASP Top 10 Reference
4443

project/.claude/skills/api-design/SKILL.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,17 @@ model: sonnet
2121
- Implementing rate limiting or authentication
2222
- Code review for API endpoints
2323

24-
## Quick Reference
24+
## Reference Documents (Import Syntax)
2525

2626
### API Design
27-
28-
- [API Design](reference/api-design.md)
27+
@reference/api-design.md
2928

3029
### Architecture
31-
32-
- [Architecture and Design](reference/architecture.md)
30+
@reference/architecture.md
3331

3432
### Observability
35-
36-
- [Logging Standards](reference/logging.md)
37-
- [Observability](reference/observability.md)
33+
@reference/logging.md
34+
@reference/observability.md
3835

3936
## Core Principles
4037

project/.claude/skills/coding-guidelines/SKILL.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,19 @@ model: sonnet
1919
- Bug fixes requiring code changes
2020
- Refactoring tasks
2121

22-
## Quick Reference
22+
## Reference Documents (Import Syntax)
2323

2424
### Core Standards
25-
26-
- [General Coding Standards](reference/general.md)
27-
- [Code Quality](reference/quality.md)
25+
@reference/general.md
26+
@reference/quality.md
2827

2928
### Error & Safety
30-
31-
- [Error Handling](reference/error-handling.md)
32-
- [Memory Management](reference/memory.md)
29+
@reference/error-handling.md
30+
@reference/memory.md
3331

3432
### Performance
35-
36-
- [Concurrency](reference/concurrency.md)
37-
- [Performance](reference/performance.md)
33+
@reference/concurrency.md
34+
@reference/performance.md
3835

3936
## Core Principles
4037

0 commit comments

Comments
 (0)