@sha3/code-standards 0.1.3 → 0.1.5

package/standards/architecture.md

@@ -14,6 +14,7 @@ Two templates are supported:
 Both templates SHOULD keep this baseline structure:
 
 - `src/` for implementation.
+- `src/config.ts` for non-parameterized hardcoded configuration values.
 - `test/` for automated tests.
 - Root tooling config files (`eslint`, `prettier`, `tsconfig`) at project root.
 
@@ -21,4 +22,4 @@ Both templates SHOULD keep this baseline structure:
 
 - Keep feature modules cohesive.
 - Avoid cyclic dependencies.
-- Keep configuration centralized at project root.
+- Keep hardcoded application configuration centralized in `src/config.ts`.

package/standards/manifest.json

@@ -12,7 +12,7 @@
   },
   "formatting": {
     "prettier": true,
-    "lineLength": 100,
+    "lineLength": 160,
     "semi": true,
     "singleQuote": false
   },

package/standards/schema.json

@@ -4,16 +4,7 @@
   "title": "Code Standards Manifest",
   "type": "object",
   "additionalProperties": false,
-  "required": [
-    "meta",
-    "language",
-    "formatting",
-    "naming",
-    "architecture",
-    "testing",
-    "tooling",
-    "ai"
-  ],
+  "required": ["meta", "language", "formatting", "naming", "architecture", "testing", "tooling", "ai"],
   "properties": {
     "meta": {
       "type": "object",
@@ -42,7 +33,7 @@
       "required": ["prettier", "lineLength", "semi", "singleQuote"],
       "properties": {
         "prettier": { "type": "boolean" },
-        "lineLength": { "type": "integer", "minimum": 80, "maximum": 140 },
+        "lineLength": { "type": "integer", "minimum": 80, "maximum": 200 },
         "semi": { "type": "boolean" },
         "singleQuote": { "type": "boolean" }
       }

package/standards/style.md

@@ -5,7 +5,8 @@ All code MUST follow the canonical rules in `standards/manifest.json`.
 ## Formatting
 
 - Use Prettier for formatting.
-- Use a max line length of 100.
+- Use a max line length of 160.
+- Keep lines as compact as possible: if a declaration/expression fits in one line within 160 chars, keep it on one line.
 - Use semicolons.
 - Use double quotes for strings.
 
@@ -17,6 +18,7 @@ All code MUST follow the canonical rules in `standards/manifest.json`.
 - Avoid `any` unless there is no viable alternative.
 - Prefer explicit return types for exported functions.
 - 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`).
 
 ## Naming
@@ -42,14 +44,16 @@ Required block names:
 3. `consts`
 4. `types`
 5. `private:attributes`
-6. `private:properties`
-7. `public:properties`
-8. `constructor`
-9. `static:properties`
-10. `factory`
-11. `private:methods`
-12. `public:methods`
-13. `static:methods`
+6. `protected:attributes`
+7. `private:properties`
+8. `public:properties`
+9. `constructor`
+10. `static:properties`
+11. `factory`
+12. `private:methods`
+13. `protected:methods`
+14. `public:methods`
+15. `static:methods`
 
 All section blocks MUST be present even when empty. Empty sections MUST include:
 

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

@@ -0,0 +1 @@
+export const GREETING_PREFIX = "Hello";

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

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

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

@@ -0,0 +1,3 @@
+export const RESPONSE_CONTENT_TYPE = "application/json";
+export const DEFAULT_PORT = 3000;
+export const EXTERNAL_STATUS_URL = "https://status.example.com/health";

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

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

package/templates/node-service/test/smoke.test.ts

@@ -22,7 +22,7 @@ test("service responds with ok payload", async () => {
   const json = await response.json();
 
   assert.equal(response.status, 200);
-  assert.deepEqual(json, { ok: true });
+  assert.deepEqual(json, { ok: true, statusSource: "https://status.example.com/health" });
 
   await new Promise<void>((resolve, reject) => {
     server.close((error) => {