@sha3/code-standards 0.1.0 → 0.1.2

package/resources/ai/templates/examples/rules/control-flow-good.ts

@@ -0,0 +1,92 @@
+/**
+ * @section imports:externals
+ */
+
+// empty
+
+/**
+ * @section imports:internals
+ */
+
+// empty
+
+/**
+ * @section consts
+ */
+
+// empty
+
+/**
+ * @section types
+ */
+
+type FeatureFlagMap = Record<string, boolean>;
+
+export class FeatureGate {
+  /**
+   * @section private:attributes
+   */
+
+  // empty
+
+  /**
+   * @section private:properties
+   */
+
+  private readonly flags: FeatureFlagMap;
+
+  /**
+   * @section public:properties
+   */
+
+  // empty
+
+  /**
+   * @section constructor
+   */
+
+  public constructor(flags: FeatureFlagMap) {
+    this.flags = flags;
+  }
+
+  /**
+   * @section static:properties
+   */
+
+  // empty
+
+  /**
+   * @section factory
+   */
+
+  public static from(flags: FeatureFlagMap): FeatureGate {
+    const gate = new FeatureGate(flags);
+    return gate;
+  }
+
+  /**
+   * @section private:methods
+   */
+
+  // empty
+
+  /**
+   * @section public:methods
+   */
+
+  public canRunTask(key: string): boolean {
+    let enabled = false;
+
+    if (this.flags[key] === true) {
+      enabled = true;
+    }
+
+    return enabled;
+  }
+
+  /**
+   * @section static:methods
+   */
+
+  // empty
+}

package/resources/ai/templates/examples/rules/errors-bad.ts

@@ -0,0 +1,86 @@
+/**
+ * @section imports:externals
+ */
+
+// empty
+
+/**
+ * @section imports:internals
+ */
+
+// empty
+
+/**
+ * @section consts
+ */
+
+// empty
+
+/**
+ * @section types
+ */
+
+// empty
+
+export class InvoiceLookup {
+  /**
+   * @section private:attributes
+   */
+
+  // empty
+
+  /**
+   * @section private:properties
+   */
+
+  // empty
+
+  /**
+   * @section public:properties
+   */
+
+  // empty
+
+  /**
+   * @section constructor
+   */
+
+  // empty
+
+  /**
+   * @section static:properties
+   */
+
+  // empty
+
+  /**
+   * @section factory
+   */
+
+  public static create(): InvoiceLookup {
+    const lookup = new InvoiceLookup();
+    return lookup;
+  }
+
+  /**
+   * @section private:methods
+   */
+
+  // empty
+
+  /**
+   * @section public:methods
+   */
+
+  public ensureInvoiceExists(invoiceId: string, exists: boolean): void {
+    if (!exists) {
+      throw new Error(`Missing invoice ${invoiceId}`);
+    }
+  }
+
+  /**
+   * @section static:methods
+   */
+
+  // empty
+}

package/resources/ai/templates/examples/rules/errors-good.ts

@@ -0,0 +1,89 @@
+/**
+ * @section imports:externals
+ */
+
+// empty
+
+/**
+ * @section imports:internals
+ */
+
+// empty
+
+/**
+ * @section consts
+ */
+
+// empty
+
+/**
+ * @section types
+ */
+
+// empty
+
+export class InvoiceNotFoundError extends Error {
+  /**
+   * @section private:attributes
+   */
+
+  // empty
+
+  /**
+   * @section private:properties
+   */
+
+  private readonly invoiceId: string;
+
+  /**
+   * @section public:properties
+   */
+
+  // empty
+
+  /**
+   * @section constructor
+   */
+
+  public constructor(invoiceId: string) {
+    super(`Invoice not found: ${invoiceId}`);
+    this.name = "InvoiceNotFoundError";
+    this.invoiceId = invoiceId;
+  }
+
+  /**
+   * @section static:properties
+   */
+
+  // empty
+
+  /**
+   * @section factory
+   */
+
+  public static forId(invoiceId: string): InvoiceNotFoundError {
+    const error = new InvoiceNotFoundError(invoiceId);
+    return error;
+  }
+
+  /**
+   * @section private:methods
+   */
+
+  // empty
+
+  /**
+   * @section public:methods
+   */
+
+  public toLogContext(): string {
+    const context = `invoiceId=${this.invoiceId}`;
+    return context;
+  }
+
+  /**
+   * @section static:methods
+   */
+
+  // empty
+}

package/resources/ai/templates/examples/rules/functions-bad.ts

@@ -0,0 +1,106 @@
+/**
+ * @section imports:externals
+ */
+
+// empty
+
+/**
+ * @section imports:internals
+ */
+
+// empty
+
+/**
+ * @section consts
+ */
+
+// empty
+
+/**
+ * @section types
+ */
+
+type PaymentInput = { amount?: number; currency?: string; metadata?: Record<string, string> };
+type PersistedPaymentInput = PaymentInput & { normalizedAt: number; saved: boolean };
+
+export class PaymentNormalizer {
+  /**
+   * @section private:attributes
+   */
+
+  // empty
+
+  /**
+   * @section private:properties
+   */
+
+  // empty
+
+  /**
+   * @section public:properties
+   */
+
+  // empty
+
+  /**
+   * @section constructor
+   */
+
+  // empty
+
+  /**
+   * @section static:properties
+   */
+
+  // empty
+
+  /**
+   * @section factory
+   */
+
+  public static create(): PaymentNormalizer {
+    const normalizer = new PaymentNormalizer();
+    return normalizer;
+  }
+
+  /**
+   * @section private:methods
+   */
+
+  // empty
+
+  /**
+   * @section public:methods
+   */
+
+  public normalize(input: PaymentInput): PersistedPaymentInput {
+    // Bad: too many responsibilities in one method.
+    const clone = { ...input };
+
+    if (!clone.currency) {
+      clone.currency = "usd";
+    }
+
+    if (typeof clone.currency === "string") {
+      clone.currency = clone.currency.toUpperCase();
+    }
+
+    if (!clone.metadata) {
+      clone.metadata = {};
+    }
+
+    clone.amount = Number(clone.amount || 0);
+    const persisted: PersistedPaymentInput = {
+      ...clone,
+      normalizedAt: Date.now(),
+      saved: true
+    };
+    return persisted;
+  }
+
+  /**
+   * @section static:methods
+   */
+
+  // empty
+}

package/resources/ai/templates/examples/rules/functions-good.ts

@@ -0,0 +1,102 @@
+/**
+ * @section imports:externals
+ */
+
+// empty
+
+/**
+ * @section imports:internals
+ */
+
+// empty
+
+/**
+ * @section consts
+ */
+
+// empty
+
+/**
+ * @section types
+ */
+
+type PaymentInput = { amount: number; currency: string; metadata: Record<string, string> };
+type PaymentDraft = { amount: number; currency: string; metadata: Record<string, string> };
+
+export class PaymentNormalizer {
+  /**
+   * @section private:attributes
+   */
+
+  // empty
+
+  /**
+   * @section private:properties
+   */
+
+  // empty
+
+  /**
+   * @section public:properties
+   */
+
+  // empty
+
+  /**
+   * @section constructor
+   */
+
+  // empty
+
+  /**
+   * @section static:properties
+   */
+
+  // empty
+
+  /**
+   * @section factory
+   */
+
+  public static create(): PaymentNormalizer {
+    const normalizer = new PaymentNormalizer();
+    return normalizer;
+  }
+
+  /**
+   * @section private:methods
+   */
+
+  private normalizeAmount(amount: number): number {
+    const normalizedAmount = Number(amount.toFixed(2));
+    return normalizedAmount;
+  }
+
+  private normalizeCurrency(currency: string): string {
+    const normalizedCurrency = currency.trim().toUpperCase();
+    return normalizedCurrency;
+  }
+
+  private sanitizeMetadata(metadata: Record<string, string>): Record<string, string> {
+    const sanitizedMetadata: Record<string, string> = { ...metadata };
+    return sanitizedMetadata;
+  }
+
+  /**
+   * @section public:methods
+   */
+
+  public normalize(input: PaymentInput): PaymentDraft {
+    const amount: number = this.normalizeAmount(input.amount);
+    const currency: string = this.normalizeCurrency(input.currency);
+    const metadata: Record<string, string> = this.sanitizeMetadata(input.metadata);
+    const draft: PaymentDraft = { amount, currency, metadata };
+    return draft;
+  }
+
+  /**
+   * @section static:methods
+   */
+
+  // empty
+}

package/resources/ai/templates/examples/rules/returns-bad.ts

@@ -0,0 +1,92 @@
+/**
+ * @section imports:externals
+ */
+
+// empty
+
+/**
+ * @section imports:internals
+ */
+
+// empty
+
+/**
+ * @section consts
+ */
+
+// empty
+
+/**
+ * @section types
+ */
+
+type InvoiceStatus = "paid" | "void" | "pending";
+
+export class InvoiceStatusPresenter {
+  /**
+   * @section private:attributes
+   */
+
+  // empty
+
+  /**
+   * @section private:properties
+   */
+
+  // empty
+
+  /**
+   * @section public:properties
+   */
+
+  // empty
+
+  /**
+   * @section constructor
+   */
+
+  // empty
+
+  /**
+   * @section static:properties
+   */
+
+  // empty
+
+  /**
+   * @section factory
+   */
+
+  public static create(): InvoiceStatusPresenter {
+    const presenter = new InvoiceStatusPresenter();
+    return presenter;
+  }
+
+  /**
+   * @section private:methods
+   */
+
+  // empty
+
+  /**
+   * @section public:methods
+   */
+
+  public toStatusLabel(status: InvoiceStatus): string {
+    if (status === "paid") {
+      return "Paid";
+    }
+
+    if (status === "void") {
+      return "Void";
+    }
+
+    return "Pending";
+  }
+
+  /**
+   * @section static:methods
+   */
+
+  // empty
+}

package/resources/ai/templates/examples/rules/returns-good.ts

@@ -0,0 +1,94 @@
+/**
+ * @section imports:externals
+ */
+
+// empty
+
+/**
+ * @section imports:internals
+ */
+
+// empty
+
+/**
+ * @section consts
+ */
+
+// empty
+
+/**
+ * @section types
+ */
+
+type InvoiceStatus = "paid" | "void" | "pending";
+
+export class InvoiceStatusPresenter {
+  /**
+   * @section private:attributes
+   */
+
+  // empty
+
+  /**
+   * @section private:properties
+   */
+
+  // empty
+
+  /**
+   * @section public:properties
+   */
+
+  // empty
+
+  /**
+   * @section constructor
+   */
+
+  // empty
+
+  /**
+   * @section static:properties
+   */
+
+  // empty
+
+  /**
+   * @section factory
+   */
+
+  public static create(): InvoiceStatusPresenter {
+    const presenter = new InvoiceStatusPresenter();
+    return presenter;
+  }
+
+  /**
+   * @section private:methods
+   */
+
+  // empty
+
+  /**
+   * @section public:methods
+   */
+
+  public toStatusLabel(status: InvoiceStatus): string {
+    let label: string;
+
+    if (status === "paid") {
+      label = "Paid";
+    } else if (status === "void") {
+      label = "Void";
+    } else {
+      label = "Pending";
+    }
+
+    return label;
+  }
+
+  /**
+   * @section static:methods
+   */
+
+  // empty
+}