Skip to content

Commit aaeabfd

Browse files
author
Marvin Zhang
committed
refactor: rename configuration directory from .lspec to .lean-spec
- Updated all references in documentation and code to reflect the new configuration directory name. - Changed paths for configuration files and templates from `.lspec/config.json` and `.lspec/templates/` to `.lean-spec/config.json` and `.lean-spec/templates/`. - Ensured backward compatibility by updating initialization and template handling processes.
1 parent a550281 commit aaeabfd

File tree

45 files changed

+125
-125
lines changed

Some content is hidden

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

45 files changed

+125
-125
lines changed

.npmignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ src/
55
# Development files
66
coverage/
77
specs/
8-
.lspec/
8+
.lean-spec/
99
examples/
1010
docs/
1111

docs-site/docs/guide/getting-started.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Zero configuration using standard template. Gets you up and running in seconds.
6666
```
6767

6868
This creates:
69-
- `.lspec/config.json` with minimal configuration
69+
- `.lean-spec/config.json` with minimal configuration
7070
- `specs/` directory for your specs
7171
- `AGENTS.md` with AI agent integration guidance (if not present)
7272

@@ -94,7 +94,7 @@ After initialization, your project will have:
9494

9595
```
9696
your-project/
97-
├── .lspec/
97+
├── .lean-spec/
9898
│ ├── config.json # LeanSpec configuration
9999
│ └── templates/ # Custom spec templates (optional)
100100
│ └── spec-template.md
@@ -106,21 +106,21 @@ your-project/
106106
└── ... (your project files)
107107
```
108108

109-
**Note**: Default structure is flat with global numbering (`001-name/`, `002-name/`). For date-based grouping, configure the `structure.pattern` in `.lspec/config.json`.
109+
**Note**: Default structure is flat with global numbering (`001-name/`, `002-name/`). For date-based grouping, configure the `structure.pattern` in `.lean-spec/config.json`.
110110

111111
## Integrating with Existing Projects
112112

113113
If you already have `AGENTS.md`, `.cursorrules`, or other system prompts, `lean-spec init` will detect them and offer three options:
114114

115115
1. **Merge** - Appends LeanSpec guidance to your existing `AGENTS.md` (preserves your content)
116116
2. **Backup** - Saves existing files as `.backup` and creates fresh ones
117-
3. **Skip** - Only adds `.lspec` config and `specs/` directory, keeps your files untouched
117+
3. **Skip** - Only adds `.lean-spec` config and `specs/` directory, keeps your files untouched
118118

119119
This makes it easy to adopt LeanSpec incrementally without disrupting your existing AI agent setup.
120120

121-
## Configuration File
121+
## Configuration
122122

123-
The `.lspec/config.json` file controls LeanSpec behavior:
123+
The `.lean-spec/config.json` file controls LeanSpec behavior:
124124

125125
```json
126126
{

docs-site/docs/guide/usage/advanced-features/custom-fields.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Add project-specific metadata to your specs.
1313

1414
### Defining Custom Fields
1515

16-
Edit `.lspec/config.json`:
16+
Edit `.lean-spec/config.json`:
1717

1818
```json
1919
{
@@ -118,7 +118,7 @@ Available automatically:
118118

119119
### Custom Variables
120120

121-
Define in `.lspec/config.json`:
121+
Define in `.lean-spec/config.json`:
122122

123123
```json
124124
{
@@ -133,7 +133,7 @@ Define in `.lspec/config.json`:
133133

134134
### Using Variables in Templates
135135

136-
Create or edit `.lspec/templates/spec-template.md`:
136+
Create or edit `.lean-spec/templates/spec-template.md`:
137137

138138
```markdown
139139
---

docs-site/docs/guide/usage/advanced-features/frontmatter.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ This is automatically added when you set `status: complete`.
105105

106106
## Custom Fields
107107

108-
You can define custom fields in `.lspec/config.json`:
108+
You can define custom fields in `.lean-spec/config.json`:
109109

110110
```json
111111
{

docs-site/docs/guide/usage/advanced-features/templates.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -132,14 +132,14 @@ lean-spec init
132132

133133
## Custom Templates
134134

135-
You can create your own templates in `.lspec/templates/`.
135+
You can create your own templates in `.lean-spec/templates/`.
136136

137137
### Creating a Custom Template
138138

139139
1. Create template file:
140140
```bash
141-
mkdir -p .lspec/templates
142-
touch .lspec/templates/my-template.md
141+
mkdir -p .lean-spec/templates
142+
touch .lean-spec/templates/my-template.md
143143
```
144144

145145
2. Edit template with placeholders:
@@ -159,7 +159,7 @@ created: {date}
159159
[Your custom sections...]
160160
```
161161

162-
3. Configure in `.lspec/config.json`:
162+
3. Configure in `.lean-spec/config.json`:
163163
```json
164164
{
165165
"template": "my-template.md"
@@ -221,7 +221,7 @@ Customize sections to fit your needs.
221221

222222
To change templates mid-project:
223223

224-
1. Update `.lspec/config.json`:
224+
1. Update `.lean-spec/config.json`:
225225
```json
226226
{
227227
"template": "new-template.md"
@@ -247,7 +247,7 @@ Not every spec needs every section. Use what adds value, skip what doesn't.
247247
:::
248248

249249
:::tip Share Templates
250-
Export your `.lspec/templates/` directory to share with other teams or projects.
250+
Export your `.lean-spec/templates/` directory to share with other teams or projects.
251251
:::
252252

253253
---

docs-site/docs/guide/usage/advanced-features/variables.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Repository name from git remote URL.
9797

9898
## Custom Variables
9999

100-
Define your own variables in `.lspec/config.json`:
100+
Define your own variables in `.lean-spec/config.json`:
101101

102102
```json
103103
{
@@ -120,7 +120,7 @@ Use in templates:
120120

121121
### 1. Create or Edit Template
122122

123-
`.lspec/templates/spec-template.md`:
123+
`.lean-spec/templates/spec-template.md`:
124124

125125
```markdown
126126
---
@@ -145,7 +145,7 @@ Questions? Reach out to \{default_reviewer\} or \{git_email\}
145145

146146
### 2. Configure Variables
147147

148-
`.lspec/config.json`:
148+
`.lean-spec/config.json`:
149149

150150
```json
151151
{
@@ -276,7 +276,7 @@ Add comments in config explaining what each variable is for.
276276
2. Typo in variable name
277277
3. Config file not saved
278278

279-
**Solution:** Check `.lspec/config.json` has the variable defined.
279+
**Solution:** Check `.lean-spec/config.json` has the variable defined.
280280

281281
### Wrong Value
282282

docs-site/docs/reference/cli.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ lean-spec init
3030
3. Configure initial settings
3131

3232
**What it creates:**
33-
- `.lspec/config.json` - Configuration file
34-
- `.lspec/templates/` - Custom templates directory
33+
- `.lean-spec/config.json` - Configuration file
34+
- `.lean-spec/templates/` - Custom templates directory
3535
- `specs/` - Specs directory
3636
- `AGENTS.md` - AI agent integration guidance (if not present)
3737

@@ -86,7 +86,7 @@ lean-spec create user-auth --field epic=PROJ-123 --field sprint=42
8686
- Assigns sequential number (NNN) globally across all specs
8787
- Sets frontmatter with metadata
8888

89-
**Note**: Default is flat structure. For date-based grouping, configure `pattern: "custom"` in `.lspec/config.json`.
89+
**Note**: Default is flat structure. For date-based grouping, configure `pattern: "custom"` in `.lean-spec/config.json`.
9090

9191
---
9292

@@ -551,7 +551,7 @@ LeanSpec will find the spec regardless of which format you use.
551551

552552
## Configuration
553553

554-
Commands respect settings in `.lspec/config.json`:
554+
Commands respect settings in `.lean-spec/config.json`:
555555

556556
```json
557557
{

docs-site/docs/reference/config.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ sidebar_position: 2
55
---
66
# Configuration
77

8-
Complete reference for `.lspec/config.json`.
8+
Complete reference for `.lean-spec/config.json`.
99

1010
## Configuration File
1111

12-
LeanSpec configuration is stored in `.lspec/config.json` in your project root.
12+
LeanSpec configuration is stored in `.lean-spec/config.json` in your project root.
1313

1414
## Default Configuration
1515

@@ -43,7 +43,7 @@ Primary template file to use for new specs.
4343
**Type:** `string`
4444
**Default:** `"spec-template.md"`
4545

46-
Path to the template file within `.lspec/templates/` directory.
46+
Path to the template file within `.lean-spec/templates/` directory.
4747

4848
```json
4949
{
@@ -421,7 +421,7 @@ LeanSpec validates configuration on load:
421421

422422
- Required structure fields must be valid
423423
- Custom field types must be valid (`string`, `number`, `boolean`, `array`)
424-
- Template files must exist in `.lspec/templates/`
424+
- Template files must exist in `.lean-spec/templates/`
425425
- Spec directory is created if missing
426426

427427
Invalid configuration will show an error with details.
@@ -430,7 +430,7 @@ Invalid configuration will show an error with details.
430430

431431
When updating configuration:
432432

433-
1. Edit `.lspec/config.json`
433+
1. Edit `.lean-spec/config.json`
434434
2. New specs will use new configuration
435435
3. Existing specs are not automatically updated
436436
4. Manually update existing specs if needed

docs-site/docs/reference/frontmatter.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Auto-added when status is set to `complete`.
9797

9898
## Custom Fields
9999

100-
Define in `.lspec/config.json`:
100+
Define in `.lean-spec/config.json`:
101101

102102
```json
103103
{

docs-site/docs/reference/mcp-server.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ Show me what would be backfilled without making changes
246246

247247
### Server won't start
248248

249-
- Verify the `cwd` path in your configuration points to a valid LeanSpec project (has `.lspec/config.json`)
249+
- Verify the `cwd` path in your configuration points to a valid LeanSpec project (has `.lean-spec/config.json`)
250250
- If using `npx`, ensure you have internet access for the first run
251251
- If using global installation, check that `lean-spec` is in your PATH
252252
- Try running `npx -y lean-spec mcp` or `lean-spec mcp` directly from your project directory

0 commit comments

Comments
 (0)