Add extra scripts and update docs

Author: akd-io

CONTRIBUTING.md

@@ -70,19 +70,32 @@ Make sure you are set up locally by following the [Getting Started](#getting-sta
 
    - `git checkout -b feature/support-my-favorite-technology`
 
-2. Add a new .ts file for your plugin in the plugins directory at `packages\create-next-stack\src\main\plugins`
+2. Useful npm scripts of `packages/create-next-stack` to run during development:
+
+   - `check-types:watch` - Runs TypeScript in watch mode to check types as you make changes. You can run this instead of `build:watch` while working on the CLI, as the e2e tests do just-in-time compilation via `ts-node`.
+   - `jest:watch` - Runs Jest in watch mode to run unit tests as you make changes.
+   - `test` - Runs e2e tests. Note that this will run all e2e tests, which can take quite a while.
+   - `lint` - Runs ESLint to lint the project.
+   - `test:manual`
+     - For example, `pnpm run test:manual --package-manager=pnpm --styling=emotion`.
+     - Sets up a new directory for a test run of the CLI, runs the CLI with the specified flags, and builds the generated Next app, and checks formatting and linting.
+     - This is useful for manually testing the CLI. Pass whatever flags to the CLI that you want to test. The `app_name` argument will be set automatically.
+   - `test:raw` - Runs the binary directly. Rarely used, but can be useful for manual tests where you want to be able to specify the `app_name` argument yourself.
+   - `clean` - Removes all generated files, including build files and the `create-next-stack-tests` directory created by the e2e tests.
+
+3. Add a new .ts file for your plugin in the plugins directory at `packages\create-next-stack\src\main\plugins`
 
    - See the [Writing a plugin section](#writing-a-plugin) below to learn how to write a Create Next Stack plugin.
 
-3. Add new flags to the `create-next-stack` command in [`create-next-stack.ts`](packages\create-next-stack\src\main\commands\create-next-stack.ts).
-4. Add the plugin to the `plugins` array in [`setup.ts`](packages/create-next-stack/src/main/setup/setup.ts).
-5. Add potential plugin steps to the `steps` array in [`setup.ts`](packages/create-next-stack/src/main/setup/setup.ts). Steps are run top-to-bottom.
-6. Update the [`README.md`](README.md):
+4. Add new flags to the `create-next-stack` command in [`create-next-stack.ts`](packages\create-next-stack\src\main\commands\create-next-stack.ts).
+5. Add the plugin to the `plugins` array in [`setup.ts`](packages/create-next-stack/src/main/setup/setup.ts).
+6. Add potential plugin steps to the `steps` array in [`setup.ts`](packages/create-next-stack/src/main/setup/setup.ts). Steps are run top-to-bottom.
+7. Update the [`README.md`](README.md):
    - Add the technology to the technology list
    - Update the `Usage` section by copy pasting the output of running `yarn print:help`
-7. Consider expanding some of the e2e tests to include the new technology. See [`test.ts`](packages\create-next-stack\src\tests\e2e\test.ts) for current tests.
-8. Run tests using `yarn test` to ensure they all pass.
-9. Submit a Pull Request on GitHub.
+8. Consider expanding some of the e2e tests to include the new technology. See [`test.ts`](packages\create-next-stack\src\tests\e2e\test.ts) for current tests.
+9. Run tests using `yarn test` to ensure they all pass.
+10. Submit a Pull Request on GitHub.
 
 ## Writing a Plugin
 

packages/create-next-stack/package.json

@@ -48,11 +48,14 @@
   "scripts": {
     "prepack": "pnpm build",
     "check-types": "tsc --noEmit",
+    "check-types:watch": "tsc --noEmit --watch",
     "build": "rimraf lib && tsc --build",
+    "build:watch": "rimraf lib && tsc --build --watch",
     "clean": "rimraf lib && pnpm run clean-tests-dir",
     "clean-tests-dir": "ts-node src/tests/e2e/clean-tests-dir.ts",
     "test": "pnpm build && pnpm run jest && ts-node src/tests/e2e/test.ts",
     "jest": "jest",
+    "jest:watch": "jest --watch",
     "test:manual": "pnpm build && ts-node src/tests/e2e/test-manual.ts --debug",
     "test:small": "pnpm build && ts-node src/tests/e2e/test-manual.ts --debug --package-manager=pnpm --styling=css-modules",
     "test:large": "pnpm build && ts-node src/tests/e2e/test-manual.ts --debug --package-manager=pnpm --styling=emotion --react-hook-form --formik --prettier --formatting-pre-commit-hook --chakra --framer-motion --github-actions",