skyltmax_config 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bcbd31d35395e4925e9a37a44624b408e64d14b0eca121cb69924f8854c218c5
+  data.tar.gz: 5a90d3b8171e5529e2de5779a0bf008c4f79fc19673d36567698dd7c50becc3b
+SHA512:
+  metadata.gz: ba5673af586d69e07fe54303368727339668ffa607bc622d228c3e01249b851f74bc8cd13ba3c8b0babace225efc511d389a61c57249fd62e4b8994a1537aaaf
+  data.tar.gz: 93d7b3c7f9a42d8585bd886fb6137b612bdf564e936a02a53b886534489ac7d1fb4d2a426ced92b2678f2a690eafd7574c44ba9c7a916c6e57f823f9cb81a421

data/.devcontainer/.bootdone

@@ -0,0 +1,2 @@
+  BUNDLE_ALREADY_INSTALLED=true
+  CHANGELOG_DISPLAYED_6=true

data/.devcontainer/boot.sh

@@ -0,0 +1,49 @@
+#!/bin/bash
+
+set -e
+
+if [ -f "/home/$HOSTLOGNAME/.ssh/id_rsa.pub.sign" ]; then
+  ln -sf /home/$HOSTLOGNAME/.ssh/id_rsa.pub.sign /home/vscode/.ssh/id_rsa.pub.sign
+fi
+
+sudo chown -R vscode:vscode .ruby-lsp
+sudo chown -R vscode:vscode /usr/local/bundle
+
+git config --global --add safe.directory $DEVC_WORKSPACE
+
+function bootcmd() {
+  printf "\n"
+  toilet -f term -t -F border:metal "$1"
+  printf "+ $2\n"
+}
+
+MARKER_FILE=".devcontainer/.bootdone"
+
+if [ -f "${MARKER_FILE}" ]; then
+  source "${MARKER_FILE}"
+fi
+
+if [ "${BUNDLE_ALREADY_INSTALLED}" != "true" ]; then
+  bootcmd "Installing gems" "bundle install"
+  bundle install
+  BUNDLE_ALREADY_INSTALLED="true"
+fi
+
+if [ "${CHANGELOG_DISPLAYED_6}" != "true" ]; then
+  if [ -f "/var/lib/smdevc/changelog" ]; then
+    printf "\n"
+    toilet -f term -t -F border:metal "Latest Changes"
+    cat /var/lib/smdevc/changelog
+  fi
+
+  CHANGELOG_DISPLAYED_6="true"
+fi
+
+echo -e "\
+  BUNDLE_ALREADY_INSTALLED=${BUNDLE_ALREADY_INSTALLED}\n\
+  CHANGELOG_DISPLAYED_6=${CHANGELOG_DISPLAYED_6}" > "${MARKER_FILE}"
+
+printf "\n\n\e[38;2;252;163;17m"
+toilet -f standard "Config"
+printf "\nEnvironment prepared! Get ready to code!\n\n"
+printf "\e[0m"

data/.devcontainer/devcontainer.json

@@ -0,0 +1,17 @@
+{
+  "name": "Config",
+  "dockerComposeFile": "docker-compose.yml",
+  "service": "app",
+  "workspaceFolder": "/workspaces/config",
+  "containerEnv": {
+    "RUBY_YJIT_ENABLE": "true",
+    "MALLOC_ARENA_MAX": "2",
+    "BUNDLE_JOBS": "8",
+    "DEVC_WORKSPACE": "${containerWorkspaceFolder}"
+  },
+  "mounts": [
+    "source=bundle,target=/usr/local/bundle,type=volume",
+    "source=rubylsp,target=${containerWorkspaceFolder}/.ruby-lsp,type=volume"
+  ],
+  "onCreateCommand": ".devcontainer/boot.sh"
+}

data/.devcontainer/docker-compose.yml

@@ -0,0 +1,10 @@
+services:
+  app:
+    image: harbor.signmax.cloud/public/devcontainer:rails-3.4.5-14
+    volumes:
+      - ..:/workspaces/config:cached
+    shm_size: "1gb"
+    # Overrides default command so things don't shut down after the process ends.
+    command: sleep infinity
+    # Use "forwardPorts" in **devcontainer.json** to forward an app port locally.
+    # (Adding the "ports" property to this file will not forward from a Codespace.)

data/.gitignore

@@ -0,0 +1,2 @@
+node_modules
+.pnpm-store

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: rubocop.yml

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Change Log
+
+### Unreleased
+
+### [0.0.1] - 2025-11-04
+- First public release.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :ci do
+  gem "rubocop", require: false
+  gem "rubocop-performance", require: false
+end

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    skyltmax_config (0.0.1)
+      rubocop (>= 1.81.0, < 2)
+      rubocop-performance (>= 1.26.0, < 2)
+      rubocop-rails (>= 2.33.0, < 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (8.1.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    ast (2.4.3)
+    base64 (0.3.0)
+    bigdecimal (3.3.1)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.4)
+    drb (2.2.3)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    json (2.13.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    minitest (5.26.0)
+    parallel (1.27.0)
+    parser (3.3.9.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
+    rack (3.2.4)
+    rainbow (3.1.1)
+    regexp_parser (2.11.2)
+    rubocop (1.81.7)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.47.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    rubocop-rails (2.33.4)
+      activesupport (>= 4.2.0)
+      lint_roller (~> 1.1)
+      rack (>= 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.1.1)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  rubocop
+  rubocop-performance
+  skyltmax_config!
+
+BUNDLED WITH
+   2.6.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Skyltmax
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,139 @@
+# 👮 @skyltmax/config
+
+**Reasonable ESLint, Prettier, TypeScript, and Rubocop configs**
+
+Based on <a href="https://github.com/epicweb-dev/config">@epic-web/config</a>.
+
+## Usage
+
+### Rubocop
+
+Include the gem in your `Gemfile`:
+
+```rb
+gem "skyltmax_config"
+```
+
+Inherit the configs from the gem in your `.rubocop.yml`:
+
+```yml
+inherit_gem:
+  skyltmax_config:
+    - rubocop.yml
+    - rubocop.rails.yml
+```
+
+### Prettier
+
+The easiest way to use this config is in your `package.json`:
+
+```json
+"prettier": "@skyltmax/config/prettier"
+```
+
+<details>
+  <summary>Customizing Prettier</summary>
+
+If you want to customize things, you should probably just copy/paste the built-in config. But if you really want, you
+can override it using regular JavaScript stuff.
+
+Create a `.prettierrc.js` file in your project root with the following content:
+
+```js
+import defaultConfig from "skyltmax/config/prettier"
+
+/** @type {import("prettier").Options} */
+export default {
+  ...defaultConfig,
+  // .. your overrides here...
+}
+```
+
+</details>
+
+### TypeScript
+
+Create a `tsconfig.json` file in your project root with the following content:
+
+```json
+{
+  "extends": ["@skyltmax/config/typescript"],
+  "include": ["**/*.ts", "**/*.tsx", "**/*.js", "**/*.jsx"],
+  "compilerOptions": {
+    "paths": {
+      "#app/*": ["./app/*"],
+      "#tests/*": ["./tests/*"]
+    }
+  }
+}
+```
+
+Create a `reset.d.ts` file in your project with these contents:
+
+```typescript
+import "@skyltmax/config/reset.d.ts"
+```
+
+<details>
+  <summary>Customizing TypeScript</summary>
+
+Learn more from [the TypeScript docs here](https://www.typescriptlang.org/tsconfig/#extends).
+
+</details>
+
+### ESLint
+
+Create a `eslint.config.js` file in your project root with the following content:
+
+```js
+import { config as defaultConfig } from "@skyltmax/config/eslint"
+
+/** @type {import("eslint").Linter.Config[]} */
+export default [...defaultConfig]
+```
+
+<details>
+  <summary>Customizing ESLint</summary>
+
+Learn more from
+[the Eslint docs here](https://eslint.org/docs/latest/extend/shareable-configs#overriding-settings-from-shareable-configs).
+
+</details>
+
+There are endless rules we could enable. However, we want to keep our configurations minimal and only enable rules that
+catch real problems (the kind that are likely to happen). This keeps our linting faster and reduces the number of false
+positives.
+
+## Publishing
+
+This repo publishes a Ruby gem (skyltmax_config) and an npm package (@skyltmax/config) whenever a GitHub Release is published. A manual run is also available.
+
+Setup (one-time):
+
+- In repository Settings → Secrets and variables → Actions, add:
+  - NPM_TOKEN: npm automation token with publish permission for the @skyltmax scope
+  - RUBYGEMS_API_KEY: RubyGems API key with push access to skyltmax_config
+- Ensure package and gem versions match. The workflow verifies that the git tag version equals both versions.
+
+How to release:
+
+1. Update versions:
+   - package.json: "version": x.y.z
+   - skyltmax_config.gemspec: s.version = "x.y.z"
+2. Commit and push changes.
+3. Create a Git tag vX.Y.Z and a GitHub Release for that tag (or run the "Publish release" workflow with that ref).
+
+What the workflow does:
+
+- Verifies tag version matches package.json and gemspec
+- Publishes the npm package with provenance enabled
+- Builds and pushes the gem to RubyGems
+
+Notes:
+
+- For first-time publish of a scoped npm package, access is set to public by the workflow.
+- If your npm org enforces 2FA, the token must be an automation token.
+
+## License
+
+MIT

data/eslint.config.js

@@ -0,0 +1 @@
+export { default } from "./eslint.js"

data/eslint.js

@@ -0,0 +1,234 @@
+import globals from "globals"
+
+const ERROR = "error"
+const WARN = "warn"
+const OFF = "off"
+
+const vitestFiles = ["**/__tests__/**/*", "**/*.test.*", "**/*.spec.*"]
+const testFiles = ["**/tests/**", "**/#tests/**", ...vitestFiles]
+const playwrightFiles = ["**/e2e/**"]
+
+/** @type {import("eslint").Linter.Config[]} */
+export const config = [
+  {
+    ignores: [
+      "**/.cache/**",
+      "**/node_modules/**",
+      "**/build/**",
+      "**/public/build/**",
+      "**/playwright-report/**",
+      "**/server-build/**",
+      "**/dist/**",
+      "**/coverage/**",
+    ],
+  },
+
+  (await import("@eslint/js")).default.configs.recommended,
+  (await import("eslint-plugin-prettier/recommended")).default,
+
+  // all files
+  {
+    plugins: {
+      import: (await import("eslint-plugin-import-x")).default,
+    },
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+      },
+    },
+    rules: {
+      "no-unexpected-multiline": ERROR,
+      "no-warning-comments": [ERROR, { terms: ["FIXME"], location: "anywhere" }],
+      "import/no-duplicates": [WARN, { "prefer-inline": true }],
+      "import/order": [
+        WARN,
+        {
+          alphabetize: { order: "asc", caseInsensitive: true },
+          pathGroups: [{ pattern: "#*/**", group: "internal" }],
+          groups: ["builtin", "external", "internal", "parent", "sibling", "index"],
+        },
+      ],
+    },
+  },
+
+  // JSX/TSX files
+  {
+    files: ["**/*.tsx", "**/*.jsx"],
+    plugins: {
+      react: (await import("eslint-plugin-react")).default,
+    },
+    languageOptions: {
+      parser: (await import("typescript-eslint")).parser,
+      parserOptions: {
+        jsx: true,
+      },
+    },
+    settings: {
+      react: {
+        version: "detect",
+      },
+      formComponents: ["Form"],
+      linkComponents: [
+        {
+          name: "Link",
+          linkAttribute: "to",
+        },
+        {
+          name: "NavLink",
+          linkAttribute: "to",
+        },
+      ],
+    },
+    rules: {
+      ...(await import("eslint-plugin-react")).default.configs.flat.recommended.rules,
+      ...(await import("eslint-plugin-react")).default.configs.flat["jsx-runtime"].rules,
+      "react/jsx-key": WARN,
+      "react/prop-types": OFF,
+      "react/button-has-type": ERROR,
+      "react/jsx-boolean-value": WARN,
+      "react-hooks/exhaustive-deps": ERROR,
+
+      "react/jsx-no-leaked-render": [
+        WARN,
+        {
+          validStrategies: ["ternary"],
+        },
+      ],
+    },
+  },
+
+  {
+    files: ["**/*.tsx", "**/*.jsx"],
+    ...(await import("eslint-plugin-jsx-a11y")).default.flatConfigs.recommended,
+  },
+
+  // react-hook rules are applicable in ts/js/tsx/jsx, but only with React as a dep
+  {
+    files: ["**/*.ts?(x)", "**/*.js?(x)"],
+    plugins: {
+      "react-hooks": (await import("eslint-plugin-react-hooks")).default,
+    },
+    rules: {
+      "react-hooks/rules-of-hooks": ERROR,
+      "react-hooks/exhaustive-deps": WARN,
+    },
+  },
+
+  // JS and JSX files
+  {
+    files: ["**/*.js?(x)"],
+    rules: {
+      "no-undef": ERROR,
+
+      // most of these rules are useful for JS but not TS because TS handles these better
+      // if it weren't for https://github.com/import-js/eslint-plugin-import/issues/2132
+      // we could enable this :(
+      // 'import/no-unresolved': ERROR,
+      "no-unused-vars": [
+        ERROR,
+        {
+          vars: "all",
+          args: "after-used",
+          argsIgnorePattern: "^_",
+          ignoreRestSiblings: true,
+          varsIgnorePattern: "^ignored",
+        },
+      ],
+    },
+  },
+
+  // TS and TSX files
+  ...(await import("typescript-eslint")).default.config({
+    files: ["**/*.ts?(x)"],
+    extends: [(await import("typescript-eslint")).default.configs.recommended],
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: process.cwd(),
+      },
+    },
+    rules: {
+      "@typescript-eslint/no-unused-vars": [
+        WARN,
+        {
+          args: "after-used",
+          argsIgnorePattern: "^_",
+          ignoreRestSiblings: true,
+          varsIgnorePattern: "^ignored",
+        },
+      ],
+      "import/consistent-type-specifier-style": OFF,
+      "@typescript-eslint/consistent-type-imports": [
+        WARN,
+        {
+          prefer: "type-imports",
+          disallowTypeAnnotations: true,
+          fixStyle: "inline-type-imports",
+        },
+      ],
+      "@typescript-eslint/no-misused-promises": [ERROR, { checksVoidReturn: false }],
+      "@typescript-eslint/no-floating-promises": ERROR,
+    },
+  }),
+
+  // This assumes test files are those which are in the test directory or have *.test.* or *.spec.* in the filename.
+  // If a file doesn't match this assumption, then it will not be allowed to import test files.
+  {
+    files: ["**/*.ts?(x)", "**/*.js?(x)"],
+    ignores: testFiles,
+    rules: {
+      "no-restricted-imports": [
+        ERROR,
+        {
+          patterns: [
+            {
+              group: testFiles,
+              message: "Do not import test files in source files",
+            },
+          ],
+        },
+      ],
+    },
+  },
+
+  {
+    files: testFiles,
+    ignores: [...playwrightFiles],
+    plugins: {
+      "testing-library": (await import("eslint-plugin-testing-library")).default,
+    },
+    rules: {
+      ...(await import("eslint-plugin-testing-library")).default.configs["flat/react"].rules,
+      ...(await import("eslint-plugin-testing-library")).default.configs["flat/dom"].rules,
+      "testing-library/no-unnecessary-act": [ERROR, { isStrict: false }],
+      "testing-library/no-wait-for-side-effects": ERROR,
+      "testing-library/prefer-find-by": ERROR,
+    },
+  },
+
+  {
+    files: testFiles,
+    ignores: [...playwrightFiles],
+    plugins: {
+      "jest-dom": (await import("eslint-plugin-jest-dom")).default,
+    },
+    ...(await import("eslint-plugin-jest-dom")).default.configs["flat/recommended"],
+  },
+
+  {
+    files: testFiles,
+    ignores: [...playwrightFiles],
+    plugins: {
+      vitest: (await import("@vitest/eslint-plugin")).default,
+    },
+    rules: {
+      ...(await import("@vitest/eslint-plugin")).default.configs.recommended.rules,
+      // you don't want the editor to autofix this, but we do want to be made aware of it
+      "vitest/no-focused-tests": [WARN, { fixable: false }],
+    },
+  },
+].filter(Boolean)
+
+// this is for backward compatibility
+export default config

data/index.js

@@ -0,0 +1,2 @@
+// Placeholder entry so package main export resolves; consumers should import the named config exports instead.
+export {}

data/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@skyltmax/config",
+  "version": "0.0.1",
+  "description": "Skyltmax common configs",
+  "license": "MIT",
+  "homepage": "https://github.com/skyltmax/config#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/skyltmax/config.git"
+  },
+  "bugs": {
+    "url": "https://github.com/skyltmax/config/issues"
+  },
+  "main": "index.js",
+  "type": "module",
+  "exports": {
+    ".": "./index.js",
+    "./prettier": "./prettier.js",
+    "./typescript": "./typescript.json",
+    "./reset.d.ts": "./reset.d.ts",
+    "./eslint": "./eslint.js"
+  },
+  "scripts": {
+    "format": "prettier . --write",
+    "lint": "eslint .",
+    "typecheck": "tsc",
+    "validate": "run-p -l format lint typecheck"
+  },
+  "dependencies": {
+    "@total-typescript/ts-reset": "^0.6.1",
+    "@typescript-eslint/eslint-plugin": "^8.39.1",
+    "@typescript-eslint/parser": "^8.39.1",
+    "@typescript-eslint/utils": "^8.39.1",
+    "@vitest/eslint-plugin": "^1.3.4",
+    "eslint-plugin-import-x": "^4.16.1",
+    "eslint-plugin-jest-dom": "^5.5.0",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-testing-library": "^7.6.6",
+    "globals": "^16.3.0",
+    "prettier-plugin-tailwindcss": "^0.6.14",
+    "tslib": "^2.8.1",
+    "typescript-eslint": "^8.39.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.33.0",
+    "@types/react": "^18.3.0",
+    "eslint": "^9.33.0",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^3.6.2",
+    "react": "^18.3.0",
+    "typescript": "^5.9.2"
+  },
+  "prettier": "./prettier.js"
+}