@shrkcrft/rules 0.1.0-alpha.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SharkCraft contributors
+
+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.

package/README.md

@@ -0,0 +1,15 @@
+# @shrkcrft/rules
+
+SharkCraft rules service: typed rule entries, relevance lookup, AI formatting.
+
+Part of [SharkCraft](https://github.com/shrkcrft/sharkcraft) — a deterministic, local-first toolkit that gives AI coding agents durable project context. See the main repo for documentation, examples, and the `shrk` CLI.
+
+## Install
+
+```bash
+bun add @shrkcrft/rules
+```
+
+## License
+
+MIT — see [LICENSE](./LICENSE).

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './rule.js';
+export * from './rule-query.js';
+export * from './rule-formatter.js';
+export * from './rule-service.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from "./rule.js";
+export * from "./rule-query.js";
+export * from "./rule-formatter.js";
+export * from "./rule-service.js";

package/dist/rule-formatter.d.ts

@@ -0,0 +1,8 @@
+import { type IKnowledgeEntry } from '@shrkcrft/knowledge';
+import type { IRule } from './rule.js';
+export declare function formatRuleCompact(rule: IRule): string;
+export declare function formatRuleFull(rule: IRule, options?: {
+    includeExamples?: boolean;
+}): string;
+export declare function formatRulesForAi(rules: readonly IKnowledgeEntry[]): string;
+//# sourceMappingURL=rule-formatter.d.ts.map

package/dist/rule-formatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule-formatter.d.ts","sourceRoot":"","sources":["../src/rule-formatter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuC,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAChG,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAEvC,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,KAAK,GAAG,MAAM,CAErD;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,GAAE;IAAE,eAAe,CAAC,EAAE,OAAO,CAAA;CAAO,GAAG,MAAM,CAE/F;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,SAAS,eAAe,EAAE,GAAG,MAAM,CAK1E"}

package/dist/rule-formatter.js

@@ -0,0 +1,14 @@
+import { formatEntryCompact, formatEntryFull } from '@shrkcrft/knowledge';
+export function formatRuleCompact(rule) {
+    return formatEntryCompact(rule);
+}
+export function formatRuleFull(rule, options = {}) {
+    return formatEntryFull(rule, { includeExamples: options.includeExamples ?? true });
+}
+export function formatRulesForAi(rules) {
+    if (rules.length === 0)
+        return 'No relevant rules found.';
+    return rules
+        .map((r, i) => `${i + 1}. [${r.id}] ${r.title}\n   ${r.content.trim()}`)
+        .join('\n\n');
+}

package/dist/rule-query.d.ts

@@ -0,0 +1,9 @@
+export interface IRuleQuery {
+    task?: string;
+    scope?: readonly string[];
+    tags?: readonly string[];
+    appliesWhen?: readonly string[];
+    minPriority?: string;
+    limit?: number;
+}
+//# sourceMappingURL=rule-query.d.ts.map

package/dist/rule-query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule-query.d.ts","sourceRoot":"","sources":["../src/rule-query.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACzB,WAAW,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB"}

package/dist/rule-query.js

@@ -0,0 +1 @@
+export {};

package/dist/rule-service.d.ts

@@ -0,0 +1,12 @@
+import { type IKnowledgeEntry } from '@shrkcrft/knowledge';
+import type { IRule } from './rule.js';
+import type { IRuleQuery } from './rule-query.js';
+export declare class RuleService {
+    private readonly index;
+    constructor(entries: readonly IKnowledgeEntry[]);
+    list(): IRule[];
+    get(id: string): IRule | null;
+    search(query: IRuleQuery): IRule[];
+    getRelevant(task: string, options?: Partial<IRuleQuery>): IRule[];
+}
+//# sourceMappingURL=rule-service.d.ts.map

package/dist/rule-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule-service.d.ts","sourceRoot":"","sources":["../src/rule-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiC,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC1F,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAiB;gBAE3B,OAAO,EAAE,SAAS,eAAe,EAAE;IAI/C,IAAI,IAAI,KAAK,EAAE;IAIf,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI;IAM7B,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,KAAK,EAAE;IAalC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,OAAO,CAAC,UAAU,CAAM,GAAG,KAAK,EAAE;CAGtE"}

package/dist/rule-service.js

@@ -0,0 +1,31 @@
+import { KnowledgeIndex, KnowledgeType } from '@shrkcrft/knowledge';
+export class RuleService {
+    index;
+    constructor(entries) {
+        this.index = new KnowledgeIndex(entries);
+    }
+    list() {
+        return this.index.filter((e) => String(e.type) === KnowledgeType.Rule);
+    }
+    get(id) {
+        const entry = this.index.get(id);
+        if (!entry || String(entry.type) !== KnowledgeType.Rule)
+            return null;
+        return entry;
+    }
+    search(query) {
+        const results = this.index.search({
+            query: query.task,
+            types: [KnowledgeType.Rule],
+            scope: query.scope,
+            tags: query.tags,
+            appliesWhen: query.appliesWhen,
+            minPriority: query.minPriority,
+            limit: query.limit,
+        });
+        return results.map((r) => r.entry);
+    }
+    getRelevant(task, options = {}) {
+        return this.search({ ...options, task, limit: options.limit ?? 10 });
+    }
+}

package/dist/rule.d.ts

@@ -0,0 +1,8 @@
+import type { IKnowledgeEntry } from '@shrkcrft/knowledge';
+import { type DefineKnowledgeInput } from '@shrkcrft/knowledge';
+export type IRule = IKnowledgeEntry;
+export type DefineRuleInput = Omit<DefineKnowledgeInput, 'type'> & {
+    type?: string;
+};
+export declare function defineRule(input: DefineRuleInput): IRule;
+//# sourceMappingURL=rule.d.ts.map

package/dist/rule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule.d.ts","sourceRoot":"","sources":["../src/rule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAuC,KAAK,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAErG,MAAM,MAAM,KAAK,GAAG,eAAe,CAAC;AAEpC,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,GAAG;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAErF,wBAAgB,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,KAAK,CAKxD"}

package/dist/rule.js

@@ -0,0 +1,7 @@
+import { defineKnowledgeEntry, KnowledgeType } from '@shrkcrft/knowledge';
+export function defineRule(input) {
+    return defineKnowledgeEntry({
+        ...input,
+        type: input.type ?? KnowledgeType.Rule,
+    });
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@shrkcrft/rules",
+  "version": "0.1.0-alpha.2",
+  "description": "SharkCraft rules service: typed rule entries, relevance lookup, AI formatting.",
+  "license": "MIT",
+  "author": "SharkCraft contributors",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "bun": "./src/index.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shrkcrft/sharkcraft.git",
+    "directory": "packages/rules"
+  },
+  "homepage": "https://github.com/shrkcrft/sharkcraft",
+  "bugs": {
+    "url": "https://github.com/shrkcrft/sharkcraft/issues"
+  },
+  "keywords": [
+    "sharkcraft",
+    "rules",
+    "coding-standards",
+    "ai"
+  ],
+  "engines": {
+    "bun": ">=1.1.0",
+    "node": ">=18"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit -p tsconfig.json"
+  },
+  "dependencies": {
+    "@shrkcrft/core": "^0.1.0-alpha.2",
+    "@shrkcrft/knowledge": "^0.1.0-alpha.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}