@lucaismyname/create-l1-stack 0.1.3 → 0.1.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lucaismyname/create-l1-stack",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "type": "module",
   "publishConfig": {
     "access": "public"

package/src/index.js

@@ -13,6 +13,16 @@ import * as tar from 'tar'
 const TEMPLATE_PKG_TS = '@lucaismyname/l1-template-ts'
 const TEMPLATE_PATH_PREFIX = 'package/template/'
 
+const CODE_QUALITY_PRETTIER_VERSION = '^3.6.2'
+const CODE_QUALITY_HUSKY_VERSION = '^9.1.7'
+const CODE_QUALITY_LINT_STAGED_VERSION = '^16.0.0'
+
+const TESTING_VITEST_VERSION = '^3.2.4'
+const TESTING_JS_DOM_VERSION = '^26.1.0'
+const TESTING_TESTING_LIBRARY_REACT_VERSION = '^16.3.0'
+const TESTING_TESTING_LIBRARY_JEST_DOM_VERSION = '^6.9.0'
+const TESTING_TESTING_LIBRARY_USER_EVENT_VERSION = '^14.6.1'
+
 const THEME_PRESETS = {
   slate: {
     light: {
@@ -740,6 +750,132 @@ async function applyDeployTarget(targetDir, targetKey) {
   }
 }
 
+async function applyCodeQualityTools(targetDir) {
+  const pkgJsonPath = path.join(targetDir, 'package.json')
+  const pkg = await fse.readJson(pkgJsonPath)
+
+  pkg.devDependencies ??= {}
+  pkg.scripts ??= {}
+
+  pkg.devDependencies.prettier = CODE_QUALITY_PRETTIER_VERSION
+  pkg.devDependencies.husky = CODE_QUALITY_HUSKY_VERSION
+  pkg.devDependencies['lint-staged'] = CODE_QUALITY_LINT_STAGED_VERSION
+
+  pkg.scripts.format ??= 'prettier . --write'
+  pkg.scripts['format:check'] ??= 'prettier . --check'
+  pkg.scripts.prepare ??= 'husky'
+
+  pkg['lint-staged'] ??= {
+    '*.{ts,tsx,js,jsx,css,md,json}': ['prettier --write'],
+  }
+
+  await fse.writeJson(pkgJsonPath, pkg, { spaces: 2 })
+
+  const prettierRcPath = path.join(targetDir, '.prettierrc')
+  const prettierIgnorePath = path.join(targetDir, '.prettierignore')
+
+  const prettierRc = `{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "all"
+}
+`
+
+  const prettierIgnore = `node_modules
+dist
+coverage
+.DS_Store
+package-lock.json
+pnpm-lock.yaml
+yarn.lock
+`
+
+  await fs.writeFile(prettierRcPath, prettierRc, 'utf8')
+  await fs.writeFile(prettierIgnorePath, prettierIgnore, 'utf8')
+
+  const huskyDir = path.join(targetDir, '.husky')
+  await fs.mkdir(huskyDir, { recursive: true })
+
+  const preCommitPath = path.join(huskyDir, 'pre-commit')
+  const preCommit = `#!/usr/bin/env sh
+. "$(dirname -- \"$0\")/_/husky.sh"
+
+npx lint-staged
+`
+  await fs.writeFile(preCommitPath, preCommit, 'utf8')
+  try {
+    await fs.chmod(preCommitPath, 0o755)
+  } catch {
+    // ignore
+  }
+}
+
+async function applyTesting(targetDir) {
+  const pkgJsonPath = path.join(targetDir, 'package.json')
+  const pkg = await fse.readJson(pkgJsonPath)
+
+  pkg.devDependencies ??= {}
+  pkg.scripts ??= {}
+
+  pkg.devDependencies.vitest = TESTING_VITEST_VERSION
+  pkg.devDependencies.jsdom = TESTING_JS_DOM_VERSION
+  pkg.devDependencies['@testing-library/react'] = TESTING_TESTING_LIBRARY_REACT_VERSION
+  pkg.devDependencies['@testing-library/jest-dom'] = TESTING_TESTING_LIBRARY_JEST_DOM_VERSION
+  pkg.devDependencies['@testing-library/user-event'] = TESTING_TESTING_LIBRARY_USER_EVENT_VERSION
+
+  pkg.scripts.test ??= 'vitest'
+  pkg.scripts['test:run'] ??= 'vitest run'
+
+  await fse.writeJson(pkgJsonPath, pkg, { spaces: 2 })
+
+  const setupPath = path.join(targetDir, 'src', 'test', 'setup.ts')
+  await fs.mkdir(path.dirname(setupPath), { recursive: true })
+  await fs.writeFile(setupPath, `import '@testing-library/jest-dom/vitest'\n`, 'utf8')
+
+  const appTestPath = path.join(targetDir, 'src', 'App.test.tsx')
+  const appTest = `import { render, screen } from '@testing-library/react'\nimport { MemoryRouter } from 'react-router-dom'\n\nimport App from './App'\n\ntest('renders the app', () => {\n  render(\n    <MemoryRouter initialEntries={[\"/\"]}>\n      <App />\n    </MemoryRouter>\n  )\n\n  expect(screen.getByText(/hello world/i)).toBeInTheDocument()\n})\n`
+  await fs.writeFile(appTestPath, appTest, 'utf8')
+
+  const viteConfigPath = path.join(targetDir, 'vite.config.ts')
+  try {
+    const src = await fs.readFile(viteConfigPath, 'utf8')
+    let next = src
+
+    next = next.replace(
+      /import \{ defineConfig \} from 'vite'/g,
+      "import { defineConfig } from 'vitest/config'"
+    )
+
+    if (!/\btest\s*:\s*\{/m.test(next)) {
+      const testBlock = `  test: {\n    environment: 'jsdom',\n    globals: true,\n    setupFiles: './src/test/setup.ts',\n  },\n`
+      next = next.replace(/\n\}\)\s*\n?$/m, (m) => {
+        const before = next.slice(0, next.length - m.length)
+        const trimmedBefore = before.replace(/\s+$/g, '')
+        const needsComma = !trimmedBefore.endsWith(',') && !trimmedBefore.endsWith('{')
+        return `\n${needsComma ? ',' : ''}\n${testBlock}})\n`
+      })
+    }
+
+    if (next !== src) await fs.writeFile(viteConfigPath, next, 'utf8')
+  } catch {
+    // ignore
+  }
+
+  const tsconfigAppPath = path.join(targetDir, 'tsconfig.app.json')
+  try {
+    const tsconfig = await fse.readJson(tsconfigAppPath)
+    tsconfig.compilerOptions ??= {}
+    const existingTypes = Array.isArray(tsconfig.compilerOptions.types)
+      ? tsconfig.compilerOptions.types
+      : ['vite/client']
+    if (!existingTypes.includes('vitest/globals')) existingTypes.push('vitest/globals')
+    tsconfig.compilerOptions.types = existingTypes
+    await fse.writeJson(tsconfigAppPath, tsconfig, { spaces: 2 })
+  } catch {
+    // ignore
+  }
+}
+
 function toKebabCaseName(input) {
   return input
     .trim()
@@ -1000,6 +1136,32 @@ async function main() {
     process.exit(0)
   }
 
+  const codeQuality = await select({
+    message: 'Add code quality tools (Prettier + Husky + lint-staged)?',
+    options: [
+      { value: 'yes', label: 'Yes' },
+      { value: 'no', label: 'No' },
+    ],
+    initialValue: 'yes',
+  })
+  if (isCancel(codeQuality)) {
+    cancel('Cancelled')
+    process.exit(0)
+  }
+
+  const testing = await select({
+    message: 'Add testing (Vitest + Testing Library)?',
+    options: [
+      { value: 'yes', label: 'Yes' },
+      { value: 'no', label: 'No' },
+    ],
+    initialValue: 'yes',
+  })
+  if (isCancel(testing)) {
+    cancel('Cancelled')
+    process.exit(0)
+  }
+
   const targetDir = path.resolve(process.cwd(), projectName)
   // NOTE: npm downloads the CLI package before prompts run.
   // To avoid downloading both templates, we fetch only the chosen template from npm.
@@ -1063,6 +1225,13 @@ async function main() {
   await applyContainerPreset(targetDir, language, containerPreset)
   await applyDeployTarget(targetDir, deployTarget)
 
+  if (codeQuality === 'yes') {
+    await applyCodeQualityTools(targetDir)
+  }
+  if (testing === 'yes') {
+    await applyTesting(targetDir)
+  }
+
   // Update package name
   const pkgJsonPath = path.join(targetDir, 'package.json')
   const pkg = await fse.readJson(pkgJsonPath)
@@ -1087,6 +1256,14 @@ async function main() {
   if (shouldInstall === 'yes') {
     try {
       await execa(pm.name, pm.install, { cwd: targetDir, stdio: 'inherit' })
+
+      if (codeQuality === 'yes') {
+        try {
+          await execa('npx', ['husky', 'install'], { cwd: targetDir, stdio: 'inherit' })
+        } catch {
+          // ignore
+        }
+      }
     } catch (err) {
       const stderr = err?.stderr ?? ''
       const missingUtils =