@sha3/code-standards 0.1.3 → 0.1.5

package/eslint/test.mjs

@@ -4,11 +4,7 @@ import nodeConfig from "./node.mjs";
 export default [
   ...nodeConfig,
   {
-    files: [
-      "**/*.test.{js,mjs,cjs,ts,mts,cts}",
-      "**/*.spec.{js,mjs,cjs,ts,mts,cts}",
-      "test/**/*.{js,mjs,cjs,ts,mts,cts}"
-    ],
+    files: ["**/*.test.{js,mjs,cjs,ts,mts,cts}", "**/*.spec.{js,mjs,cjs,ts,mts,cts}", "test/**/*.{js,mjs,cjs,ts,mts,cts}"],
     languageOptions: {
       globals: {
         ...globals.mocha,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sha3/code-standards",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "AI-first code standards, tooling exports, and project initializer",
   "type": "module",
   "bin": {

package/prettier/index.cjs

@@ -1,5 +1,5 @@
 module.exports = {
-  printWidth: 100,
+  printWidth: 160,
   tabWidth: 2,
   useTabs: false,
   semi: true,

package/profiles/default.profile.json

@@ -18,12 +18,14 @@
     "consts",
     "types",
     "private:attributes",
+    "protected:attributes",
     "private:properties",
     "public:properties",
     "constructor",
     "static:properties",
     "factory",
     "private:methods",
+    "protected:methods",
     "public:methods",
     "static:methods"
   ],

package/profiles/schema.json

@@ -43,11 +43,7 @@
     },
     "return_policy": {
       "type": "string",
-      "enum": [
-        "single_return_strict_no_exceptions",
-        "single_return_with_guard_clauses",
-        "free_return_style"
-      ]
+      "enum": ["single_return_strict_no_exceptions", "single_return_with_guard_clauses", "free_return_style"]
     },
     "class_design": {
       "type": "string",
@@ -87,8 +83,8 @@
     },
     "comment_section_blocks": {
       "type": "array",
-      "minItems": 13,
-      "maxItems": 13,
+      "minItems": 15,
+      "maxItems": 15,
       "items": {
         "type": "string",
         "enum": [
@@ -97,12 +93,14 @@
           "consts",
           "types",
           "private:attributes",
+          "protected:attributes",
           "private:properties",
           "public:properties",
           "constructor",
           "static:properties",
           "factory",
           "private:methods",
+          "protected:methods",
           "public:methods",
           "static:methods"
         ]
@@ -113,12 +111,14 @@
         "consts",
         "types",
         "private:attributes",
+        "protected:attributes",
         "private:properties",
         "public:properties",
         "constructor",
         "static:properties",
         "factory",
         "private:methods",
+        "protected:methods",
         "public:methods",
         "static:methods"
       ]

package/resources/ai/templates/examples/demo/src/billing/billing-service.ts

@@ -8,6 +8,7 @@
  * @section imports:internals
  */
 
+import { BILLING_CURRENCY_SYMBOL, STATUS_SERVICE_URL } from "../config.js";
 import type { InvoiceService } from "../invoices/invoice-service.js";
 import type { InvoiceSummary } from "../invoices/invoice-types.js";
 
@@ -15,7 +16,7 @@ import type { InvoiceSummary } from "../invoices/invoice-types.js";
  * @section consts
  */
 
-const CURRENCY_SYMBOL = "$";
+// empty
 
 /**
  * @section types
@@ -26,6 +27,7 @@ export type BillingSnapshot = {
   invoiceCount: number;
   totalAmount: number;
   formattedTotal: string;
+  statusServiceUrl: string;
 };
 
 export class BillingService {
@@ -35,6 +37,12 @@ export class BillingService {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -75,10 +83,16 @@ export class BillingService {
    */
 
   private formatCurrency(amount: number): string {
-    const formattedAmount = `${CURRENCY_SYMBOL}${amount.toFixed(2)}`;
+    const formattedAmount = `${BILLING_CURRENCY_SYMBOL}${amount.toFixed(2)}`;
     return formattedAmount;
   }
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */
@@ -89,7 +103,8 @@ export class BillingService {
       customerId,
       invoiceCount: summary.count,
       totalAmount: summary.totalAmount,
-      formattedTotal: this.formatCurrency(summary.totalAmount)
+      formattedTotal: this.formatCurrency(summary.totalAmount),
+      statusServiceUrl: STATUS_SERVICE_URL
     };
     return snapshot;
   }

package/resources/ai/templates/examples/demo/src/config.ts

@@ -0,0 +1,3 @@
+export const MINIMUM_INVOICE_AMOUNT = 0;
+export const BILLING_CURRENCY_SYMBOL = "$";
+export const STATUS_SERVICE_URL = "https://status.example.com/health";

package/resources/ai/templates/examples/demo/src/invoices/invoice-errors.ts

@@ -29,6 +29,12 @@ export class InvalidInvoiceCommandError extends Error {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -72,6 +78,12 @@ export class InvalidInvoiceCommandError extends Error {
 
   // empty
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

package/resources/ai/templates/examples/demo/src/invoices/invoice-service.ts

@@ -8,6 +8,7 @@ import { randomUUID } from "node:crypto";
  * @section imports:internals
  */
 
+import { MINIMUM_INVOICE_AMOUNT } from "../config.js";
 import { InvalidInvoiceCommandError } from "./invoice-errors.js";
 import type { CreateInvoiceCommand, Invoice, InvoiceSummary } from "./invoice-types.js";
 
@@ -15,7 +16,7 @@ import type { CreateInvoiceCommand, Invoice, InvoiceSummary } from "./invoice-ty
  * @section consts
  */
 
-const MINIMUM_INVOICE_AMOUNT = 0;
+// empty
 
 /**
  * @section types
@@ -30,6 +31,12 @@ export class InvoiceService {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -89,6 +96,12 @@ export class InvoiceService {
     return invoice;
   }
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

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

@@ -33,6 +33,12 @@ export class InvoiceSyncService {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -76,6 +82,12 @@ export class InvoiceSyncService {
 
   // empty
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

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

@@ -33,6 +33,12 @@ export class InvoiceSyncService {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -76,6 +82,12 @@ export class InvoiceSyncService {
 
   // empty
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

package/resources/ai/templates/examples/rules/class-first-bad.ts

@@ -30,6 +30,12 @@ export class InvoiceService {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -69,6 +75,12 @@ export class InvoiceService {
 
   // empty
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

package/resources/ai/templates/examples/rules/class-first-good.ts

@@ -30,6 +30,12 @@ export class InvoiceService {
 
   private readonly requestId: string;
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -81,6 +87,12 @@ export class InvoiceService {
     return invoice;
   }
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

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

@@ -30,6 +30,12 @@ export class InvoiceIdBuilder {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -79,6 +85,12 @@ export class InvoiceIdBuilder {
     return year;
   }
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

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

@@ -30,6 +30,12 @@ export class InvoiceIdBuilder {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -78,6 +84,12 @@ export class InvoiceIdBuilder {
     return year;
   }
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

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

@@ -29,6 +29,12 @@ export class ControlFlowPolicy {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -68,6 +74,12 @@ export class ControlFlowPolicy {
 
   // empty
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

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

@@ -29,6 +29,12 @@ export class FeatureGate {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -70,6 +76,12 @@ export class FeatureGate {
 
   // empty
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

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

@@ -29,6 +29,12 @@ export class InvoiceLookup {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -68,6 +74,12 @@ export class InvoiceLookup {
 
   // empty
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

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

@@ -29,6 +29,12 @@ export class InvoiceNotFoundError extends Error {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -72,6 +78,12 @@ export class InvoiceNotFoundError extends Error {
 
   // empty
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

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

@@ -30,6 +30,12 @@ export class PaymentNormalizer {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -69,6 +75,12 @@ export class PaymentNormalizer {
 
   // empty
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

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

@@ -30,6 +30,12 @@ export class PaymentNormalizer {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -82,6 +88,12 @@ export class PaymentNormalizer {
     return sanitizedMetadata;
   }
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

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

@@ -29,6 +29,12 @@ export class InvoiceStatusPresenter {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -68,6 +74,12 @@ export class InvoiceStatusPresenter {
 
   // empty
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

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

@@ -29,6 +29,12 @@ export class InvoiceStatusPresenter {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -68,6 +74,12 @@ export class InvoiceStatusPresenter {
 
   // empty
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

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

@@ -29,6 +29,12 @@ export class InvoiceEscalationPolicy {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -68,6 +74,12 @@ export class InvoiceEscalationPolicy {
 
   // empty
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

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

@@ -30,6 +30,12 @@ export class InvoiceEscalationPolicy {
 
   // empty
 
+  /**
+   * @section protected:attributes
+   */
+
+  // empty
+
   /**
    * @section private:properties
    */
@@ -73,6 +79,12 @@ export class InvoiceEscalationPolicy {
     return dayCount;
   }
 
+  /**
+   * @section protected:methods
+   */
+
+  // empty
+
   /**
    * @section public:methods
    */

package/resources/ai/templates/rules/architecture.md

@@ -3,9 +3,11 @@
 - Code MUST be organized by feature (for example: `src/users`, `src/billing`, `src/invoices`).
 - Each feature MUST keep its own domain model, application services, and infrastructure adapters grouped by feature.
 - Cross-feature imports MUST happen through explicit public entry points.
+- Hardcoded, non-parameterized configuration MUST be centralized in `src/config.ts` (for example, external service URLs).
 
 Good example:
 
+- `ai/examples/demo/src/config.ts`
 - `ai/examples/demo/src/invoices/invoice-service.ts`
 - `ai/examples/demo/src/invoices/invoice-errors.ts`
 - `ai/examples/demo/src/invoices/invoice-types.ts`

package/resources/ai/templates/rules/class-first.md

@@ -14,12 +14,14 @@
   - `consts`
   - `types`
   - `private:attributes`
+  - `protected:attributes`
   - `private:properties`
   - `public:properties`
   - `constructor`
   - `static:properties`
   - `factory`
   - `private:methods`
+  - `protected:methods`
   - `public:methods`
   - `static:methods`
 - All section blocks MUST exist even when empty, using `// empty` after the section marker.

package/resources/ai/templates/rules/functions.md

@@ -6,6 +6,8 @@
 - Types MUST be preferred over interfaces for local modeling unless a public contract requires an interface.
 - New implementation and test files MUST be `.ts`.
 - JavaScript source files (`.js`, `.mjs`, `.cjs`) are not allowed in `src/` or `test/`.
+- If a declaration/expression fits in one line within 160 chars, it MUST stay on one line.
+- If a function/method needs many inputs, define a named `<FunctionName>Options` type and pass one `options` parameter.
 
 Good example: