chore: render Stack message (#38)

* feat: display hint

* chore: enter prerelease mode

* chore: update PR template

* test: increase timeout 10s

* ci: add PR test

* ci: add build step

* chore: remove npmrc

.changeset/heavy-adults-beg.md

@@ -0,0 +1,5 @@
+---
+'create-boilertowns': patch
+---
+
+Display brief stack next to boilerplate name.

.changeset/pre.json

@@ -0,0 +1,8 @@
+{
+	"mode": "pre",
+	"tag": "next",
+	"initialVersions": {
+		"create-boilertowns": "0.0.6"
+	},
+	"changesets": []
+}

.github/pull_request_template.md

@@ -6,4 +6,4 @@
 
 ## Appreciation
 
-<!-- If your create pull request to add a new boilerplate, don't forget to ⭐️ and give credit to the authors/maintainers. -->
+<!-- If your create pull request to add a new boilerplate, don't forget to ⭐️ and give credit to its authors/maintainers. -->

.github/workflows/pr-test.yml

@@ -0,0 +1,31 @@
+name: PR Test
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+    branches:
+      - main
+
+jobs:
+  unit-test:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: pnpm/action-setup@v2.2.2
+        with:
+          version: 7.8.0
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+          cache: 'pnpm'
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - run: pnpm run build
+
+      - name: Unit test
+        run: pnpm run test

README.md

@@ -28,13 +28,18 @@ pnpm create boilertowns
 
 ## Available boilerplates
 
-The list of current boilerplates that you can select in Boilertowns. More will come soon.
+The list of current boilerplates that you can select in Boilertowns. More coming soon!
 
 ### React
 
-- [react-nostalgia-boilerplate](https://github.com/boilertowns/react-nostalgia-boilerplate) - Application boilerplate with Typescript, React, Styled-components, React Router v6, Babel and Webpack.
-- [react-ui-boilerplate](https://github.com/boilertowns/react-ui-boilerplate) - UI library with Typescript, React, Emotion, Rollup and Babel.
-- [react-monorepo-boilerplate](https://github.com/boilertowns/react-monorepo-boilerplate) - The boilerplate with opinionated setup to help you quickly kickstart your React monorepo project.
+- [react-minimal-boilerplate](https://github.com/boilertowns/react-minimal-boilerplate) - Basic Vite boilerplate with a little steroids. Typescript, Vite, Vitest, React, React Router v6, Tailwind CSS.
+- [react-nostalgia-boilerplate](https://github.com/boilertowns/react-nostalgia-boilerplate) - Application boilerplate. Typescript, React, React Router v6, Styled-components, Babel, Webpack.
+- [react-ui-boilerplate](https://github.com/boilertowns/react-ui-boilerplate) - React UI components boilerplate. Typescript, React, Emotion, Rollup, Babel.
+- [react-monorepo-boilerplate](https://github.com/boilertowns/react-monorepo-boilerplate) - Monorepo boilerplate. Typescript, Turborepo, React, React Router v6, Next.js, Rollup, Babel, Webpack.
+
+### Node
+
+- [node-cli-boilerplate](https://github.com/boilertowns/node-cli-boilerplate) - Node CLI boilerplate - `create-boilertowns` is using this. Typescript, tsup, Vitest.
 
 ## Contributing
 

__tests__/cli.test.ts

@@ -31,5 +31,5 @@ describe('create-boilertowns cli', () => {
 		).toBeTruthy();
 
 		expect(fs.existsSync(path.resolve(testDir, 'node_modules'))).toBe(false);
-	});
+	}, 10000);
 });

scripts/add-boilerplate.js

@@ -70,6 +70,19 @@ async function boilerplateIndexFileContent() {
 				type: 'input',
 				message: 'Boilerplate name (ex. my-boilerplate):',
 			},
+			{
+				name: 'stack',
+				type: 'input',
+				message: 'Featured stack (ex. Typescript, React, ...):',
+				validate: (value) => {
+					if (typeof value === 'string' && value.length > 100) {
+						return `Please briefly describe the stack, max ${chalk.italic(
+							'100 characters',
+						)}.`;
+					}
+					return true;
+				},
+			},
 			{
 				name: 'repo',
 				type: 'input',
@@ -102,13 +115,14 @@ async function boilerplateIndexFileContent() {
 				message: 'NPM "scripts" (comma-separated):',
 			},
 		]);
-		const { name, repo, scripts } = answers;
+		const { name, stack, repo, scripts } = answers;
 
-		const dir = path.resolve(boilerplatesDir, name);
+		const dir = path.resolve(boilerplatesDir, name.toLowerCase());
 		await fs.mkdir(dir);
 
 		const dirIndex = await createFileByTemplate('index.ts', {
 			name,
+			stack,
 			repo,
 			scripts,
 		});

scripts/templates/index.ts.hbs

@@ -3,6 +3,7 @@ import { modifier } from './modifier.js';
 
 const boilerplates: Boilerplate = {
 	name: '{{ name }}',
+	hint: '{{ stack }}',
 	repo: '{{ repo }}',
 	scripts: [{{#each scripts }}'{{ this }}',{{/each}}],
 	modifier,

src/boilerplates/node-cli-boilerplate/index.ts

@@ -3,6 +3,7 @@ import { modifier } from './modifier.js';
 
 const boilerplates: Boilerplate = {
 	name: 'node-cli-boilerplate',
+	hint: 'Typescript, tsup, Vitest',
 	repo: 'https://github.com/boilertowns/node-cli-boilerplate',
 	scripts: ['dev'],
 	modifier,

src/boilerplates/react-minimal-boilerplate/index.ts

@@ -3,6 +3,7 @@ import { modifier } from './modifier.js';
 
 const boilerplates: Boilerplate = {
 	name: 'react-minimal-boilerplate',
+	hint: 'Typescript, Vite, Vitest, React, React Router v6, Tailwind CSS',
 	repo: 'https://github.com/boilertowns/react-minimal-boilerplate',
 	scripts: ['dev'],
 	modifier,

src/boilerplates/react-monorepo-boilerplate/index.ts

@@ -3,6 +3,7 @@ import { modifier } from './modifier.js';
 
 const boilerplates: Boilerplate = {
 	name: 'react-monorepo-boilerplate',
+	hint: 'Monorepo, Typescript, Turborepo, React, React Router v6, Next.js, Rollup, Babel, Webpack',
 	repo: 'https://github.com/boilertowns/react-monorepo-boilerplate',
 	scripts: ['build', 'dev'],
 	modifier,

src/boilerplates/react-nostalgia-boilerplate/index.ts

@@ -3,6 +3,7 @@ import { modifier } from './modifier.js';
 
 const boilerplates: Boilerplate = {
 	name: 'react-nostalgia-boilerplate',
+	hint: 'Typescript, React, React Router v6, Styled-components, Babel, Webpack',
 	repo: 'https://github.com/boilertowns/react-nostalgia-boilerplate',
 	scripts: ['dev'],
 	modifier,

src/boilerplates/react-ui-boilerplate/index.ts

@@ -3,6 +3,7 @@ import { modifier } from './modifier.js';
 
 const boilerplates: Boilerplate = {
 	name: 'react-ui-boilerplate',
+	hint: 'Typescript, React, Emotion, Rollup, Babel',
 	repo: 'https://github.com/boilertowns/react-ui-boilerplate',
 	scripts: ['storybook'],
 	modifier,

src/types/index.ts

@@ -12,14 +12,16 @@ interface ModifierParams {
 
 export type Modifier = (params: ModifierParams) => void;
 
-export interface Boilerplate {
-	/**
-	 * Name of the repository.
-	 */
+interface EnquirerChoice {
+	name: string;
+	message?: string;
+	value?: string;
+	hint?: string;
+	disabled?: boolean | string;
+}
+
+export interface Boilerplate extends EnquirerChoice {
 	name: string;
-	/**
-	 * HTTP URL of repository.
-	 */
 	repo: string;
 	/**
 	 * The npm scripts to get started with the boilerplate.