@sha3/code-standards 0.1.5 → 0.1.6

package/README.md

@@ -1,6 +1,6 @@
 <div align="center">
 
-# @sha3/code-standards
+# 📏 @sha3/code-standards
 
 **Scaffold TypeScript projects + enforce how AI writes code.**
 
@@ -117,10 +117,13 @@ After `init`, your new repo contains:
 - `ai/examples/rules/*.ts` (good/bad examples per rule)
 - `ai/examples/demo/src/*` (feature-folder demo with classes and section blocks)
 - `src/config.ts` for centralized hardcoded configuration values
+- `README.md` generated with an icon emoji in the main header
 - `.gitignore` preconfigured for Node/TypeScript output
 - lint/format/typecheck/test-ready project template
 - `package.json.codeStandards` metadata used by `refresh` (`template`, `profilePath`, `withAiAdapters`, `lastRefreshWith`)
 
+`config.ts` convention: export a single default object and import it as `import CONFIG from "./config.js"`.
+
 That means the next step is **not** configuring tools. The next step is telling your assistant to obey `AGENTS.md` before coding.
 
 Generated project code is TypeScript-only: implementation and tests live in `.ts` files.

package/bin/code-standards.mjs

@@ -537,8 +537,10 @@ function getRelativeProfilePath(profilePath, targetPath) {
   const resolvedProfilePath = path.resolve(targetPath, profilePath);
   const relativePath = path.relative(targetPath, resolvedProfilePath);
 
+  // If the profile is outside the project directory, return null instead of absolute path
+  // to avoid storing machine-specific paths in package.json
   if (relativePath.startsWith("..") || path.isAbsolute(relativePath)) {
-    return resolvedProfilePath;
+    return null;
   }
 
   return relativePath;

package/package.json

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

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

@@ -8,7 +8,7 @@
  * @section imports:internals
  */
 
-import { BILLING_CURRENCY_SYMBOL, STATUS_SERVICE_URL } from "../config.js";
+import CONFIG from "../config.js";
 import type { InvoiceService } from "../invoices/invoice-service.js";
 import type { InvoiceSummary } from "../invoices/invoice-types.js";
 
@@ -83,7 +83,7 @@ export class BillingService {
    */
 
   private formatCurrency(amount: number): string {
-    const formattedAmount = `${BILLING_CURRENCY_SYMBOL}${amount.toFixed(2)}`;
+    const formattedAmount = `${CONFIG.BILLING_CURRENCY_SYMBOL}${amount.toFixed(2)}`;
     return formattedAmount;
   }
 
@@ -104,7 +104,7 @@ export class BillingService {
       invoiceCount: summary.count,
       totalAmount: summary.totalAmount,
       formattedTotal: this.formatCurrency(summary.totalAmount),
-      statusServiceUrl: STATUS_SERVICE_URL
+      statusServiceUrl: CONFIG.STATUS_SERVICE_URL
     };
     return snapshot;
   }

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

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

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

@@ -8,7 +8,7 @@ import { randomUUID } from "node:crypto";
  * @section imports:internals
  */
 
-import { MINIMUM_INVOICE_AMOUNT } from "../config.js";
+import CONFIG from "../config.js";
 import { InvalidInvoiceCommandError } from "./invoice-errors.js";
 import type { CreateInvoiceCommand, Invoice, InvoiceSummary } from "./invoice-types.js";
 
@@ -81,7 +81,7 @@ export class InvoiceService {
       throw InvalidInvoiceCommandError.forReason("customerId is required");
     }
 
-    if (command.amount <= MINIMUM_INVOICE_AMOUNT) {
+    if (command.amount <= CONFIG.MINIMUM_INVOICE_AMOUNT) {
       throw InvalidInvoiceCommandError.forReason("amount must be greater than zero");
     }
   }

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

@@ -4,6 +4,7 @@
 - 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).
+- `src/config.ts` MUST export a single default object and it MUST always be imported as `import CONFIG from ".../config.js"`.
 
 Good example:
 

package/standards/architecture.md

@@ -23,3 +23,4 @@ Both templates SHOULD keep this baseline structure:
 - Keep feature modules cohesive.
 - Avoid cyclic dependencies.
 - Keep hardcoded application configuration centralized in `src/config.ts`.
+- `src/config.ts` MUST export a default object (for example `CONFIG`) and consumers MUST import it as `import CONFIG from "./config.js"`.

package/standards/style.md

@@ -20,6 +20,7 @@ All code MUST follow the canonical rules in `standards/manifest.json`.
 - Use type-only imports when possible.
 - If a function/method needs many inputs, define a named `<FunctionName>Options` type and pass a single `options` parameter.
 - Always use braces in control flow (`if`, `else`, `for`, `while`, `do`).
+- `src/config.ts` MUST export a default object and it MUST always be imported as `import CONFIG from ".../config.js"`.
 
 ## Naming
 

package/templates/node-lib/README.md

@@ -0,0 +1,37 @@
+# 📚 {{packageName}}
+
+Libreria TypeScript lista para publicar y reutilizar.
+
+## TL;DR
+
+```bash
+npm install
+npm run check
+npm run build
+```
+
+## Uso
+
+```ts
+import { greet } from "./dist/index.js";
+
+console.log(greet("world"));
+```
+
+## Scripts
+
+- `npm run check`: lint + format check + typecheck + tests
+- `npm run fix`: aplica autofix de lint y prettier
+- `npm run build`: compila a `dist/`
+- `npm run test`: ejecuta tests con Node test runner
+
+## Estructura
+
+- `src/`: implementacion
+- `src/config.ts`: configuracion hardcodeada centralizada
+- `test/`: pruebas
+- `dist/`: salida de build
+
+## AI Workflow
+
+Si trabajas con asistentes, usa `AGENTS.md` y `ai/*.md` como reglas bloqueantes.

package/templates/node-lib/src/config.ts

@@ -1 +1,5 @@
-export const GREETING_PREFIX = "Hello";
+const CONFIG = {
+  GREETING_PREFIX: "Hello"
+} as const;
+
+export default CONFIG;

package/templates/node-lib/src/index.ts

@@ -1,5 +1,5 @@
-import { GREETING_PREFIX } from "./config.js";
+import CONFIG from "./config.js";
 
 export function greet(name: string): string {
-  return `${GREETING_PREFIX}, ${name}`;
+  return `${CONFIG.GREETING_PREFIX}, ${name}`;
 }

package/templates/node-service/README.md

@@ -0,0 +1,36 @@
+# 🚀 {{packageName}}
+
+Servicio TypeScript listo para ejecutar en local y evolucionar por features.
+
+## TL;DR
+
+```bash
+npm install
+npm run check
+npm run start
+```
+
+## Ejecucion
+
+```bash
+npm run start
+```
+
+El servicio arranca por defecto en `http://localhost:3000`.
+
+## Scripts
+
+- `npm run start`: inicia el servicio con `tsx`
+- `npm run check`: lint + format check + typecheck + tests
+- `npm run fix`: aplica autofix de lint y prettier
+- `npm run test`: ejecuta tests con Node test runner
+
+## Estructura
+
+- `src/`: implementacion
+- `src/config.ts`: configuracion hardcodeada centralizada
+- `test/`: pruebas
+
+## AI Workflow
+
+Si trabajas con asistentes, usa `AGENTS.md` y `ai/*.md` como reglas bloqueantes.

package/templates/node-service/src/config.ts

@@ -1,3 +1,7 @@
-export const RESPONSE_CONTENT_TYPE = "application/json";
-export const DEFAULT_PORT = 3000;
-export const EXTERNAL_STATUS_URL = "https://status.example.com/health";
+const CONFIG = {
+  RESPONSE_CONTENT_TYPE: "application/json",
+  DEFAULT_PORT: 3000,
+  EXTERNAL_STATUS_URL: "https://status.example.com/health"
+} as const;
+
+export default CONFIG;

package/templates/node-service/src/index.ts

@@ -1,16 +1,16 @@
 import { createServer } from "node:http";
-import { DEFAULT_PORT, EXTERNAL_STATUS_URL, RESPONSE_CONTENT_TYPE } from "./config.js";
+import CONFIG from "./config.js";
 
 export function buildServer() {
   return createServer((_, response) => {
     response.statusCode = 200;
-    response.setHeader("content-type", RESPONSE_CONTENT_TYPE);
-    response.end(JSON.stringify({ ok: true, statusSource: EXTERNAL_STATUS_URL }));
+    response.setHeader("content-type", CONFIG.RESPONSE_CONTENT_TYPE);
+    response.end(JSON.stringify({ ok: true, statusSource: CONFIG.EXTERNAL_STATUS_URL }));
   });
 }
 
 if (process.env.NODE_ENV !== "test") {
-  const port = Number(process.env.PORT ?? String(DEFAULT_PORT));
+  const port = Number(process.env.PORT ?? String(CONFIG.DEFAULT_PORT));
   const server = buildServer();
   server.listen(port, () => {
     console.log(`service listening on http://localhost:${port}`);