skyltmax_config 0.0.4 → 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.
Files changed (14) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/AGENTS.md +650 -0
  4. data/CHANGELOG.md +11 -0
  5. data/Gemfile.lock +1 -1
  6. data/LICENSE +1 -1
  7. data/README.md +26 -13
  8. data/lib/skyltmax_config/version.rb +5 -0
  9. data/lib/skyltmax_config.rb +4 -0
  10. data/package.json +32 -7
  11. data/pnpm-lock.yaml +1237 -888
  12. data/skyltmax_config.gemspec +16 -7
  13. metadata +11 -7
  14. data/.devcontainer/.bootdone +0 -2
data/README.md CHANGED
@@ -1,12 +1,25 @@
1
- # 👮 @skyltmax/config
1
+ # 👮 Skyltmax Config
2
2
 
3
- **Reasonable ESLint, Prettier, TypeScript, and Rubocop configs**
3
+ [![CI](https://github.com/skyltmax/config/actions/workflows/ci.yml/badge.svg)](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
- ## Usage
9
+ ## Installation
8
10
 
9
- ### Rubocop
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 published. A manual run is also available.
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: "version": x.y.z
120
- - skyltmax_config.gemspec: s.version = "x.y.z"
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 gemspec
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/version.rb ADDED
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SkyltmaxConfig
4
+ VERSION = "0.0.6"
5
+ end
data/lib/skyltmax_config.rb CHANGED
@@ -0,0 +1,4 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SkyltmaxConfig
4
+ end
data/package.json CHANGED
@@ -1,8 +1,12 @@
1
1
  {
2
2
  "name": "@signmax/config",
3
- "version": "0.0.4",
4
- "description": "Skyltmax common configs",
3
+ "version": "0.0.6",
4
+ "publishConfig": {
5
+ "access": "public"
6
+ },
7
+ "description": "Reasonable ESLint, Prettier, and TypeScript configs.",
5
8
  "license": "MIT",
9
+ "author": "Signmax AB <team@signomatic.ee> (https://skyltmax.se/)",
6
10
  "homepage": "https://github.com/skyltmax/config#readme",
7
11
  "repository": {
8
12
  "type": "git",
@@ -11,6 +15,14 @@
11
15
  "bugs": {
12
16
  "url": "https://github.com/skyltmax/config/issues"
13
17
  },
18
+ "keywords": [
19
+ "config",
20
+ "eslint",
21
+ "prettier",
22
+ "typescript",
23
+ "signmax",
24
+ "skyltmax"
25
+ ],
14
26
  "main": "index.js",
15
27
  "type": "module",
16
28
  "exports": {
@@ -20,6 +32,18 @@
20
32
  "./reset.d.ts": "./reset.d.ts",
21
33
  "./eslint": "./eslint.js"
22
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
+ },
23
47
  "scripts": {
24
48
  "format": "prettier . --write",
25
49
  "lint": "eslint .",
@@ -27,11 +51,14 @@
27
51
  "validate": "run-p -l format lint typecheck"
28
52
  },
29
53
  "dependencies": {
54
+ "@eslint/js": "^9.33.0",
30
55
  "@total-typescript/ts-reset": "^0.6.1",
31
56
  "@typescript-eslint/eslint-plugin": "^8.39.1",
32
57
  "@typescript-eslint/parser": "^8.39.1",
33
58
  "@typescript-eslint/utils": "^8.39.1",
34
59
  "@vitest/eslint-plugin": "^1.3.4",
60
+ "eslint": "^9.33.0",
61
+ "eslint-config-prettier": "^10.1.8",
35
62
  "eslint-plugin-import-x": "^4.16.1",
36
63
  "eslint-plugin-jest-dom": "^5.5.0",
37
64
  "eslint-plugin-jsx-a11y": "^6.10.2",
@@ -40,18 +67,16 @@
40
67
  "eslint-plugin-react-hooks": "^5.2.0",
41
68
  "eslint-plugin-testing-library": "^7.6.6",
42
69
  "globals": "^16.3.0",
70
+ "prettier": "^3.6.2",
43
71
  "prettier-plugin-tailwindcss": "^0.6.14",
44
72
  "tslib": "^2.8.1",
73
+ "typescript": "^5.9.2",
45
74
  "typescript-eslint": "^8.39.1"
46
75
  },
47
76
  "devDependencies": {
48
- "@eslint/js": "^9.33.0",
49
77
  "@types/react": "^18.3.0",
50
- "eslint": "^9.33.0",
51
78
  "npm-run-all": "^4.1.5",
52
- "prettier": "^3.6.2",
53
- "react": "^18.3.0",
54
- "typescript": "^5.9.2"
79
+ "react": "^18.3.0"
55
80
  },
56
81
  "prettier": "./prettier.js"
57
82
  }