@memberjunction/standards 0.0.0 → 6.1.0-edge.0

package/dist/version.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @fileoverview Minimal semver comparison.
+ *
+ * Deliberately dependency-free. This package is meant to be installed by client repos and run in
+ * CI, so every dependency it carries is one more thing that can conflict with their tree. The only
+ * comparison it needs is "is version A newer than version B", and that is twenty lines.
+ *
+ * @module @memberjunction/standards
+ */
+/** A parsed semver, prerelease and build metadata discarded. */
+interface Parsed {
+    Major: number;
+    Minor: number;
+    Patch: number;
+}
+/**
+ * Parse `major.minor.patch`, tolerating a `v` prefix, a prerelease tag, and build metadata.
+ *
+ * Returns `null` rather than throwing on anything unparseable: a malformed `standardsVersion` in a
+ * repo's config should degrade to "treat every check as available" — visible and safe — not crash
+ * the tool and block the build.
+ */
+export declare function ParseVersion(version: string): Parsed | null;
+/**
+ * Compare two versions. Returns a negative number when `a` is older, 0 when equal, positive when
+ * `a` is newer. An unparseable version sorts as oldest, so unknown input never *hides* a check.
+ */
+export declare function CompareVersions(a: string, b: string): number;
+/**
+ * Is `candidate` newer than `baseline`?
+ *
+ * This is the version-sensitivity primitive: a check whose `Since` is newer than the repo's
+ * adopted `StandardsVersion` is **available, not active**.
+ */
+export declare function IsNewerThan(candidate: string, baseline: string): boolean;
+export {};
+//# sourceMappingURL=version.d.ts.map

package/dist/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,gEAAgE;AAChE,UAAU,MAAM;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAI3D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAO5D;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAExE"}

package/dist/version.js

@@ -0,0 +1,47 @@
+/**
+ * @fileoverview Minimal semver comparison.
+ *
+ * Deliberately dependency-free. This package is meant to be installed by client repos and run in
+ * CI, so every dependency it carries is one more thing that can conflict with their tree. The only
+ * comparison it needs is "is version A newer than version B", and that is twenty lines.
+ *
+ * @module @memberjunction/standards
+ */
+/**
+ * Parse `major.minor.patch`, tolerating a `v` prefix, a prerelease tag, and build metadata.
+ *
+ * Returns `null` rather than throwing on anything unparseable: a malformed `standardsVersion` in a
+ * repo's config should degrade to "treat every check as available" — visible and safe — not crash
+ * the tool and block the build.
+ */
+export function ParseVersion(version) {
+    const match = /^v?(\d+)\.(\d+)\.(\d+)/.exec(version.trim());
+    if (!match)
+        return null;
+    return { Major: Number(match[1]), Minor: Number(match[2]), Patch: Number(match[3]) };
+}
+/**
+ * Compare two versions. Returns a negative number when `a` is older, 0 when equal, positive when
+ * `a` is newer. An unparseable version sorts as oldest, so unknown input never *hides* a check.
+ */
+export function CompareVersions(a, b) {
+    const left = ParseVersion(a);
+    const right = ParseVersion(b);
+    if (!left && !right)
+        return 0;
+    if (!left)
+        return -1;
+    if (!right)
+        return 1;
+    return left.Major - right.Major || left.Minor - right.Minor || left.Patch - right.Patch;
+}
+/**
+ * Is `candidate` newer than `baseline`?
+ *
+ * This is the version-sensitivity primitive: a check whose `Since` is newer than the repo's
+ * adopted `StandardsVersion` is **available, not active**.
+ */
+export function IsNewerThan(candidate, baseline) {
+    return CompareVersions(candidate, baseline) > 0;
+}
+//# sourceMappingURL=version.js.map

package/dist/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AASH;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,OAAe;IACxC,MAAM,KAAK,GAAG,wBAAwB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAC5D,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IACxB,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACzF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,CAAS,EAAE,CAAS;IAChD,MAAM,IAAI,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IAC7B,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IAC9B,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK;QAAE,OAAO,CAAC,CAAC;IAC9B,IAAI,CAAC,IAAI;QAAE,OAAO,CAAC,CAAC,CAAC;IACrB,IAAI,CAAC,KAAK;QAAE,OAAO,CAAC,CAAC;IACrB,OAAO,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;AAC5F,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,SAAiB,EAAE,QAAgB;IAC3D,OAAO,eAAe,CAAC,SAAS,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;AACpD,CAAC"}

package/package.json

@@ -1,10 +1,38 @@
 {
   "name": "@memberjunction/standards",
-  "version": "0.0.0",
-  "description": "OIDC trusted publishing setup package for @memberjunction/standards",
+  "type": "module",
+  "version": "6.1.0-edge.0",
+  "description": "MemberJunction engineering standards as runnable, versioned checks — plus the scaffolding that gets a repo enforcing them. Opt-in per check; a new standard never changes an existing repo's result.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "mj-standards": "bin/run.js"
+  },
+  "files": [
+    "/dist",
+    "/bin",
+    "/schema"
+  ],
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+    "MemberJunction",
+    "standards",
+    "lint",
+    "architecture"
+  ],
+  "author": "MemberJunction.com",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MemberJunction/MJ"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3",
+    "tsc-alias": "^1.8.16",
+    "vitest": "^4.0.18"
+  },
+  "scripts": {
+    "build": "tsc && tsc-alias -f",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}

package/schema/mj-standards.schema.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://memberjunction.com/schema/mj-standards.schema.json",
+  "title": "MJ standards adoption",
+  "description": "A repository's record of which MemberJunction engineering standards it enforces, and how strictly. Written and updated by `mj standards adopt`; safe to edit by hand.",
+  "type": "object",
+  "required": ["StandardsVersion", "Checks"],
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "description": "Pointer to this schema, for editor completion."
+    },
+    "StandardsVersion": {
+      "type": "string",
+      "description": "The MJ version this repo adopted standards against. Checks introduced after this version are reported as available and do NOT run — that is what stops a package upgrade from activating new rules here. Bump it deliberately with `mj standards adopt --upgrade`.",
+      "pattern": "^v?\\d+\\.\\d+\\.\\d+"
+    },
+    "Roots": {
+      "type": "array",
+      "description": "Default repo-relative directories to scan, for checks that do not name their own.",
+      "items": { "type": "string" }
+    },
+    "Checks": {
+      "type": "object",
+      "description": "Per-check configuration. A check absent from this map does not run — adoption is explicit.",
+      "additionalProperties": {
+        "type": "object",
+        "required": ["Severity"],
+        "additionalProperties": false,
+        "properties": {
+          "Severity": {
+            "enum": ["off", "warn", "error"],
+            "description": "off = registered but not run. warn = reported, exit code stays 0 (what a newly adopted check should be for one cycle). error = reported, exit code 1."
+          },
+          "Roots": {
+            "type": "array",
+            "description": "Overrides the check's default roots.",
+            "items": { "type": "string" }
+          },
+          "Options": {
+            "type": "object",
+            "description": "Check-specific options. See `mj standards list` for what each check accepts.",
+            "additionalProperties": true
+          }
+        }
+      }
+    }
+  }
+}