Updated README (#45)

* chore: Documented how to sync reference repo * chore: Updated README * chore: Updated CURRENT_VERSION and fixtures * chore: Added changeset --------- Co-authored-by: ijlee2 <ijlee2@users.noreply.github.com>
ijlee2 · Sep 9, 2024 · 6c1f6e6 · 6c1f6e6
1 parent 4316b5c
commit 6c1f6e6
Show file tree

Hide file tree

Showing 16 changed files with 94 additions and 35 deletions.
diff --git a/.changeset/old-zoos-wonder.md b/.changeset/old-zoos-wonder.md
@@ -0,0 +1,6 @@
+---
+"create-v2-addon-repo": patch
+"blueprints-v2-addon": patch
+---
+
+Updated README
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -117,5 +117,33 @@ Here are some guidelines to help you and everyone else.
 
 </details>
 
+<details>
+
+<summary>Sync reference repo for <code>blueprints-v2-addon</code> (for admins)</summary>
+
+1. Run the following commands in the `blueprints-v2-addon-output` repo.
+
+    ```sh
+    # Reset project
+    git rm -r .
+
+    # Downstream files
+    git clone --no-checkout git@github.com:ijlee2/embroider-toolbox.git temp
+    cd temp
+    git sparse-checkout set packages/blueprints-v2-addon
+    git checkout
+    cd ..
+
+    # Move files
+    mv temp/packages/blueprints-v2-addon/* .
+    mv temp/packages/blueprints-v2-addon/.* .
+    rm -rf temp
+
+    # Reset CHANGELOG
+    echo "# blueprints-v2-addon" > CHANGELOG.md
+    ```
+
+</details>
+
 
 💡 Have ideas for contribution? Reach out to `@ijlee2` on [Discord](https://discord.com/invite/emberjs)!
diff --git a/README.md b/README.md
@@ -20,6 +20,24 @@
 - [ember-codemod-v1-to-v2](https://github.com/ijlee2/ember-codemod-v1-to-v2)
 
 
+## Tutorials
+
+> [!NOTE]
+>
+> Coming soon (Q4 2024). Please star or watch this repo to help me gauge interest.
+
+### analyze-ember-project-dependencies
+
+- Main tutorial
+
+
+### create-v2-addon-repo
+
+- Create v2 addons (main tutorial)
+- Customize blueprints
+- Customize repo
+
+
 ## Contributing
 
 See the [Contributing](CONTRIBUTING.md) guide for details.

diff --git a/packages/blueprints-v2-addon/package.json b/packages/blueprints-v2-addon/package.json
@@ -1,6 +1,6 @@
 {
   "name": "blueprints-v2-addon",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "private": true,
   "description": "Blueprints for v2 addons",
   "keywords": [

diff --git a/packages/blueprints-v2-addon/src/blueprints/run-new/__addonLocation__/README.md b/packages/blueprints-v2-addon/src/blueprints/run-new/__addonLocation__/README.md
@@ -22,9 +22,9 @@ pnpm start
 
 <details>
 
-<summary>Create entity</summary>
+<summary>Create files</summary>
 
-From the addon root, run the `generate` command to create the source code and its test file.
+Run the `generate` command (from anywhere inside the addon) to create the source code and its test file.
 
 ```sh
 pnpm addon generate <component|helper|modifier|service|util> <name> [options]
@@ -49,9 +49,9 @@ For more information, pass `--help`.
 
 <details>
 
-<summary>Remove entity</summary>
+<summary>Remove files</summary>
 
-From the addon root, run the `destroy` command to remove the source code and its test file.
+Run the `destroy` command (from anywhere inside the addon) to remove the source code and its test file.
 
 ```sh
 pnpm addon destroy <component|helper|modifier|service|util> <name> 

diff --git a/...es/blueprints-v2-addon/tests/fixtures/run-new/output/packages/ui/form/README.md b/...es/blueprints-v2-addon/tests/fixtures/run-new/output/packages/ui/form/README.md
@@ -22,9 +22,9 @@ pnpm start
 
 <details>
 
-<summary>Create entity</summary>
+<summary>Create files</summary>
 
-From the addon root, run the `generate` command to create the source code and its test file.
+Run the `generate` command (from anywhere inside the addon) to create the source code and its test file.
 
 ```sh
 pnpm addon generate <component|helper|modifier|service|util> <name> [options]
@@ -49,9 +49,9 @@ For more information, pass `--help`.
 
 <details>
 
-<summary>Remove entity</summary>
+<summary>Remove files</summary>
 
-From the addon root, run the `destroy` command to remove the source code and its test file.
+Run the `destroy` command (from anywhere inside the addon) to remove the source code and its test file.
 
 ```sh
 pnpm addon destroy <component|helper|modifier|service|util> <name> 

diff --git a/packages/blueprints-v2-addon/update-blueprints.js b/packages/blueprints-v2-addon/update-blueprints.js
@@ -5,7 +5,7 @@ import gitDiffApply from 'git-diff-apply';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 
-const CURRENT_VERSION = '0.1.4';
+const CURRENT_VERSION = '0.1.5';
 
 async function updateBlueprints({ from, to }) {
   const startTag = from;

diff --git a/packages/create-v2-addon-repo/README.md b/packages/create-v2-addon-repo/README.md
@@ -14,10 +14,10 @@ _Codemod to create a repo with v2 addons_
 Create a batteries-included project fast:
 
 - Create as many v2 addons as you want
-- Run `generate` and `destroy` commands (à la Ember CLI)
-- Tailor addon blueprints to your needs
-- Explore bleeding-edge Ember: `embroider-css-modules`, `glint`, `<template>` tag out of the box
-- Maintain project easily: lint, test, CI, and documentation out of the box
+- Run `generate` and `destroy` commands to create and remove files
+- Tailor blueprints to your needs, or stay close to the default with `update-blueprint` command
+- Explore bleeding-edge Ember: Embroider app, `embroider-css-modules`, `glint`, `<template>` tag out of the box
+- Set up project like a pro: lint, test, CI, and documentation out of the box
 
 
 ## Usage
@@ -36,8 +36,11 @@ Step 2. Change directory to the project root, then run these scripts in sequence
 # Install dependencies
 pnpm install
 
-# Build packages
+# Build blueprints-v2-addon
 pnpm build
+
+# Install blueprints-v2-addon (one-time)
+pnpm install
 ```
 
 ```sh
@@ -57,6 +60,10 @@ git push -u origin main
 Step 3. Use the `new` command to start creating addons.
 
 ```sh
+# Specify name
+pnpm addon new ui-form
+
+# Specify location
 pnpm addon new @my-org-ui/form --location ui/form
 ```
 

diff --git a/packages/create-v2-addon-repo/src/blueprints/blueprints/v2-addon/package.json b/packages/create-v2-addon-repo/src/blueprints/blueprints/v2-addon/package.json
@@ -1,6 +1,6 @@
 {
   "name": "blueprints-v2-addon",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "private": true,
   "description": "Blueprints for v2 addons",
   "keywords": [

diff --git a/...ueprints/blueprints/v2-addon/src/blueprints/run-new/__addonLocation__/README.md b/...ueprints/blueprints/v2-addon/src/blueprints/run-new/__addonLocation__/README.md
@@ -22,9 +22,9 @@ pnpm start
 
 <details>
 
-<summary>Create entity</summary>
+<summary>Create files</summary>
 
-From the addon root, run the `generate` command to create the source code and its test file.
+Run the `generate` command (from anywhere inside the addon) to create the source code and its test file.
 
 ```sh
 pnpm addon generate <component|helper|modifier|service|util> <name> [options]
@@ -49,9 +49,9 @@ For more information, pass `--help`.
 
 <details>
 
-<summary>Remove entity</summary>
+<summary>Remove files</summary>
 
-From the addon root, run the `destroy` command to remove the source code and its test file.
+Run the `destroy` command (from anywhere inside the addon) to remove the source code and its test file.
 
 ```sh
 pnpm addon destroy <component|helper|modifier|service|util> <name> 

diff --git a/...ts/blueprints/v2-addon/tests/fixtures/run-new/output/packages/ui/form/README.md b/...ts/blueprints/v2-addon/tests/fixtures/run-new/output/packages/ui/form/README.md
@@ -22,9 +22,9 @@ pnpm start
 
 <details>
 
-<summary>Create entity</summary>
+<summary>Create files</summary>
 
-From the addon root, run the `generate` command to create the source code and its test file.
+Run the `generate` command (from anywhere inside the addon) to create the source code and its test file.
 
 ```sh
 pnpm addon generate <component|helper|modifier|service|util> <name> [options]
@@ -49,9 +49,9 @@ For more information, pass `--help`.
 
 <details>
 
-<summary>Remove entity</summary>
+<summary>Remove files</summary>
 
-From the addon root, run the `destroy` command to remove the source code and its test file.
+Run the `destroy` command (from anywhere inside the addon) to remove the source code and its test file.
 
 ```sh
 pnpm addon destroy <component|helper|modifier|service|util> <name> 

diff --git a/packages/create-v2-addon-repo/src/blueprints/blueprints/v2-addon/update-blueprints.js b/packages/create-v2-addon-repo/src/blueprints/blueprints/v2-addon/update-blueprints.js
@@ -5,7 +5,7 @@ import gitDiffApply from 'git-diff-apply';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 
-const CURRENT_VERSION = '0.1.4';
+const CURRENT_VERSION = '0.1.5';
 
 async function updateBlueprints({ from, to }) {
   const startTag = from;

diff --git a/...e-v2-addon-repo/tests/fixtures/typescript/output/my-repo/blueprints/v2-addon/package.json b/...e-v2-addon-repo/tests/fixtures/typescript/output/my-repo/blueprints/v2-addon/package.json
@@ -1,6 +1,6 @@
 {
   "name": "blueprints-v2-addon",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "private": true,
   "description": "Blueprints for v2 addons",
   "keywords": [

diff --git a/.../my-repo/blueprints/v2-addon/src/blueprints/run-new/__addonLocation__/README.md b/.../my-repo/blueprints/v2-addon/src/blueprints/run-new/__addonLocation__/README.md
@@ -22,9 +22,9 @@ pnpm start
 
 <details>
 
-<summary>Create entity</summary>
+<summary>Create files</summary>
 
-From the addon root, run the `generate` command to create the source code and its test file.
+Run the `generate` command (from anywhere inside the addon) to create the source code and its test file.
 
 ```sh
 pnpm addon generate <component|helper|modifier|service|util> <name> [options]
@@ -49,9 +49,9 @@ For more information, pass `--help`.
 
 <details>
 
-<summary>Remove entity</summary>
+<summary>Remove files</summary>
 
-From the addon root, run the `destroy` command to remove the source code and its test file.
+Run the `destroy` command (from anywhere inside the addon) to remove the source code and its test file.
 
 ```sh
 pnpm addon destroy <component|helper|modifier|service|util> <name> 

diff --git a/...po/blueprints/v2-addon/tests/fixtures/run-new/output/packages/ui/form/README.md b/...po/blueprints/v2-addon/tests/fixtures/run-new/output/packages/ui/form/README.md
@@ -22,9 +22,9 @@ pnpm start
 
 <details>
 
-<summary>Create entity</summary>
+<summary>Create files</summary>
 
-From the addon root, run the `generate` command to create the source code and its test file.
+Run the `generate` command (from anywhere inside the addon) to create the source code and its test file.
 
 ```sh
 pnpm addon generate <component|helper|modifier|service|util> <name> [options]
@@ -49,9 +49,9 @@ For more information, pass `--help`.
 
 <details>
 
-<summary>Remove entity</summary>
+<summary>Remove files</summary>
 
-From the addon root, run the `destroy` command to remove the source code and its test file.
+Run the `destroy` command (from anywhere inside the addon) to remove the source code and its test file.
 
 ```sh
 pnpm addon destroy <component|helper|modifier|service|util> <name> 

diff --git a/...on-repo/tests/fixtures/typescript/output/my-repo/blueprints/v2-addon/update-blueprints.js b/...on-repo/tests/fixtures/typescript/output/my-repo/blueprints/v2-addon/update-blueprints.js
@@ -5,7 +5,7 @@ import gitDiffApply from 'git-diff-apply';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 
-const CURRENT_VERSION = '0.1.4';
+const CURRENT_VERSION = '0.1.5';
 
 async function updateBlueprints({ from, to }) {
   const startTag = from;