feat(setup): add setup script and configuration for project initialization

ccpu · ccpu · commit 67b0a91ba3ad · 2025-10-27T21:29:58.000Z
* Introduced a setup script in `package.json` to streamline project setup.
* Added `scaffoldfy.json` for project scaffolding tasks.
* Created a template for a clean README to standardize new project documentation.
* Updated CONTRIBUTING.md to include guidelines for contributions and code of conduct.
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
diff --git a/.github/copilot/commit-message-style.md b/.github/copilot/commit-message-style.md
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,45 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others’ private information, such as a physical or email address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT EMAIL]. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
+
+[homepage]: https://www.contributor-covenant.org
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,44 @@
+# Contributing to chrome-extension-monorepo-template
+
+Thank you for your interest in contributing! 🎉
+
+We welcome all contributions, including bug reports, feature requests, documentation improvements, and code changes.
+
+---
+
+## How to Contribute
+
+1. **Fork the repository** and create your branch from `main`.
+2. **Make your changes** with clear, concise commits. Follow the [conventional commit spec](https://www.conventionalcommits.org/en/v1.0.0/).
+3. **Add or update tests** to cover your changes.
+4. **Run lint and tests** to ensure code quality:
+
+   ```bash
+   pnpm run lint
+   pnpm run test
+   ```
+
+5. **Update documentation** if your change affects usage or public APIs.
+6. **Open a pull request** using the provided template. Be sure to:
+   - Clearly describe your change and why it is needed.
+   - Link to any related issues (e.g., `Fixes #123`).
+   - Check all items in the pull-request checklist:
+     - [ ] Code is up-to-date with the `main` branch
+     - [ ] `pnpm run lint` passes with this change
+     - [ ] `pnpm run test` passes with this change
+     - [ ] This pull request links relevant issues as `Fixes #0000`
+     - [ ] There are new or updated unit tests validating the change
+     - [ ] Documentation has been updated to reflect this change
+     - [ ] The new commits follow conventions outlined in the [conventional commit spec](https://www.conventionalcommits.org/en/v1.0.0/)
+
+---
+
+## Code of Conduct
+
+This project follows a [Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+---
+
+## Questions?
+
+If you have questions, open an issue or start a discussion. Thank you for helping make this project better!
diff --git a/README.md b/README.md
@@ -16,6 +16,14 @@ publishing, and versioning guidance.
 If you are new, there's also a simpler introduction in the
 [Hello world TypeScript action repository](https://github.com/actions/hello-world-javascript-action).
 
+## 🚀 Getting Started
+
+Run setup after cloning:
+
+```sh
+pnpm run setup
+```
+
 ## Create Your Own Action
 
 To create your own action, you can use this repository as a template! Just
diff --git a/package.json b/package.json
@@ -26,6 +26,7 @@
     "node": ">=20"
   },
   "scripts": {
+    "setup": "npx @pixpilot/scaffoldfy --config ./setup/scaffoldfy.json",
     "bundle": "pnpm run format:write && pnpm run build",
     "build": "node esbuild.config.cjs",
     "ci-test": "cross-env NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 npx vitest --run",
diff --git a/setup/scaffoldfy.json b/setup/scaffoldfy.json
@@ -0,0 +1,69 @@
+{
+  "$schema": "https://unpkg.com/@pixpilot/scaffoldfy@latest/schema/scaffoldfy.schema.json",
+  "extends": [
+    "https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/project-info/scaffoldfy.json",
+    "https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/pixpilot-info/scaffoldfy.json",
+    "https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/turbo-workspace-package-generator/scaffoldfy.json",
+    "https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/license-file/scaffoldfy.json",
+    "https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/update-root-package-json/scaffoldfy.json",
+    "https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/pixpilot-copilot-instructions/scaffoldfy.json"
+  ],
+  "name": "chrome-extension-monorepo-template-setup",
+  "tasks": [
+    {
+      "id": "clean-readme",
+      "name": "Clean README",
+      "description": "Create a fresh README for the new project",
+      "type": "write",
+      "config": {
+        "file": "README.md",
+        "templateFile": "./templates/clean-readme.md"
+      }
+    },
+    {
+      "id": "update-contributing",
+      "name": "Update CONTRIBUTING.md",
+      "description": "Update contributing guidelines with project info",
+      "type": "replace-in-file",
+      "config": {
+        "file": "CONTRIBUTING.md",
+        "replacements": [
+          {
+            "find": "chrome-extension-monorepo-template",
+            "replace": "{{repoName}}"
+          }
+        ]
+      }
+    },
+    {
+      "id": "remove-setup-script",
+      "name": "Remove setup script",
+      "description": "Remove the setup script from package.json after setup is complete",
+      "type": "regex-replace",
+      "config": {
+        "file": "package.json",
+        "pattern": "\\n\\s*\"setup\":\\s*\"npx @pixpilot/scaffoldfy --config \\./setup/scaffoldfy\\.json\",",
+        "flags": "",
+        "replacement": ""
+      }
+    },
+    {
+      "id": "delete-setup-tasks",
+      "name": "Delete setup tasks file",
+      "description": "Remove the setup-tasks.json file after setup is complete",
+      "type": "delete",
+      "config": {
+        "paths": ["setup"]
+      }
+    },
+    {
+      "id": "install-dependencies",
+      "name": "Install dependencies",
+      "description": "Install dependencies after cleanup",
+      "type": "exec",
+      "config": {
+        "command": "pnpm install"
+      }
+    }
+  ]
+}
diff --git a/setup/templates/clean-readme.md b/setup/templates/clean-readme.md
@@ -0,0 +1,46 @@
+# {{repoName}}
+
+> A modern TypeScript monorepo managed with pnpm and TurboRepo.
+
+## 🚀 Getting Started
+
+### Development
+
+Build all packages:
+
+```sh
+pnpm build
+```
+
+Run tests:
+
+```sh
+pnpm test
+```
+
+Lint and format:
+
+```sh
+pnpm lint
+pnpm format
+```
+
+### Create a New Package
+
+Generate a new package in the monorepo:
+
+```sh
+pnpm run turbo:gen:init
+```
+
+## 📦 Packages
+
+<!-- List your packages here -->
+
+## 🚢 Releases
+
+This project uses [Changesets](https://github.com/changesets/changesets) for version management and publishing.
+
+## 📄 License
+
+[MIT](LICENSE)
