@sha3/code-standards 0.1.3 → 0.1.5

package/README.md

@@ -21,6 +21,12 @@ If you just want to start now:
 npx @sha3/code-standards init --template node-service --yes
 ```
 
+If your project was already scaffolded and you updated this package:
+
+```bash
+npx @sha3/code-standards refresh
+```
+
 Then in your AI chat, paste this:
 
 ```txt
@@ -53,12 +59,14 @@ Default generated contract includes structural class/file blocks such as:
 - `consts`
 - `types`
 - `private:attributes`
+- `protected:attributes`
 - `private:properties`
 - `public:properties`
 - `constructor`
 - `static:properties`
 - `factory`
 - `private:methods`
+- `protected:methods`
 - `public:methods`
 - `static:methods`
 
@@ -72,6 +80,7 @@ All blocks MUST exist even when empty (`// empty`).
 
 Additional blocking defaults:
 
+- Max line length is 160 chars, and lines should stay on one line when they fit.
 - `if`/`else`/loop statements MUST always use braces.
 - README updates MUST follow a top-tier quality standard (see `standards/readme.md`).
 
@@ -107,8 +116,10 @@ After `init`, your new repo contains:
 - `ai/codex.md`, `ai/cursor.md`, `ai/copilot.md`, `ai/windsurf.md`
 - `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
 - `.gitignore` preconfigured for Node/TypeScript output
 - lint/format/typecheck/test-ready project template
+- `package.json.codeStandards` metadata used by `refresh` (`template`, `profilePath`, `withAiAdapters`, `lastRefreshWith`)
 
 That means the next step is **not** configuring tools. The next step is telling your assistant to obey `AGENTS.md` before coding.
 
@@ -120,6 +131,7 @@ Generated project code is TypeScript-only: implementation and tests live in `.ts
 
 Demo structure generated by default:
 
+- `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`
@@ -265,6 +277,22 @@ npm run check
 
 Then use the prompts above in your AI tool.
 
+### 4) Sync updates from `@sha3/code-standards`
+
+Run this inside an already scaffolded project:
+
+```bash
+npx @sha3/code-standards refresh
+```
+
+`refresh` default behavior:
+
+- scope `Managed + AI` (template files + `AGENTS.md` + `ai/*` + `ai/examples/*`)
+- overwrite conflicts
+- auto-detect template (or force with `--template`)
+- selective merge for `package.json` (managed scripts/devDependencies updated, custom keys preserved)
+- no dependency install unless `--install`
+
 ---
 
 ## CLI Reference
@@ -274,6 +302,8 @@ code-standards <command> [options]
 
 Commands:
   init                  Initialize a project in the current directory
+  refresh               Re-apply managed standards files and AI instructions
+  update                Alias of refresh
   profile               Create or update the AI style profile
 ```
 
@@ -290,6 +320,18 @@ An existing `.git/` directory is allowed without `--force`.
 - `--no-ai-adapters`
 - `--profile <path>`
 
+### `refresh` options
+
+`refresh` always uses the current working directory as target.
+
+- `--template <node-lib|node-service>`
+- `--profile <path>`
+- `--with-ai-adapters`
+- `--no-ai-adapters`
+- `--dry-run`
+- `--install`
+- `--yes`
+
 ### `profile` options
 
 - `--profile <path>`