Merge pull request #1 from karmaniverous/feature/component-scaffold

Feature/component scaffold

Author: karmaniverous

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2

.gitattributes

@@ -0,0 +1,6 @@
+# Normalize text files to LF in the repo regardless of platform
+* text=auto eol=lf
+
+# Optional: allow CRLF where required on Windows scripts
+*.bat text eol=crlf
+*.cmd text eol=crlf

.gitignore

@@ -7,7 +7,6 @@ coverage/
 dist/
 esm/
 node_modules/
-context/
 .stan/output/
 .stan/diff/
 .stan/dist/

.lefthook/pre-commit/branch-naming-policy

@@ -1,4 +1,6 @@
 {
-  "endOfLine": "crlf",
+  "embeddedLanguageFormatting": "auto",
+  "endOfLine": "lf",
+  "proseWrap": "never",
   "singleQuote": true
 }

.lefthook/prepare-commit-msg/add-issue

@@ -1,3 +1,3 @@
 {
-  "version": "0.4.0"
+  "version": "0.5.6"
 }

.prettierrc.json

@@ -0,0 +1,49 @@
+# stan.project.md — Project-specific requirements
+
+When updated: 2025-08-29T00:00:00Z
+
+Repository goal
+
+- Provide a ready-to-use template for building and publishing React 18 component libraries using TypeScript.
+
+Baseline decisions
+
+- React
+  - Target React 18.
+  - Use the modern “react-jsx” runtime.
+- Build outputs
+  - ESM-only. No CJS or IIFE bundles.
+  - ship types (.d.ts).
+- Dependencies
+  - react and react-dom are peerDependencies (>=18).
+  - Also present as devDependencies for local development and playground.
+  - Mark package as "sideEffects": false (no global CSS side-effects).
+- Linting
+  - TS-only rules; no react-specific eslint plugins for now.
+  - Playground IS included in lint/Prettier scope (treat as first-class source). Exclude only generated output: dist/, docs/, coverage/, .rollup.cache/, .stan/, context/, diagrams/out/.
+  - Flat config in eslint.config.ts (TypeScript), executed via `node --loader tsx` in npm scripts.
+  - Windows: set ESLint languageOptions.parserOptions.tsconfigRootDir to path.resolve() to avoid a known typescript-eslint path bug affecting tsconfigRootDir resolution on Windows.
+  - Limit lint to non-generated code; exclude dist/, docs/, coverage/, .rollup.cache/, .stan/, context/, and diagrams/out/.
+  - Line endings (cross-platform): enforce LF-only in the repo via .gitattributes, .editorconfig, and Prettier (endOfLine: "lf"). If CRLF noise appears locally, normalize once: • git add --renormalize . • npm run lint:fix Editors with Prettier on save should keep files normalized.
+  - Tests linted with Vitest recommended rules (non type-checked).
+- Testing
+  - Vitest with happy-dom environment (project default).
+  - @testing-library/react and @testing-library/jest-dom for component tests.
+  - jest-dom is registered via vitest.setup.ts.
+- Dev preview
+  - Vite playground under /playground for interactive browser viewing.
+  - Playground is excluded from npm package (files: ["dist"]) and from typecheck.
+- Source layout
+  - Components under src/components.
+  - Public entry at src/index.ts re-exports components.
+- Removed legacy pieces
+  - CLI example and related build logic removed.
+  - No IIFE browser bundle.
+- Docs
+  - Keep TypeDoc for API docs; entry remains src/index.ts.
+
+Operational notes
+
+- Rollup marks react and react/jsx-runtime as externals.
+- Keep release and docs scripts; they may be adjusted later as needed.
+- Consider adding Storybook or Ladle later if richer docs are required.

.stan/system/.docs.meta.json

@@ -0,0 +1,37 @@
+When updated: 2025-08-31T00:28:00Z
+
+Next up
+
+- Run: npm install to ensure new devDependencies (react, react-dom, @types/react, @types/react-dom, vite, @vitejs/plugin-react, @testing-library/\*, tsx) are installed before running test/docs/typecheck.
+- Optionally add story tooling (Storybook or Ladle) if docs scale up.
+- Consider pruning unused devDependencies flagged by knip.
+- Re-run: npm run lint to confirm the Windows tseslint parser fix.
+- Normalize line endings to LF if you see CRLF noise: • git add --renormalize . • npm run lint:fix • commit the normalization
+- Verify lint includes /playground and excludes only generated output.
+
+Completed (recent)
+
+- Deduped ESLint config: shared Prettier/import-sort for JS/TS; kept TS-specific rules; expanded Vitest test globs to include JS.
+- Fixed ESLint parser error on Windows by setting parserOptions.tsconfigRootDir = path.resolve() in eslint.config.ts.
+- Clarified lint/format policy: include /playground; exclude generated outputs; rely on editor Prettier (no new Lefthook script).
+- Added tests for library entry re-exports and HelloWorld edge cases.
+- Tuned Vitest coverage to exclude docs/, dist/, and playground/ by default.
+- Updated README test section with entry re-export example and coverage notes.
+- Updated README to reflect React component template usage and features.
+- Replaced eslint.config.js with eslint.config.ts (flat config), updated npm scripts to run ESLint via node --loader tsx.
+- Scoped linting to avoid type-aware parse errors; ignore playground; tests use Vitest recommended rules (non type-checked).
+- Excluded tests and playground from ts typecheck; removed jest-dom types from tsconfig to prevent build/docs errors if not installed.
+- Excluded .rollup.cache from Vitest to avoid stale compiled tests.
+- Excluded playground from lint/typecheck to reduce false positives.
+- Added vitest.setup.ts and configured jest-dom globally.
+- Fixed unsafe return by typing HelloWorld return to JSX.Element.
+- Sorted imports and simplified tests.
+- Updated stan.config.yml to use standard build script.
+- Converted template to React 18 with react-jsx runtime.
+- Switched to ESM-only build; removed CJS/IIFE and CLI scaffold.
+- Added Vite playground under /playground for browser preview.
+- Added HelloWorld component + tests (Testing Library).
+- Marked react/react-dom as peerDependencies; set sideEffects: false.
+- Updated rollup config to externalize react & react/jsx-runtime.
+- Kept TypeDoc; preserved Vitest + happy-dom environment.
+- Updated package/repository metadata placeholders.