feat: add template

Author: amirabbas-gh

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing
+
+Thanks for helping users adopt the latest features with your codemods!  
+
+### Before You Open a PR
+
+- **Issue**: Check for an existing issue, or open one first.  
+- **Safety**: Codemods must be safe, predictable, and idempotent (running twice should not change code again). Avoid mixing patterns with different safety levels.
+- **Naming**: In `codemod.yaml`, the codemod name must start with `@<scope>`, where `<scope>` is this repo's GitHub org.
+- **Tests**: Add multiple fixtures (positive and negative).  
+- **Docs**: Update the README for your codemod.  
+
+### Development
+
+- Scaffold a new codemod:
+  ```bash
+  npx codemod@latest init
+  ```
+- Test your codemod locally;
+    ```bash
+    cd /path/to/sample/project
+    npx codemod workflow run -w /path/to/my-codemod/workflow.yaml
+    ```
+### Project Layout
+
+- Place all codemods in the `codemods/` directory.
+
+### Checks
+
+- Lint/format: npm run check (Biome)
+- Types: npm run typecheck
+
+### Pull Requests
+
+- Describe the codemod and its migration use case.
+- Follow Conventional Commits:
+
+| Type     | Usage                                |
+|----------|--------------------------------------|
+| feat     | New codemod or capability            |
+| fix      | Bugfix in a transform or test        |
+| docs     | Documentation-only changes           |
+| refactor | Non-feature, non-bugfix code changes |
+| test     | Add or update fixtures/tests         |
+| chore    | Tooling, CI, formatting, repo hygiene|
+
+### License
+
+By contributing, you agree that your work will be licensed under the MIT License.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [YEAR] [ORGANIZATION]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,59 @@
+> **REMOVE THIS SECTION ONCE THE REPO IS SET UP.**
+>
+> Framework/SDK maintainers: This template includes setup guides, utilities, and a GitHub Action to help you and your community build and publish codemods with ease.
+>
+> ## One-time setup
+> NOTE: You need repo creation privileges in your org and permission to install GitHub apps on repos. If you don’t, you can request access from your org admin during setup.
+> 1. Use this template and create a codemods repo in your org.
+> 2. Sign up at [Codemod](https://app.codemod.com) with your GitHub account.  
+> 3. Install the Codemod GitHub app:
+>    1. Click your profile photo (top left) and select "Add organization"
+>    2. Pick GitHub, choose your org and the new codemods repo. This installs the Codemod GitHub App and reserves a **scope** with your org name. 
+>     - Benefit: Only members of your org can publish codemods with a name that starts wihh your scope.
+>     - **Important**: In `codemod.yaml`, the name must start with your scope, otherwise it won’t appear when users filter for your scope in the registry.
+> 4. In Codemod, switch from personal account to org account and generate a [Codemod API key](https://app.codemod.com/api-keys).
+> 5. In your GitHub repo: **Settings → Secrets & variables → actions**  
+>    1. Create a repository secret.    
+>      - Name: `CODEMOD_API_KEY`  
+>      - Value: the key from step 1.  
+>
+> ✅ Done! After a codemod PR is merged, you can trigger the GitHub Action to auto-publish it to the [Codemod Registry](https://app.codemod.com/registry) under your org scope. See [Node.js codemods](https://codemod.link/nodejs-official) for an example.
+> 
+> To build a codemod, clone your new repo locally and use [Codemod MCP](https://docs.codemod.com/more-resources/codemod-mcp) in your IDE to replace the boilerplate with a codemod generated using AI. You can also run `npx codemod@latest init` for the initial scaffolding, or use [Codemod Studio](https://codemod.studio) for its live codemod runner and AST viewer.
+
+---
+Official <FRAMEWORK_OR_SDK_OR_ORG> codemods to help users adopt new features and handle breaking changes with ease.
+
+Community contributions are welcome and appreciated! Check open issues for codemods to build, or open a new one if something’s missing. See the [contribution guide](./CONTRIBUTING.md) for details.
+
+## Running codemods
+> [!CAUTION]
+> Codemods modify code! Run them only on Git-tracked files, and commit or stash changes first.
+
+### From the registry
+Recommended for the best UX. This downloads the package from the [Registry](https://app.codemod.com/registry).
+
+```bash
+npx codemod@latest <codemod-name>
+```
+
+For example:
+
+```bash
+npx codemod@latest @nodejs/tmpDir-to-tmpdir
+```
+
+### From source
+
+```bash
+npx codemod workflow run -w /path/to/folder/containing/workflow.yaml
+```
+
+> [!NOTE]
+> By default, codemods run in the current folder. Add `-t /target/path` to change it.
+
+See the [Codemod docs](https://go.codemod.com/cli-docs) for all CLI commands and options.
+
+## License
+
+MIT

biome.jsonc

@@ -0,0 +1,19 @@
+{
+	"$schema": "https://biomejs.dev/schemas/2.2.2/schema.json",
+	"files": {
+		"includes": ["."],
+		"experimentalScannerIgnores": ["codemods/**/tests/**/fixtures/**"]
+	},
+	"formatter": {
+		"enabled": true,
+		"lineWidth": 100
+	},
+	"linter": {
+		"enabled": true
+	},
+	"javascript": {
+		"formatter": {
+			"quoteStyle": "double"
+		}
+	}
+}

codemods/.gitkeep

@@ -0,0 +1,2 @@
+
+

codemods/sample-jssg-codemod/.gitignore

@@ -0,0 +1,33 @@
+# Dependencies
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Build artifacts
+target/
+dist/
+build/
+
+# Temporary files
+*.tmp
+*.temp
+.cache/
+
+# Environment files
+.env
+.env.local
+
+# IDE files
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Package bundles
+*.tar.gz
+*.tgz 

codemods/sample-jssg-codemod/README.md

@@ -0,0 +1,39 @@
+# jssg-codemod
+
+Transform legacy code patterns
+
+## Installation
+
+```bash
+# Install from registry
+codemod run jssg-codemod
+
+# Or run locally
+codemod run -w workflow.yaml
+```
+
+## Usage
+
+This codemod transforms typescript code by:
+
+- Converting `var` declarations to `const`/`let`
+- Removing debug statements
+- Modernizing syntax patterns
+
+## Development
+
+```bash
+# Test the transformation
+npm test
+
+# Validate the workflow
+codemod validate -w workflow.yaml
+
+# Publish to registry
+codemod login
+codemod publish
+```
+
+## License
+
+MIT 

codemods/sample-jssg-codemod/codemod.yaml

@@ -0,0 +1,18 @@
+schema_version: "1.0"
+
+name: "jssg-codemod"
+version: "0.1.0"
+description: "Transform legacy code patterns"
+author: "Author <[email protected]>"
+license: "MIT"
+workflow: "workflow.yaml"
+category: "migration"
+
+targets:
+  languages: ["typescript"]
+
+keywords: ["transformation", "migration"]
+
+registry:
+  access: "public"
+  visibility: "public"

codemods/sample-jssg-codemod/package.json

@@ -0,0 +1,14 @@
+{
+	"name": "jssg-codemod",
+	"version": "0.1.0",
+	"description": "Transform legacy code patterns",
+	"type": "module",
+	"devDependencies": {
+		"@codemod.com/jssg-types": "^1.0.3",
+		"typescript": "^5.8.3"
+	},
+	"scripts": {
+		"test": "npx codemod@latest jssg test -l typescript ./scripts/codemod.ts",
+		"check-types": "npx tsc --noEmit"
+	}
+}

codemods/sample-jssg-codemod/scripts/codemod.ts

@@ -0,0 +1,23 @@
+import type { SgRoot } from "codemod:ast-grep";
+import type TS from "codemod:ast-grep/langs/typescript";
+
+async function transform(root: SgRoot<TS>): Promise<string> {
+	const rootNode = root.root();
+
+	const nodes = rootNode.findAll({
+		rule: {
+			pattern: "var $VAR = $VALUE",
+		},
+	});
+
+	const edits = nodes.map((node) => {
+		const varName = node.getMatch("VAR")?.text();
+		const value = node.getMatch("VALUE")?.text();
+		return node.replace(`const ${varName} = ${value}`);
+	});
+
+	const newSource = rootNode.commitEdits(edits);
+	return newSource;
+}
+
+export default transform;