skyltmax_config 0.0.5 → 0.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitignore +1 -0
- data/AGENTS.md +650 -0
- data/CHANGELOG.md +8 -0
- data/Gemfile.lock +1 -1
- data/LICENSE +1 -1
- data/README.md +26 -13
- data/lib/skyltmax_config/version.rb +5 -0
- data/lib/skyltmax_config.rb +4 -0
- data/package.json +19 -6
- data/pnpm-lock.yaml +1237 -888
- data/skyltmax_config.gemspec +4 -1
- metadata +3 -2
- data/.devcontainer/.bootdone +0 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a6a8007ef02d8dc6672b4d770ae1a539df59f4191f7ded5dbebd444f91f53b00
|
|
4
|
+
data.tar.gz: 6ceb88fb0b3b6f1c3f1dcf59b58d0ea237422e8706a4f811537d31c2f63fba20
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a656607ad44b3c0c803fcfdf8ce887d9183acf2fea52e15e6c4ae5da2ededd4323e69bad51362a3ebff3d516aae2025cfe9c01c9a6df60b94f95b4d5a66197a9
|
|
7
|
+
data.tar.gz: 8c4ce36089f6a36666fbae8c139bc0f601d20fb9ca3b0a76f801b98c7ae9db9c5f8b085d606e3d0a42f5565df829a3e406589ff7f08d0196c79bffae262dfb2e
|
data/.gitignore
CHANGED
data/AGENTS.md
ADDED
|
@@ -0,0 +1,650 @@
|
|
|
1
|
+
# AI Agent Guide for @signmax/config
|
|
2
|
+
|
|
3
|
+
This document provides comprehensive guidance for AI coding agents working with the `@signmax/config` package.
|
|
4
|
+
|
|
5
|
+
## Table of Contents
|
|
6
|
+
|
|
7
|
+
1. [Conventions](#conventions)
|
|
8
|
+
2. [Package Overview](#package-overview)
|
|
9
|
+
3. [Getting Started](#getting-started)
|
|
10
|
+
4. [Development](#development)
|
|
11
|
+
5. [Testing](#testing)
|
|
12
|
+
6. [Configuration](#configuration)
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Conventions
|
|
17
|
+
|
|
18
|
+
- Max line length before wrapping is 120 chars.
|
|
19
|
+
- Don't be overly verbose, prefer brevity.
|
|
20
|
+
- Always put strong emphasis on idiomatic TypeScript solutions.
|
|
21
|
+
- Always uphold the configured linter settings - eslint, prettier.
|
|
22
|
+
- Avoid tautologic comments - prefer saying nothing over stating the obvious.
|
|
23
|
+
- Linear git history is required. Avoid cherry-picking etc.
|
|
24
|
+
|
|
25
|
+
### Commit message
|
|
26
|
+
|
|
27
|
+
Commit messages should follow a specific format:
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
<type>(<scope>): <subject>
|
|
31
|
+
<BLANK LINE>
|
|
32
|
+
<body>
|
|
33
|
+
<BLANK LINE>
|
|
34
|
+
<footer>
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
For example:
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
fix(middleware): Fix device key cookie initialization
|
|
41
|
+
|
|
42
|
+
The device key middleware was not setting the cookie header correctly.
|
|
43
|
+
|
|
44
|
+
Fixes #42
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Or:
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
feat(server): Add configurable middleware options
|
|
51
|
+
|
|
52
|
+
Allow users to disable default middleware via ServeAppOptions.
|
|
53
|
+
|
|
54
|
+
Breaking change: Default middleware is now optional
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## Package Overview
|
|
60
|
+
|
|
61
|
+
### Structure
|
|
62
|
+
|
|
63
|
+
This is a **dual-language configuration package** providing ESLint, Prettier, and TypeScript configs for
|
|
64
|
+
JavaScript/TypeScript projects, and Rubocop configs for Ruby projects:
|
|
65
|
+
|
|
66
|
+
```
|
|
67
|
+
@signmax/config/
|
|
68
|
+
├── lib/
|
|
69
|
+
│ └── skyltmax_config.rb # Ruby gem entry point
|
|
70
|
+
├── eslint.js # ESLint configuration
|
|
71
|
+
├── eslint.config.js # Example ESLint usage
|
|
72
|
+
├── prettier.js # Prettier configuration
|
|
73
|
+
├── typescript.json # TypeScript configuration
|
|
74
|
+
├── reset.d.ts # TypeScript reset types
|
|
75
|
+
├── rubocop.yml # Rubocop base config
|
|
76
|
+
├── rubocop.rails.yml # Rubocop Rails config
|
|
77
|
+
├── index.js # Package entry point
|
|
78
|
+
├── package.json # npm package manifest
|
|
79
|
+
├── skyltmax_config.gemspec # Ruby gem specification
|
|
80
|
+
├── tsconfig.json # TypeScript config
|
|
81
|
+
├── Gemfile # Ruby dependencies
|
|
82
|
+
├── Rakefile # Ruby tasks
|
|
83
|
+
└── README.md
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### Technology Stack
|
|
87
|
+
|
|
88
|
+
**JavaScript/TypeScript:**
|
|
89
|
+
|
|
90
|
+
- ESLint 9+ (flat config)
|
|
91
|
+
- Prettier 3+
|
|
92
|
+
- TypeScript 5+
|
|
93
|
+
- React support
|
|
94
|
+
- Vitest support
|
|
95
|
+
- Testing Library support
|
|
96
|
+
|
|
97
|
+
**Ruby:**
|
|
98
|
+
|
|
99
|
+
- Rubocop (>= 1.81.0)
|
|
100
|
+
- Rubocop Performance
|
|
101
|
+
- Rubocop Rails
|
|
102
|
+
|
|
103
|
+
**Key Dependencies:**
|
|
104
|
+
|
|
105
|
+
- `@typescript-eslint/eslint-plugin` & `@typescript-eslint/parser`
|
|
106
|
+
- `eslint-plugin-react`, `eslint-plugin-react-hooks`
|
|
107
|
+
- `eslint-plugin-jsx-a11y`
|
|
108
|
+
- `eslint-plugin-import-x`
|
|
109
|
+
- `@vitest/eslint-plugin`
|
|
110
|
+
- `eslint-plugin-testing-library`, `eslint-plugin-jest-dom`
|
|
111
|
+
- `prettier-plugin-tailwindcss`
|
|
112
|
+
- `@total-typescript/ts-reset`
|
|
113
|
+
|
|
114
|
+
**System Requirements:**
|
|
115
|
+
|
|
116
|
+
- Node.js >= 18.0.0
|
|
117
|
+
- Ruby >= 3.4 (for Rubocop configs)
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## Getting Started
|
|
122
|
+
|
|
123
|
+
### Installation
|
|
124
|
+
|
|
125
|
+
**For JavaScript/TypeScript projects:**
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
npm install --save-dev @signmax/config
|
|
129
|
+
# or
|
|
130
|
+
pnpm add -D @signmax/config
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
**That's it!** All required tools (ESLint, Prettier, TypeScript, and all plugins) are bundled as dependencies. No need
|
|
134
|
+
to install peer dependencies separately.
|
|
135
|
+
|
|
136
|
+
**For Ruby projects:**
|
|
137
|
+
|
|
138
|
+
```ruby
|
|
139
|
+
# Gemfile
|
|
140
|
+
gem "skyltmax_config"
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Basic Usage
|
|
144
|
+
|
|
145
|
+
**ESLint:**
|
|
146
|
+
|
|
147
|
+
```javascript
|
|
148
|
+
// eslint.config.js
|
|
149
|
+
import { config as defaultConfig } from "@signmax/config/eslint"
|
|
150
|
+
|
|
151
|
+
/** @type {import("eslint").Linter.Config[]} */
|
|
152
|
+
export default [...defaultConfig]
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
**Prettier:**
|
|
156
|
+
|
|
157
|
+
```json
|
|
158
|
+
// package.json
|
|
159
|
+
{
|
|
160
|
+
"prettier": "@signmax/config/prettier"
|
|
161
|
+
}
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
**TypeScript:**
|
|
165
|
+
|
|
166
|
+
```json
|
|
167
|
+
// tsconfig.json
|
|
168
|
+
{
|
|
169
|
+
"extends": ["@signmax/config/typescript"],
|
|
170
|
+
"include": ["**/*.ts", "**/*.tsx"],
|
|
171
|
+
"compilerOptions": {
|
|
172
|
+
"paths": {
|
|
173
|
+
"#app/*": ["./app/*"]
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
**Rubocop:**
|
|
180
|
+
|
|
181
|
+
```yaml
|
|
182
|
+
# .rubocop.yml
|
|
183
|
+
inherit_gem:
|
|
184
|
+
skyltmax_config:
|
|
185
|
+
- rubocop.yml
|
|
186
|
+
- rubocop.rails.yml
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### Development Setup
|
|
190
|
+
|
|
191
|
+
```bash
|
|
192
|
+
# Install dependencies
|
|
193
|
+
pnpm install
|
|
194
|
+
|
|
195
|
+
# Run validation
|
|
196
|
+
pnpm validate
|
|
197
|
+
|
|
198
|
+
# Run individual checks
|
|
199
|
+
pnpm format # Format with Prettier
|
|
200
|
+
pnpm lint # Lint with ESLint
|
|
201
|
+
pnpm typecheck # Type check with TypeScript
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
---
|
|
205
|
+
|
|
206
|
+
## Development
|
|
207
|
+
|
|
208
|
+
### File Structure
|
|
209
|
+
|
|
210
|
+
**JavaScript/TypeScript Files:**
|
|
211
|
+
|
|
212
|
+
- `eslint.js` - ESLint configuration export with all rules and plugins
|
|
213
|
+
- `prettier.js` - Prettier configuration with formatting options
|
|
214
|
+
- `typescript.json` - TypeScript compiler configuration
|
|
215
|
+
- `reset.d.ts` - TypeScript type reset declarations
|
|
216
|
+
- `index.js` - Package entry point
|
|
217
|
+
- `eslint.config.js` - Example ESLint configuration usage
|
|
218
|
+
|
|
219
|
+
**Ruby Files:**
|
|
220
|
+
|
|
221
|
+
- `lib/skyltmax_config.rb` - Ruby gem entry point
|
|
222
|
+
- `rubocop.yml` - Base Rubocop configuration
|
|
223
|
+
- `rubocop.rails.yml` - Rails-specific Rubocop rules
|
|
224
|
+
- `skyltmax_config.gemspec` - Gem specification
|
|
225
|
+
- `Gemfile` - Ruby dependencies
|
|
226
|
+
- `Rakefile` - Ruby build tasks
|
|
227
|
+
|
|
228
|
+
### ESLint Configuration (`eslint.js`)
|
|
229
|
+
|
|
230
|
+
The ESLint configuration uses the flat config format (ESLint 9+) and exports an array of configuration objects:
|
|
231
|
+
|
|
232
|
+
```javascript
|
|
233
|
+
export const config = [
|
|
234
|
+
// Ignore patterns
|
|
235
|
+
{ ignores: ["**/node_modules/**", "**/build/**", ...] },
|
|
236
|
+
|
|
237
|
+
// Base configs
|
|
238
|
+
...(await import("@eslint/js")).default.configs.recommended,
|
|
239
|
+
...(await import("eslint-plugin-prettier/recommended")).default,
|
|
240
|
+
|
|
241
|
+
// Import rules for all files
|
|
242
|
+
{ plugins: { import: ... }, rules: { "import/order": ... } },
|
|
243
|
+
|
|
244
|
+
// React/JSX specific rules
|
|
245
|
+
{ files: ["**/*.tsx", "**/*.jsx"], plugins: { react: ... } },
|
|
246
|
+
|
|
247
|
+
// TypeScript specific rules
|
|
248
|
+
...(await import("typescript-eslint")).default.config({ files: ["**/*.ts?(x)"] }),
|
|
249
|
+
|
|
250
|
+
// Test file rules (Vitest, Testing Library, Jest DOM)
|
|
251
|
+
{ files: testFiles, plugins: { vitest: ... } },
|
|
252
|
+
]
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
**Key Features:**
|
|
256
|
+
|
|
257
|
+
- React and React Hooks support
|
|
258
|
+
- JSX accessibility rules
|
|
259
|
+
- TypeScript type-aware linting
|
|
260
|
+
- Import ordering and deduplication
|
|
261
|
+
- Vitest test file support
|
|
262
|
+
- Testing Library rules
|
|
263
|
+
- Jest DOM assertions
|
|
264
|
+
|
|
265
|
+
**Common Rules:**
|
|
266
|
+
|
|
267
|
+
- `import/order` - Alphabetized, grouped imports
|
|
268
|
+
- `import/no-duplicates` - Prevent duplicate imports with inline types
|
|
269
|
+
- `@typescript-eslint/consistent-type-imports` - Prefer `type` imports
|
|
270
|
+
- `react/jsx-no-leaked-render` - Prevent leaked renders in JSX
|
|
271
|
+
- `no-warning-comments` - Disallow FIXME comments
|
|
272
|
+
|
|
273
|
+
### Prettier Configuration (`prettier.js`)
|
|
274
|
+
|
|
275
|
+
The Prettier config emphasizes readability and consistency:
|
|
276
|
+
|
|
277
|
+
```javascript
|
|
278
|
+
export const config = {
|
|
279
|
+
printWidth: 120, // Max line length
|
|
280
|
+
semi: false, // No semicolons
|
|
281
|
+
singleQuote: false, // Double quotes
|
|
282
|
+
trailingComma: "es5", // Trailing commas where valid in ES5
|
|
283
|
+
arrowParens: "avoid", // Omit parens when possible
|
|
284
|
+
// ... other options
|
|
285
|
+
plugins: ["prettier-plugin-tailwindcss"],
|
|
286
|
+
}
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
**Tailwind Support:**
|
|
290
|
+
|
|
291
|
+
- Automatic class sorting via `prettier-plugin-tailwindcss`
|
|
292
|
+
- Configurable class attributes and functions
|
|
293
|
+
- Default: `className`, `class`, and `clsx`/`cn` functions
|
|
294
|
+
|
|
295
|
+
### TypeScript Configuration (`typescript.json`)
|
|
296
|
+
|
|
297
|
+
Base TypeScript configuration for strict type checking:
|
|
298
|
+
|
|
299
|
+
```json
|
|
300
|
+
{
|
|
301
|
+
"compilerOptions": {
|
|
302
|
+
"strict": true,
|
|
303
|
+
"esModuleInterop": true,
|
|
304
|
+
"skipLibCheck": true,
|
|
305
|
+
"moduleResolution": "Bundler",
|
|
306
|
+
"resolveJsonModule": true,
|
|
307
|
+
"isolatedModules": true,
|
|
308
|
+
"jsx": "react-jsx"
|
|
309
|
+
// ... other strict options
|
|
310
|
+
}
|
|
311
|
+
}
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
**TypeScript Reset (`reset.d.ts`):**
|
|
315
|
+
|
|
316
|
+
- Imports `@total-typescript/ts-reset`
|
|
317
|
+
- Provides better type definitions for common JS APIs
|
|
318
|
+
- Fixes issues with `Array.includes`, `JSON.parse`, `fetch`, etc.
|
|
319
|
+
|
|
320
|
+
### Rubocop Configuration
|
|
321
|
+
|
|
322
|
+
**Base Config (`rubocop.yml`):**
|
|
323
|
+
|
|
324
|
+
- Strict Ruby style enforcement
|
|
325
|
+
- Performance optimizations
|
|
326
|
+
- Disabled cops that conflict with modern Ruby style
|
|
327
|
+
|
|
328
|
+
**Rails Config (`rubocop.rails.yml`):**
|
|
329
|
+
|
|
330
|
+
- Rails-specific linting rules
|
|
331
|
+
- Database conventions
|
|
332
|
+
- ActiveRecord best practices
|
|
333
|
+
|
|
334
|
+
### TypeScript Conventions
|
|
335
|
+
|
|
336
|
+
**Exports:**
|
|
337
|
+
|
|
338
|
+
- Use named exports for configurations
|
|
339
|
+
- Provide default export for backward compatibility
|
|
340
|
+
- Example: `export const config = {...}; export default config;`
|
|
341
|
+
|
|
342
|
+
**Imports:**
|
|
343
|
+
|
|
344
|
+
- Use dynamic imports for ESLint plugins (required for flat config)
|
|
345
|
+
- Example: `(await import("eslint-plugin-react")).default`
|
|
346
|
+
|
|
347
|
+
**Code Style:**
|
|
348
|
+
|
|
349
|
+
- Follow configured Prettier settings
|
|
350
|
+
- Max line length: 120 characters
|
|
351
|
+
- No semicolons
|
|
352
|
+
- Double quotes for strings
|
|
353
|
+
- Trailing commas in ES5 contexts
|
|
354
|
+
|
|
355
|
+
### Patterns
|
|
356
|
+
|
|
357
|
+
**Configuration Pattern:** All configuration files follow a similar pattern:
|
|
358
|
+
|
|
359
|
+
1. Define constants (severity levels, file patterns)
|
|
360
|
+
2. Export configuration object/array
|
|
361
|
+
3. Provide default export for compatibility
|
|
362
|
+
4. Add JSDoc type annotations for IDE support
|
|
363
|
+
|
|
364
|
+
Example:
|
|
365
|
+
|
|
366
|
+
```javascript
|
|
367
|
+
/** @type {import("prettier").Options} */
|
|
368
|
+
export const config = {
|
|
369
|
+
/* ... */
|
|
370
|
+
}
|
|
371
|
+
export default config
|
|
372
|
+
```
|
|
373
|
+
|
|
374
|
+
### Making Changes
|
|
375
|
+
|
|
376
|
+
When updating configurations:
|
|
377
|
+
|
|
378
|
+
1. **ESLint:** Update `eslint.js` with new rules/plugins
|
|
379
|
+
2. **Prettier:** Update `prettier.js` formatting options
|
|
380
|
+
3. **TypeScript:** Update `typescript.json` compiler options
|
|
381
|
+
4. **Rubocop:** Update `rubocop.yml` or `rubocop.rails.yml`
|
|
382
|
+
5. **Version:** Bump version in both `package.json` AND `skyltmax_config.gemspec`
|
|
383
|
+
6. **Changelog:** Document changes in `CHANGELOG.md`
|
|
384
|
+
7. **Test:** Run `pnpm validate` to ensure configs work
|
|
385
|
+
|
|
386
|
+
---
|
|
387
|
+
|
|
388
|
+
## Testing
|
|
389
|
+
|
|
390
|
+
This package **does not include automated tests** as it primarily provides configuration files. Testing is done by:
|
|
391
|
+
|
|
392
|
+
1. **Using the configs in real projects** - The configurations are dogfooded
|
|
393
|
+
2. **Manual validation** - `pnpm validate` checks formatting, linting, and type-checking
|
|
394
|
+
3. **CI/CD validation** - GitHub Actions verify the package structure
|
|
395
|
+
|
|
396
|
+
### Validation Process
|
|
397
|
+
|
|
398
|
+
**Run all checks:**
|
|
399
|
+
|
|
400
|
+
```bash
|
|
401
|
+
pnpm validate
|
|
402
|
+
```
|
|
403
|
+
|
|
404
|
+
This runs:
|
|
405
|
+
|
|
406
|
+
- `pnpm format` - Prettier formatting
|
|
407
|
+
- `pnpm lint` - ESLint validation
|
|
408
|
+
- `pnpm typecheck` - TypeScript compilation
|
|
409
|
+
|
|
410
|
+
**Individual checks:**
|
|
411
|
+
|
|
412
|
+
```bash
|
|
413
|
+
pnpm format # Auto-format all files
|
|
414
|
+
pnpm lint # Check ESLint rules
|
|
415
|
+
pnpm typecheck # Verify TypeScript types
|
|
416
|
+
```
|
|
417
|
+
|
|
418
|
+
### Testing Configuration Changes
|
|
419
|
+
|
|
420
|
+
When modifying configurations:
|
|
421
|
+
|
|
422
|
+
1. **Test in a real project:**
|
|
423
|
+
- Link the package locally: `pnpm link /path/to/config`
|
|
424
|
+
- Verify ESLint runs without errors
|
|
425
|
+
- Check Prettier formats correctly
|
|
426
|
+
- Ensure TypeScript compiles
|
|
427
|
+
|
|
428
|
+
2. **Check backward compatibility:**
|
|
429
|
+
- Existing projects should not break
|
|
430
|
+
- New rules should be additive or opt-in
|
|
431
|
+
- Document breaking changes in CHANGELOG
|
|
432
|
+
|
|
433
|
+
3. **Validate exports:**
|
|
434
|
+
- Ensure all exports work: `import { config } from "@signmax/config/eslint"`
|
|
435
|
+
- Check both named and default exports
|
|
436
|
+
- Verify TypeScript definitions are correct
|
|
437
|
+
|
|
438
|
+
### Rubocop Testing
|
|
439
|
+
|
|
440
|
+
For Ruby configurations:
|
|
441
|
+
|
|
442
|
+
```bash
|
|
443
|
+
# Test Rubocop configs locally
|
|
444
|
+
bundle exec rubocop
|
|
445
|
+
|
|
446
|
+
# Test with specific config
|
|
447
|
+
bundle exec rubocop --config rubocop.yml
|
|
448
|
+
bundle exec rubocop --config rubocop.rails.yml
|
|
449
|
+
```
|
|
450
|
+
|
|
451
|
+
### Continuous Integration
|
|
452
|
+
|
|
453
|
+
The package uses GitHub Actions for CI/CD with two workflows:
|
|
454
|
+
|
|
455
|
+
**CI Workflow (`.github/workflows/ci.yml`)** - Runs on PRs and pushes to main:
|
|
456
|
+
|
|
457
|
+
1. **Validate JavaScript/TypeScript configs:**
|
|
458
|
+
- Runs `pnpm validate` (dogfooding - lints/formats/typechecks itself)
|
|
459
|
+
- Ensures ESLint, Prettier, and TypeScript configs work correctly
|
|
460
|
+
|
|
461
|
+
2. **Validate Ruby configs:**
|
|
462
|
+
- Runs `bundle exec rubocop` (dogfooding - validates Rubocop configs)
|
|
463
|
+
|
|
464
|
+
3. **Version sync check:**
|
|
465
|
+
- Verifies `package.json` and `lib/skyltmax_config/version.rb` versions match
|
|
466
|
+
- Prevents version drift between npm and gem
|
|
467
|
+
|
|
468
|
+
4. **Package installation test:**
|
|
469
|
+
- Packs the package with `pnpm pack`
|
|
470
|
+
- Installs in a test project
|
|
471
|
+
- Verifies all exports work (ESLint, Prettier, TypeScript, reset.d.ts)
|
|
472
|
+
|
|
473
|
+
**Release Workflow (`.github/workflows/release.yml`)** - Publishes on GitHub Release:
|
|
474
|
+
|
|
475
|
+
1. Verifies tag version matches both package.json and version.rb
|
|
476
|
+
2. Publishes npm package with provenance (trusted publishing)
|
|
477
|
+
3. Publishes RubyGems gem (trusted publishing)
|
|
478
|
+
|
|
479
|
+
**Key CI principle:** Dogfooding is the primary validation strategy. The package validates itself using its own
|
|
480
|
+
configurations, which ensures the configs are functional and catches issues early.
|
|
481
|
+
|
|
482
|
+
---
|
|
483
|
+
|
|
484
|
+
## Configuration
|
|
485
|
+
|
|
486
|
+
### Package Structure
|
|
487
|
+
|
|
488
|
+
This package uses a dual-publishing approach:
|
|
489
|
+
|
|
490
|
+
**NPM Package (`@signmax/config`):**
|
|
491
|
+
|
|
492
|
+
- Main entry: `index.js`
|
|
493
|
+
- Exports: `./prettier`, `./typescript`, `./eslint`, `./reset.d.ts`
|
|
494
|
+
- Version must match gemspec version
|
|
495
|
+
|
|
496
|
+
**Ruby Gem (`skyltmax_config`):**
|
|
497
|
+
|
|
498
|
+
- Entry point: `lib/skyltmax_config.rb`
|
|
499
|
+
- Provides Rubocop configurations
|
|
500
|
+
- Version must match package.json version
|
|
501
|
+
|
|
502
|
+
### Dependency Management
|
|
503
|
+
|
|
504
|
+
This package bundles all required tooling as direct dependencies, making it the **single source of truth** for versions:
|
|
505
|
+
|
|
506
|
+
**Dependencies (all tooling bundled):**
|
|
507
|
+
|
|
508
|
+
- **ESLint & Core:** `eslint`, `@eslint/js`, `typescript-eslint`
|
|
509
|
+
- **TypeScript ESLint:** `@typescript-eslint/eslint-plugin`, `@typescript-eslint/parser`, `@typescript-eslint/utils`
|
|
510
|
+
- **Prettier:** `prettier`, `eslint-config-prettier`, `eslint-plugin-prettier`, `prettier-plugin-tailwindcss`
|
|
511
|
+
- **TypeScript:** `typescript`, `@total-typescript/ts-reset`, `tslib`
|
|
512
|
+
- **Plugins:** `eslint-plugin-import-x`, `eslint-plugin-react`, `eslint-plugin-react-hooks`, `eslint-plugin-jsx-a11y`
|
|
513
|
+
- **Testing:** `@vitest/eslint-plugin`, `eslint-plugin-testing-library`, `eslint-plugin-jest-dom`
|
|
514
|
+
- **Utilities:** `globals`
|
|
515
|
+
|
|
516
|
+
**Why this approach?**
|
|
517
|
+
|
|
518
|
+
- ✅ **Version control:** Consuming projects get consistent, tested versions
|
|
519
|
+
- ✅ **Simplified setup:** Single `npm install @signmax/config` gets everything
|
|
520
|
+
- ✅ **No version conflicts:** This package manages compatibility between tools
|
|
521
|
+
- ✅ **Updates centralized:** Bump versions here, all projects benefit
|
|
522
|
+
|
|
523
|
+
**DevDependencies (development only):**
|
|
524
|
+
|
|
525
|
+
- `@types/react` - Type definitions for development
|
|
526
|
+
- `npm-run-all` - Script runner
|
|
527
|
+
- `react` - For testing React-related rules
|
|
528
|
+
|
|
529
|
+
**Files Included in Published Package:**
|
|
530
|
+
|
|
531
|
+
The `files` field specifies what gets published to npm:
|
|
532
|
+
|
|
533
|
+
- `*.js`, `*.json`, `*.d.ts`, `*.yml` - Configuration files
|
|
534
|
+
- `lib/**` - Ruby gem files
|
|
535
|
+
- `README.md`, `LICENSE` - Documentation
|
|
536
|
+
|
|
537
|
+
### Version Management
|
|
538
|
+
|
|
539
|
+
**Critical:** Versions must be kept in sync across `package.json` and `lib/skyltmax_config/version.rb`.
|
|
540
|
+
|
|
541
|
+
The gemspec automatically reads the version from `lib/skyltmax_config/version.rb`, so you only need to update two files:
|
|
542
|
+
|
|
543
|
+
```json
|
|
544
|
+
// package.json
|
|
545
|
+
{
|
|
546
|
+
"version": "0.0.5"
|
|
547
|
+
}
|
|
548
|
+
```
|
|
549
|
+
|
|
550
|
+
```ruby
|
|
551
|
+
# lib/skyltmax_config/version.rb
|
|
552
|
+
module SkyltmaxConfig
|
|
553
|
+
VERSION = "0.0.5"
|
|
554
|
+
end
|
|
555
|
+
```
|
|
556
|
+
|
|
557
|
+
**Note:** The `skyltmax_config.gemspec` uses `SkyltmaxConfig::VERSION` and does not need manual version updates.
|
|
558
|
+
|
|
559
|
+
### Publishing Process
|
|
560
|
+
|
|
561
|
+
Releases are automated via GitHub Actions when a release is published:
|
|
562
|
+
|
|
563
|
+
1. **Update versions:**
|
|
564
|
+
- `package.json`: `"version": "x.y.z"`
|
|
565
|
+
- `lib/skyltmax_config/version.rb`: `VERSION = "x.y.z"`
|
|
566
|
+
|
|
567
|
+
2. **Update changelog:**
|
|
568
|
+
- Add changes to `CHANGELOG.md`
|
|
569
|
+
|
|
570
|
+
3. **Commit and push:**
|
|
571
|
+
|
|
572
|
+
```bash
|
|
573
|
+
git add package.json lib/skyltmax_config/version.rb CHANGELOG.md
|
|
574
|
+
git commit -m "chore: bump version to x.y.z"
|
|
575
|
+
git push
|
|
576
|
+
```
|
|
577
|
+
|
|
578
|
+
4. **Create release:**
|
|
579
|
+
- Create Git tag: `vX.Y.Z`
|
|
580
|
+
- Create GitHub Release for that tag
|
|
581
|
+
- Or run "Publish release" workflow manually
|
|
582
|
+
|
|
583
|
+
**The workflow:**
|
|
584
|
+
|
|
585
|
+
- Verifies tag version matches both package.json and version.rb
|
|
586
|
+
- Publishes npm package with provenance
|
|
587
|
+
- Builds and pushes Ruby gem to RubyGems
|
|
588
|
+
|
|
589
|
+
### Adding New Configurations
|
|
590
|
+
|
|
591
|
+
When adding new linting rules or formatting options:
|
|
592
|
+
|
|
593
|
+
1. **Add to appropriate file:**
|
|
594
|
+
- ESLint rules → `eslint.js`
|
|
595
|
+
- Prettier options → `prettier.js`
|
|
596
|
+
- TypeScript options → `typescript.json`
|
|
597
|
+
- Rubocop rules → `rubocop.yml` or `rubocop.rails.yml`
|
|
598
|
+
|
|
599
|
+
2. **Document in README.md:**
|
|
600
|
+
- Add usage examples
|
|
601
|
+
- List new features
|
|
602
|
+
- Update configuration sections
|
|
603
|
+
|
|
604
|
+
3. **Update CHANGELOG.md:**
|
|
605
|
+
- Document what changed
|
|
606
|
+
- Note any breaking changes
|
|
607
|
+
- Provide migration guidance if needed
|
|
608
|
+
|
|
609
|
+
4. **Test locally:**
|
|
610
|
+
- Run `pnpm validate`
|
|
611
|
+
- Test in a real project via `pnpm link`
|
|
612
|
+
|
|
613
|
+
5. **Update version:**
|
|
614
|
+
- Bump both `package.json` and `skyltmax_config.gemspec`
|
|
615
|
+
- Follow semantic versioning
|
|
616
|
+
|
|
617
|
+
### Backward Compatibility
|
|
618
|
+
|
|
619
|
+
When making changes:
|
|
620
|
+
|
|
621
|
+
- ✅ Add new optional configuration options
|
|
622
|
+
- ✅ Add new rules as warnings first, then errors in next major
|
|
623
|
+
- ✅ Provide sensible defaults for all options
|
|
624
|
+
- ✅ Support both old and new usage patterns
|
|
625
|
+
- ❌ Don't remove exports without major version bump
|
|
626
|
+
- ❌ Don't change default behavior without documenting
|
|
627
|
+
- ❌ Don't introduce breaking changes in minor/patch versions
|
|
628
|
+
|
|
629
|
+
### Export Structure
|
|
630
|
+
|
|
631
|
+
The package exports are defined in `package.json`:
|
|
632
|
+
|
|
633
|
+
```json
|
|
634
|
+
{
|
|
635
|
+
"exports": {
|
|
636
|
+
".": "./index.js",
|
|
637
|
+
"./prettier": "./prettier.js",
|
|
638
|
+
"./typescript": "./typescript.json",
|
|
639
|
+
"./reset.d.ts": "./reset.d.ts",
|
|
640
|
+
"./eslint": "./eslint.js"
|
|
641
|
+
}
|
|
642
|
+
}
|
|
643
|
+
```
|
|
644
|
+
|
|
645
|
+
All exports must:
|
|
646
|
+
|
|
647
|
+
- Have valid file paths
|
|
648
|
+
- Export both named and default exports (JS files)
|
|
649
|
+
- Include proper JSDoc type annotations
|
|
650
|
+
- Be documented in README.md
|
data/CHANGELOG.md
CHANGED
|
@@ -2,14 +2,22 @@
|
|
|
2
2
|
|
|
3
3
|
### Unreleased
|
|
4
4
|
|
|
5
|
+
### [0.0.6] - 2025-11-05
|
|
6
|
+
|
|
7
|
+
- fix: Add missing eslint-config-prettier dependency.
|
|
8
|
+
|
|
5
9
|
### [0.0.5] - 2025-11-04
|
|
10
|
+
|
|
6
11
|
- Fix rubygems attestation.
|
|
7
12
|
|
|
8
13
|
### [0.0.4] - 2025-11-04
|
|
14
|
+
|
|
9
15
|
- Fix rubygems release.
|
|
10
16
|
|
|
11
17
|
### [0.0.3] - 2025-11-04
|
|
18
|
+
|
|
12
19
|
- Fix rubygems release.
|
|
13
20
|
|
|
14
21
|
### [0.0.2] - 2025-11-04
|
|
22
|
+
|
|
15
23
|
- First public release.
|
data/Gemfile.lock
CHANGED