create-v2-addon-repo

Codemod to create a repo with v2 addons

1. Features
2. Usage
3. Compatibility
4. Contributing
5. License

Features

Create a batteries-included project fast:

• Create as many v2 addons as you want
• Run generate and destroy commands to create and remove files
• Tailor blueprints to your needs, or stay close to the default with update-blueprints command
• Explore bleeding-edge Ember: Embroider app, embroider-css-modules, glint, <template> tag out of the box
• Maintain project like a pro: lint, test, CI, and documentation out of the box

Usage

Step 1. Use npx to run create-v2-addon-repo.

npx create-v2-addon-repo <your-project-name>

This will create a folder named <your-project-name>.

Step 2. Change directory to the project root, then run these scripts in sequence:

# Install dependencies
pnpm install

# Build blueprints-v2-addon
pnpm build

# Install blueprints-v2-addon (one-time)
pnpm install

# Commit changes
git init
git add .
git commit -m "Initial commit"

# Push changes (to a new repo)
git remote add origin [email protected]:<your-github-handle>/<your-repo-name>.git
git branch -M main
git push -u origin main

Step 3. Use the new command to start creating addons.

# Specify name
pnpm addon new ui-form

# Specify location
pnpm addon new @my-org-ui/form --location ui/form

Compatibility

• Node.js v18 or above

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.