Merge pull request #30 from Errec/codex/list-tasks-for-project-improvement-r3tcdd Codex-generated pull request

.changeset/config.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
+  "changelog": [
+    "@changesets/changelog-github",
+    {
+      "repo": "owner/web-learning-kit-generator"
+    }
+  ],
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.editorconfig

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

.env.example

@@ -0,0 +1,5 @@
+# Set to true to automatically open BrowserSync in the default browser
+BROWSERSYNC_OPEN=false
+
+# Set to true to skip imagemin optimization in the images task
+SKIP_IMAGE_OPTIMIZATION=false

.github/pull_request_template.md

@@ -0,0 +1,15 @@
+## Summary
+- What changed?
+- Why was this needed?
+
+## Validation
+- [ ] `npm run typecheck`
+- [ ] `npm test`
+- [ ] `npm run lint` (if available in environment)
+
+## Generated project impact
+- [ ] No generated output behavior changes
+- [ ] Generated output behavior changed (describe below)
+
+## Notes
+Include any migration or follow-up notes here.

.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+    branches: ["main", "master"]
+  pull_request:
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Use Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Typecheck
+        run: npm run typecheck
+
+      - name: Tests
+        run: npm test

.gitignore

@@ -1,40 +1,8 @@
 node_modules/
-yarn-error.log
-yarn.lock
-package-lock.json
-npm-debug.log
-
-.DS_Store
+dist/
+src/
+coverage/
+.nyc_output/
+*.log
 .env
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-.pnp
-.pnp.js
-.pnp.cjs
-*.pnp.js
-*.pnp.cjs
-.cache/
-
-build/
-temp/
-*.gitignore
-.vscode
-
-# cache files for sublime text
-*.tmlanguage.cache
-*.tmPreferences.cache
-*.stTheme.cache
-
-# sftp configuration file
-sftp-config.json
-
-# Package control specific files
-Package Control.last-run
-Package Control.ca-list
-Package Control.ca-bundle
-Package Control.system-ca-bundle
-Package Control.cache/
-Package Control.ca-certs/
-bh_unicode_properties.cache
+.DS_Store

.nvmrc

@@ -0,0 +1 @@
+20

CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing
+
+Thanks for your interest in improving Web Learning Kit Generator.
+
+## Development setup
+
+1. Install dependencies:
+   - `npm install`
+2. Run checks:
+   - `npm run typecheck`
+   - `npm test`
+3. Run the interactive generator:
+   - `npm run init`
+
+## Test strategy
+
+- **Unit tests**: validate individual modules (path resolution, setup option parsing, validators).
+- **Template tests**: verify section behavior and snapshot generated gulpfile variants.
+- **Integration tests**: scaffold in a temp directory and validate expected output tree/content.
+
+## Acceptance criteria for changes
+
+A change is ready to merge when all of the following are true:
+
+- Behavior changes are covered by tests (unit/integration/snapshot as appropriate).
+- `npm run typecheck` passes.
+- `npm test` passes.
+- Docs are updated for any user-facing command or setup-flow change.
+- PR notes describe generated-project behavior changes (if any).
+
+## Contribution guidelines
+
+- Keep changes small and focused.
+- Prefer TypeScript-safe updates.
+- Add or update tests when behavior changes.
+- Update README/docs when UX or command flow changes.
+
+## Commit and PR guidance
+
+- Use clear, imperative commit messages.
+- Include a short summary of what changed and why.
+- Mention any behavior changes for generated projects.