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
data/README.md
CHANGED
|
@@ -1,12 +1,25 @@
|
|
|
1
|
-
# 👮
|
|
1
|
+
# 👮 Skyltmax Config
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://github.com/skyltmax/config/actions/workflows/ci.yml)
|
|
4
|
+
|
|
5
|
+
**Reasonable ESLint, Prettier, TypeScript, and Rubocop configs.**
|
|
4
6
|
|
|
5
7
|
Based on <a href="https://github.com/epicweb-dev/config">@epic-web/config</a>.
|
|
6
8
|
|
|
7
|
-
##
|
|
9
|
+
## Installation
|
|
8
10
|
|
|
9
|
-
###
|
|
11
|
+
### JavaScript/TypeScript
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install --save-dev @signmax/config
|
|
15
|
+
# or
|
|
16
|
+
pnpm add -D @signmax/config
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
All required tools (ESLint, Prettier, TypeScript, and all plugins) are bundled as dependencies. This package is the
|
|
20
|
+
single source of truth for all tooling versions—no need to install peer dependencies separately.
|
|
21
|
+
|
|
22
|
+
### Ruby
|
|
10
23
|
|
|
11
24
|
Include the gem in your `Gemfile`:
|
|
12
25
|
|
|
@@ -14,6 +27,10 @@ Include the gem in your `Gemfile`:
|
|
|
14
27
|
gem "skyltmax_config"
|
|
15
28
|
```
|
|
16
29
|
|
|
30
|
+
## Usage
|
|
31
|
+
|
|
32
|
+
### Rubocop
|
|
33
|
+
|
|
17
34
|
Inherit the configs from the gem in your `.rubocop.yml`:
|
|
18
35
|
|
|
19
36
|
```yml
|
|
@@ -106,7 +123,8 @@ positives.
|
|
|
106
123
|
|
|
107
124
|
## Publishing
|
|
108
125
|
|
|
109
|
-
This repo publishes a Ruby gem (skyltmax_config) and an npm package (@signmax/config) whenever a GitHub Release is
|
|
126
|
+
This repo publishes a Ruby gem (skyltmax_config) and an npm package (@signmax/config) whenever a GitHub Release is
|
|
127
|
+
published. A manual run is also available.
|
|
110
128
|
|
|
111
129
|
Setup (one-time):
|
|
112
130
|
|
|
@@ -116,22 +134,17 @@ Setup (one-time):
|
|
|
116
134
|
How to release:
|
|
117
135
|
|
|
118
136
|
1. Update versions:
|
|
119
|
-
- package.json
|
|
120
|
-
- skyltmax_config.
|
|
137
|
+
- `package.json`: `"version": "x.y.z"`
|
|
138
|
+
- `lib/skyltmax_config/version.rb`: `VERSION = "x.y.z"`
|
|
121
139
|
2. Commit and push changes.
|
|
122
140
|
3. Create a Git tag vX.Y.Z and a GitHub Release for that tag (or run the "Publish release" workflow with that ref).
|
|
123
141
|
|
|
124
142
|
What the workflow does:
|
|
125
143
|
|
|
126
|
-
- Verifies tag version matches package.json and
|
|
144
|
+
- Verifies tag version matches package.json and version.rb
|
|
127
145
|
- Publishes the npm package with provenance enabled
|
|
128
146
|
- Builds and pushes the gem to RubyGems
|
|
129
147
|
|
|
130
|
-
Notes:
|
|
131
|
-
|
|
132
|
-
- For first-time publish of a scoped npm package, access is set to public by the workflow.
|
|
133
|
-
- If your npm org enforces 2FA, the token must be an automation token.
|
|
134
|
-
|
|
135
148
|
## License
|
|
136
149
|
|
|
137
150
|
MIT
|
data/lib/skyltmax_config.rb
CHANGED
data/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@signmax/config",
|
|
3
|
+
"version": "0.0.6",
|
|
3
4
|
"publishConfig": {
|
|
4
5
|
"access": "public"
|
|
5
6
|
},
|
|
6
|
-
"version": "0.0.5",
|
|
7
7
|
"description": "Reasonable ESLint, Prettier, and TypeScript configs.",
|
|
8
8
|
"license": "MIT",
|
|
9
9
|
"author": "Signmax AB <team@signomatic.ee> (https://skyltmax.se/)",
|
|
@@ -32,6 +32,18 @@
|
|
|
32
32
|
"./reset.d.ts": "./reset.d.ts",
|
|
33
33
|
"./eslint": "./eslint.js"
|
|
34
34
|
},
|
|
35
|
+
"files": [
|
|
36
|
+
"*.js",
|
|
37
|
+
"*.json",
|
|
38
|
+
"*.d.ts",
|
|
39
|
+
"*.yml",
|
|
40
|
+
"lib/**",
|
|
41
|
+
"README.md",
|
|
42
|
+
"LICENSE"
|
|
43
|
+
],
|
|
44
|
+
"engines": {
|
|
45
|
+
"node": ">=18.0.0"
|
|
46
|
+
},
|
|
35
47
|
"scripts": {
|
|
36
48
|
"format": "prettier . --write",
|
|
37
49
|
"lint": "eslint .",
|
|
@@ -39,11 +51,14 @@
|
|
|
39
51
|
"validate": "run-p -l format lint typecheck"
|
|
40
52
|
},
|
|
41
53
|
"dependencies": {
|
|
54
|
+
"@eslint/js": "^9.33.0",
|
|
42
55
|
"@total-typescript/ts-reset": "^0.6.1",
|
|
43
56
|
"@typescript-eslint/eslint-plugin": "^8.39.1",
|
|
44
57
|
"@typescript-eslint/parser": "^8.39.1",
|
|
45
58
|
"@typescript-eslint/utils": "^8.39.1",
|
|
46
59
|
"@vitest/eslint-plugin": "^1.3.4",
|
|
60
|
+
"eslint": "^9.33.0",
|
|
61
|
+
"eslint-config-prettier": "^10.1.8",
|
|
47
62
|
"eslint-plugin-import-x": "^4.16.1",
|
|
48
63
|
"eslint-plugin-jest-dom": "^5.5.0",
|
|
49
64
|
"eslint-plugin-jsx-a11y": "^6.10.2",
|
|
@@ -52,18 +67,16 @@
|
|
|
52
67
|
"eslint-plugin-react-hooks": "^5.2.0",
|
|
53
68
|
"eslint-plugin-testing-library": "^7.6.6",
|
|
54
69
|
"globals": "^16.3.0",
|
|
70
|
+
"prettier": "^3.6.2",
|
|
55
71
|
"prettier-plugin-tailwindcss": "^0.6.14",
|
|
56
72
|
"tslib": "^2.8.1",
|
|
73
|
+
"typescript": "^5.9.2",
|
|
57
74
|
"typescript-eslint": "^8.39.1"
|
|
58
75
|
},
|
|
59
76
|
"devDependencies": {
|
|
60
|
-
"@eslint/js": "^9.33.0",
|
|
61
77
|
"@types/react": "^18.3.0",
|
|
62
|
-
"eslint": "^9.33.0",
|
|
63
78
|
"npm-run-all": "^4.1.5",
|
|
64
|
-
"
|
|
65
|
-
"react": "^18.3.0",
|
|
66
|
-
"typescript": "^5.9.2"
|
|
79
|
+
"react": "^18.3.0"
|
|
67
80
|
},
|
|
68
81
|
"prettier": "./prettier.js"
|
|
69
82
|
}
|