@hussmartinez/sdk-config 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/README.md

@@ -1,3 +1,115 @@
-# Temporary Holding Version
+# @hussmartinez/sdk-config
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Shared development configuration for the `@hussmartinez` SDK family. Every repository extends these presets instead of copying configuration, so a rule changes in one place ([STANDARDS.md](../../STANDARDS.md#tooling)).
+
+> Status: not published yet. Inside this workspace, the root configuration files use these presets.
+
+## Presets
+
+Install, as devDependencies, the tools for the presets you use. They are optional peer dependencies, so a repository without CSS doesn't need stylelint, for example. Plugins that a preset loads itself, such as `@commitlint/config-conventional`, come with the preset.
+
+| Preset | Install |
+|---|---|
+| `tsconfig/*` | `typescript` (and `@types/node` for `tsconfig/node`) |
+| `biome` | `@biomejs/biome` |
+| `stylelint` | `stylelint` |
+| `dependency-cruiser`, `hm-lint-deps` | `dependency-cruiser` |
+| `commitlint` | `@commitlint/cli` |
+| `lint-staged` | `lint-staged`, plus `secretlint`, `@biomejs/biome` and `stylelint`, which it runs |
+| `secretlint` | `secretlint` |
+
+### TypeScript
+
+Strict, ES2022, `nodenext` modules. `browser` adds the DOM library, and `node` adds Node's types (install `@types/node`).
+
+```jsonc
+// tsconfig.json
+{ "extends": "@hussmartinez/sdk-config/tsconfig/browser" }
+```
+
+TypeScript is pinned to 6.0, because TypeScript 7 doesn't have the JavaScript compiler API that dependency-cruiser and api-extractor use yet.
+
+### Biome
+
+Formatting and linting for code, JSON and CSS. Markdown isn't formatted, so tables stay hand-aligned and diffs stay small.
+
+```jsonc
+// biome.json
+{ "extends": ["@hussmartinez/sdk-config/biome"] }
+```
+
+### stylelint
+
+The family's CSS rules. General CSS correctness is left to Biome.
+
+| Rule | Enforces | ADR |
+|---|---|---|
+| `selector-class-pattern`, `selector-id-pattern`, `custom-property-pattern`, `keyframes-name-pattern`, `selector-attribute-name-disallowed-list` | `.hm-<part>`, `.hm-<part>--<variant>`, `#hm-*`, `--hm-*`, `hm-*` keyframes and `data-hm-*` attributes. No generic state classes | [0003](../../docs/adr/0003-hm-namespace.md) |
+| `hm/layer-name-pattern` | Cascade layers are `hm` or `hm.*` | [0003](../../docs/adr/0003-hm-namespace.md) |
+| `hm/selector-scope` | Selectors only match elements inside an hm root. `:root` may only declare `--hm-*` tokens | [0005](../../docs/adr/0005-plain-css-with-cascade-layers.md) |
+| `hm/no-literal-values` | Colours, lengths, durations, easings, z-indexes, opacities and font values come from `--hm-*` tokens, except in `*.tokens.css` and `tokens/` files | [0006](../../docs/adr/0006-design-tokens-and-theming.md) |
+
+Disable comments need a description, such as `/* stylelint-disable-next-line hm/no-literal-values -- the visually hidden pattern needs a 1px box */`.
+
+```js
+// stylelint.config.js
+export { default } from "@hussmartinez/sdk-config/stylelint";
+```
+
+### dependency-cruiser
+
+The layer rules of [ADR 0008](../../docs/adr/0008-ports-adapters-and-session.md), as clarified by [ADR 0017](../../docs/adr/0017-core-errors-and-shared-runtime-imports.md), as forbidden imports between `src/core/*`, `src/adapters`, `src/features`, `src/react`, `src/element` and `src/workers`. The core may import `@hussmartinez/sdk-core` but never `@hussmartinez/ui` or React, and `src/core/errors` imports only `src/core/model` and `@hussmartinez/sdk-core`. It also rejects cycles, unresolvable and undeclared imports, devDependencies in published code and imports of tests.
+
+```js
+// .dependency-cruiser.js
+export { default } from "@hussmartinez/sdk-config/dependency-cruiser";
+```
+
+#### `hm-lint-deps`
+
+Run dependency-cruiser through `hm-lint-deps` rather than `depcruise`:
+
+```json
+{ "scripts": { "lint:deps": "hm-lint-deps src" } }
+```
+
+When dependency-cruiser can't parse a file type, it skips those files without failing. Without a supported TypeScript, for example, it leaves out every `.ts` file and still reports no violations. `hm-lint-deps` runs the same check, with the same report, and also fails when a source file wasn't analysed.
+
+- **Expected files:** the files git tracks under the given paths whose extension the configuration resolves (`enhancedResolveOptions.extensions`) and dependency-cruiser can parse. Declaration files, non-code files and anything matched by the configuration's `exclude`, `doNotFollow` or `includeOnly` are left out.
+- **Analysed:** a file is analysed when it's in the cruise result and dependency-cruiser can parse its file type in the current environment.
+- **Missing files:** the command names up to 20 of them, with a count of the rest and the likely cause.
+
+```text
+Usage: hm-lint-deps [--config <file>] <path>...
+```
+
+| Exit code | Meaning |
+|---|---|
+| 0 | No violations, and every expected file was analysed |
+| 1 | Rule violations, or expected files that weren't analysed |
+| 2 | Usage or configuration error, including running outside a git repository |
+
+It reads `.dependency-cruiser.js` by default and needs `dependency-cruiser` installed. Configurations that use `webpackConfig` or `babelConfig` aren't supported.
+
+### commitlint, lint-staged and secretlint
+
+The git hook rules of [ADR 0016](../../docs/adr/0016-git-hooks-and-merge-guards.md). commitlint accepts the same types and subject pattern as the `pr-title` workflow. lint-staged runs secretlint, Biome and stylelint on staged files.
+
+```js
+// commitlint.config.js
+export { default } from "@hussmartinez/sdk-config/commitlint";
+
+// lint-staged.config.js
+export { default } from "@hussmartinez/sdk-config/lint-staged";
+```
+
+secretlint loads its configuration as CommonJS:
+
+```js
+// .secretlintrc.cjs
+module.exports = require("@hussmartinez/sdk-config/secretlint").default;
+```
+
+## License
+
+[Apache-2.0](../../LICENSE)

package/biome/base.jsonc

@@ -0,0 +1,59 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.6.5/schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "files": {
+    "ignoreUnknown": true
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 100
+  },
+  // Prose and tables stay hand-formatted: padded tables turn a one-cell edit
+  // into a whole-table diff.
+  "markdown": {
+    "formatter": {
+      "enabled": false
+    }
+  },
+  "assist": {
+    "actions": {
+      "source": {
+        "organizeImports": "on"
+      }
+    }
+  },
+  // Recommended rules, plus the ones that keep public code explicit about
+  // types, imports and side effects.
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "preset": "recommended",
+      "complexity": {
+        // Conflicts with the tsconfig preset's noPropertyAccessFromIndexSignature.
+        "useLiteralKeys": "off"
+      },
+      "correctness": {
+        "noUnusedImports": "error",
+        "noUnusedVariables": "error"
+      },
+      "style": {
+        "noNonNullAssertion": "error",
+        "noParameterAssign": "error",
+        "useConst": "error",
+        "useExportType": "error",
+        "useImportType": "error",
+        "useNodejsImportProtocol": "error"
+      },
+      "suspicious": {
+        "noConsole": "error",
+        "noExplicitAny": "error"
+      }
+    }
+  }
+}

package/package.json

@@ -1,6 +1,97 @@
 {
   "name": "@hussmartinez/sdk-config",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "Shared development configuration for the @hussmartinez SDK family.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hussmartinez/sdk-core.git",
+    "directory": "packages/sdk-config"
+  },
+  "type": "module",
+  "bin": {
+    "hm-lint-deps": "./src/dependency-cruiser/cli.js"
+  },
+  "exports": {
+    "./biome": "./biome/base.jsonc",
+    "./commitlint": "./src/commitlint/index.js",
+    "./dependency-cruiser": "./src/dependency-cruiser/index.js",
+    "./lint-staged": "./src/lint-staged/index.js",
+    "./package.json": "./package.json",
+    "./secretlint": "./src/secretlint/index.js",
+    "./stylelint": "./src/stylelint/index.js",
+    "./tsconfig/*": "./tsconfig/*.json"
+  },
+  "files": [
+    "biome",
+    "src",
+    "tsconfig",
+    "!src/**/*.test.js"
+  ],
+  "engines": {
+    "node": ">=24"
+  },
+  "dependencies": {
+    "@commitlint/config-conventional": "^21.2.4",
+    "@secretlint/secretlint-rule-preset-recommend": "^13.1.0",
+    "postcss-selector-parser": "^7.1.7",
+    "postcss-value-parser": "^4.2.0"
+  },
+  "peerDependencies": {
+    "@biomejs/biome": "^2.6.5",
+    "@commitlint/cli": "^21.2.4",
+    "dependency-cruiser": "^18.7.2",
+    "lint-staged": "^17.6.0",
+    "secretlint": "^13.1.0",
+    "stylelint": "^18.0.0",
+    "typescript": "^6.0.3"
+  },
+  "peerDependenciesMeta": {
+    "@biomejs/biome": {
+      "optional": true
+    },
+    "@commitlint/cli": {
+      "optional": true
+    },
+    "dependency-cruiser": {
+      "optional": true
+    },
+    "lint-staged": {
+      "optional": true
+    },
+    "secretlint": {
+      "optional": true
+    },
+    "stylelint": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@biomejs/biome": "^2.6.5",
+    "@commitlint/cli": "^21.2.4",
+    "@commitlint/lint": "^21.2.4",
+    "@commitlint/load": "^21.2.4",
+    "@commitlint/types": "^21.2.3",
+    "@secretlint/node": "^13.1.0",
+    "@types/node": "^24.19.2",
+    "@types/picomatch": "^4.0.3",
+    "dependency-cruiser": "^18.7.2",
+    "lint-staged": "^17.6.0",
+    "picomatch": "^4.0.7",
+    "postcss": "^8.5.31",
+    "publint": "^0.3.25",
+    "secretlint": "^13.1.0",
+    "stylelint": "^18.0.0",
+    "typescript": "^6.0.3",
+    "vitest": "^5.1.0"
+  },
+  "scripts": {
+    "typecheck": "tsc",
+    "test": "vitest run",
+    "check:package": "publint run --pack pnpm --strict && attw --pack . --profile esm-only"
+  }
 }

package/src/commitlint/index.js

@@ -0,0 +1,65 @@
+import { fileURLToPath } from "node:url";
+
+/**
+ * Commit types accepted in this family. The `pr-title` workflow
+ * (`.github/workflows/pr-title.yml`) must list the same types, because the
+ * pull request title becomes the squash commit on `main` (ADR 0016).
+ */
+export const TYPES = [
+  "feat",
+  "fix",
+  "docs",
+  "refactor",
+  "perf",
+  "test",
+  "build",
+  "ci",
+  "chore",
+  "revert",
+];
+
+/**
+ * The subject must not start with a capital letter. This is the same pattern
+ * as `subjectPattern` in the `pr-title` workflow.
+ */
+export const SUBJECT_PATTERN = /^(?![A-Z]).+$/;
+
+/**
+ * Longest commit header, git's conventional limit for a subject line.
+ */
+export const HEADER_MAX_LENGTH = 72;
+
+/**
+ * Longest pull request title. The squash commit title is the pull request
+ * title plus " (#NNN)", which must still fit in {@link HEADER_MAX_LENGTH}.
+ * The `pr-title` workflow checks the same number.
+ */
+export const PR_TITLE_MAX_LENGTH = HEADER_MAX_LENGTH - " (#NNN)".length;
+
+/** @type {import("@commitlint/types").Rule} */
+const subjectPattern = ({ subject }) => [
+  subject == null || SUBJECT_PATTERN.test(subject),
+  "subject must start with a lowercase letter",
+];
+
+/**
+ * commitlint preset for the `commit-msg` hook (ADR 0016): Conventional
+ * Commits, with the types and subject rule of the `pr-title` check, so a
+ * message that passes locally also passes as a pull request title.
+ *
+ * @type {import("@commitlint/types").UserConfig}
+ */
+const config = {
+  // Resolved from this preset, so consumers don't install it themselves.
+  extends: [fileURLToPath(import.meta.resolve("@commitlint/config-conventional"))],
+  plugins: [{ rules: { "hm/subject-pattern": subjectPattern } }],
+  rules: {
+    "type-enum": [2, "always", TYPES],
+    "header-max-length": [2, "always", HEADER_MAX_LENGTH],
+    // Replaced by hm/subject-pattern, which matches the pr-title check exactly.
+    "subject-case": [0],
+    "hm/subject-pattern": [2, "always"],
+  },
+};
+
+export default config;

package/src/dependency-cruiser/cli.js

@@ -0,0 +1,57 @@
+#!/usr/bin/env node
+import { parseArgs } from "node:util";
+import { EXIT_OK, EXIT_USAGE, lintDeps } from "./lint-deps.js";
+
+const USAGE = `Usage: hm-lint-deps [--config <file>] <path>...
+
+Runs dependency-cruiser with the repository's configuration, and fails when it
+didn't analyse a source file that git tracks under the given paths.
+
+Options:
+  -c, --config <file>  dependency-cruiser configuration (default: .dependency-cruiser.js)
+  -h, --help           show this help
+
+Exit codes:
+  0  no violations, and every source file was analysed
+  1  rule violations, or source files dependency-cruiser didn't analyse
+  2  usage or configuration error
+`;
+
+/**
+ * @returns {{ config: string | undefined, help: boolean, paths: string[] }}
+ */
+function parseCommandLine() {
+  try {
+    const { values, positionals } = parseArgs({
+      allowPositionals: true,
+      options: {
+        config: { type: "string", short: "c" },
+        help: { type: "boolean", short: "h", default: false },
+      },
+    });
+    return { config: values.config, help: values.help, paths: positionals };
+  } catch (error) {
+    process.stderr.write(
+      `hm-lint-deps: ${error instanceof Error ? error.message : error}\n\n${USAGE}`,
+    );
+    process.exit(EXIT_USAGE);
+  }
+}
+
+const args = parseCommandLine();
+if (args.help) {
+  process.stdout.write(USAGE);
+  process.exit(EXIT_OK);
+}
+if (args.paths.length === 0) {
+  process.stderr.write(USAGE);
+  process.exit(EXIT_USAGE);
+}
+
+const { exitCode, report, problems } = await lintDeps({
+  paths: args.paths,
+  ...(args.config ? { configFile: args.config } : {}),
+});
+process.stdout.write(report);
+process.stderr.write(problems);
+process.exitCode = exitCode;