@component-hook/create-app 1.0.3 → 1.0.4

package/README.md

@@ -1,82 +1,82 @@
-# @component-hook/create-app
-
-Scaffolding a basic `typescript` project.
-
-> **Compatibility Note:**
-> Requires [Node.js](https://nodejs.org/en/) version 18+, 20+. However, some templates require a higher Node.js version to work, please upgrade if your package manager warns about it.
-
-<p>
-  <a href="https://npm-stat.com/charts.html?package=@component-hook/create-app">
-    <img src="https://img.shields.io/npm/dm/@component-hook/create-app.svg" alt="npm"/>
-  </a>
-  <a href="https://www.npmjs.com/package/@component-hook/create-app">
-    <img src="https://img.shields.io/npm/v/@component-hook/create-app.svg" alt="npm"/>
-  </a>
-</p>
-
-## Create Project
-
-```bash
-$ npm create @component-hook/app@latest
-
-# or use yarn
-$ yarn create @component-hook/app
-
-# or use pnpm
-$ pnpm create @component-hook/app
-```
-
-Then follow the prompts!
-
-You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a project, run:
-
-```bash
-$ npm create @component-hook/app@latest basic-app -- --template vue
-
-# yarn
-$ yarn create @component-hook/app basic-app --template vue
-
-# pnpm
-$ pnpm create @component-hook/app basic-app --template vue
-```
-
-Currently supported template presets include:
-
-- `vue`
-
-## Project Default Setup
-
-- [Vite](https://cn.vite.dev/)
-- [TypeScript](https://www.typescriptlang.org/)
-- [Axios](https://github.com/axios/axios)
-- [TailwindcSS](https://tailwindcss.com/)
-- [PostCSS](https://postcss.org/) w/ `postcss-nesting` plugin
-- [Cssnano](https://cssnano.github.io/cssnano/) for minimizing production CSS
-- [Postcss-pxtorem](https://www.npmjs.com/package/postcss-pxtorem) generates rem units from pixel units
-- [Vite-plugin-svg-icons](https://github.com/vbenjs/vite-plugin-svg-icons) generate svg sprite map
-- [Eslint](https://eslint.org/)
-  - [@component-hook/eslint-plugin](https://www.npmjs.com/package/@component-hook/eslint-plugin?activeTab=readme)
-- [Prettier](https://prettier.io/)
-- [Husky](https://www.npmjs.com/package/husky) to improves commits
-  - if encounter npx: command not found, can execute `ln -s $(which npx) /usr/local/bin/npx` in zsh
-  - [commitlint](https://commitlint.js.org/#/) checks if your commit messages meet the conventional commit format
-  - [lint-staged](https://github.com/okonet/lint-staged) filter files checked by pre commit lint
-- Alias `@` to `<project_root>/src`
-- Mock use [msw](https://mswjs.io/)
-  - `npx msw init ./public`
-- Unit test use [Vitest](https://vitest.dev/) + [Testing Library](https://testing-library.com/)
-  - [jsdom](https://www.npmjs.com/package/jsdom)
-  - [@vitest/coverage-v8](https://vitest.dev/guide/coverage.html)
-  - [@testing-library/jest-dom](https://testing-library.com/docs/ecosystem-jest-dom/)
-  - [@testing-library/user-event](https://testing-library.com/docs/ecosystem-user-event/)
-- E2E test use [playwright](https://playwright.dev/)
-- [Rollup-plugin-visualizer](https://github.com/btd/rollup-plugin-visualizer) visualize and analyze your Rollup bundle to see which modules are taking up space
-- Predefined and fully typed global variables:
-  - `VITE_APP_VERSION` is read from `package.json` version at build time
-  - `VITE_APP_BUILD_EPOCH` is populated as `new Date().getTime()` at build time
-- Github workflows (default)
-  - ci - on workflow call and dispatch
-  - deploy - on push main branch
-  - preview - on pull request
-- Gitlab CI (use `--gitlab` command create project)
-  - run tests - on branches, merge request and manual
+# @component-hook/create-app
+
+Scaffolding a basic `typescript` project.
+
+> **Compatibility Note:**
+> Requires [Node.js](https://nodejs.org/en/) version 18+, 20+. However, some templates require a higher Node.js version to work, please upgrade if your package manager warns about it.
+
+<p>
+  <a href="https://npm-stat.com/charts.html?package=@component-hook/create-app">
+    <img src="https://img.shields.io/npm/dm/@component-hook/create-app.svg" alt="npm"/>
+  </a>
+  <a href="https://www.npmjs.com/package/@component-hook/create-app">
+    <img src="https://img.shields.io/npm/v/@component-hook/create-app.svg" alt="npm"/>
+  </a>
+</p>
+
+## Create Project
+
+```bash
+$ npm create @component-hook/app@latest
+
+# or use yarn
+$ yarn create @component-hook/app
+
+# or use pnpm
+$ pnpm create @component-hook/app
+```
+
+Then follow the prompts!
+
+You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a project, run:
+
+```bash
+$ npm create @component-hook/app@latest basic-app -- --template vue
+
+# yarn
+$ yarn create @component-hook/app basic-app --template vue
+
+# pnpm
+$ pnpm create @component-hook/app basic-app --template vue
+```
+
+Currently supported template presets include:
+
+- `vue`
+
+## Project Default Setup
+
+- [Vite](https://cn.vite.dev/)
+- [TypeScript](https://www.typescriptlang.org/)
+- [Axios](https://github.com/axios/axios)
+- [TailwindcSS](https://tailwindcss.com/)
+- [PostCSS](https://postcss.org/) w/ `postcss-nesting` plugin
+- [Cssnano](https://cssnano.github.io/cssnano/) for minimizing production CSS
+- [Postcss-pxtorem](https://www.npmjs.com/package/postcss-pxtorem) generates rem units from pixel units
+- [Vite-plugin-svg-icons](https://github.com/vbenjs/vite-plugin-svg-icons) generate svg sprite map
+- [Eslint](https://eslint.org/)
+  - [@component-hook/eslint-plugin](https://www.npmjs.com/package/@component-hook/eslint-plugin?activeTab=readme)
+- [Prettier](https://prettier.io/)
+- [Husky](https://www.npmjs.com/package/husky) to improves commits
+  - if encounter npx: command not found, can execute `ln -s $(which npx) /usr/local/bin/npx` in zsh
+  - [commitlint](https://commitlint.js.org/#/) checks if your commit messages meet the conventional commit format
+  - [lint-staged](https://github.com/okonet/lint-staged) filter files checked by pre commit lint
+- Alias `@` to `<project_root>/src`
+- Mock use [msw](https://mswjs.io/)
+  - `npx msw init ./public`
+- Unit test use [Vitest](https://vitest.dev/) + [Testing Library](https://testing-library.com/)
+  - [jsdom](https://www.npmjs.com/package/jsdom)
+  - [@vitest/coverage-v8](https://vitest.dev/guide/coverage.html)
+  - [@testing-library/jest-dom](https://testing-library.com/docs/ecosystem-jest-dom/)
+  - [@testing-library/user-event](https://testing-library.com/docs/ecosystem-user-event/)
+- E2E test use [playwright](https://playwright.dev/)
+- [Rollup-plugin-visualizer](https://github.com/btd/rollup-plugin-visualizer) visualize and analyze your Rollup bundle to see which modules are taking up space
+- Predefined and fully typed global variables:
+  - `VITE_APP_VERSION` is read from `package.json` version at build time
+  - `VITE_APP_BUILD_EPOCH` is populated as `new Date().getTime()` at build time
+- Github workflows (default)
+  - ci - on workflow call and dispatch
+  - deploy - on push main branch
+  - preview - on pull request
+- Gitlab CI (use `--gitlab` command create project)
+  - run tests - on branches, merge request and manual

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@component-hook/create-app",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Scaffolding a basic typescript project",
   "type": "module",
   "license": "MIT",

package/template-vue/.github/actions/setup-environment/action.yml

@@ -1,45 +1,45 @@
-name: Setup environment
-
-description: Install dependencies
-
-runs:
-  using: composite
-  steps:
-    - name: install Node.js
-      uses: actions/setup-node@v4
-      with:
-        node-version: 20
-
-    - name: install pnpm
-      uses: pnpm/action-setup@v4
-      with:
-        run_install: false
-
-    - name: get pnpm store directory
-      id: pnpm-cache
-      shell: bash
-      run: |
-        echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
-
-    - name: setup pnpm cache
-      uses: actions/cache@v4
-      with:
-        path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
-        key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-        restore-keys: |
-          ${{ runner.os }}-pnpm-store-
-
-    - name: setup node_modules cache
-      id: dependencies-cache
-      uses: actions/cache@v4
-      with:
-        path: |
-          **/node_modules
-        key: ${{ runner.os }}-node-modules-${{ hashFiles('**/pnpm-lock.yaml') }}
-        restore-keys: |
-          ${{ runner.os }}-node-modules-
-
-    - name: install dependencies
-      if: steps.dependencies-cache.outputs.cache-hit != 'true'
-      shell: bash
-      run: pnpm install
+name: Setup environment
+
+description: Install dependencies
+
+runs:
+  using: composite
+  steps:
+    - name: install Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: 20
+
+    - name: install pnpm
+      uses: pnpm/action-setup@v4
+      with:
+        run_install: false
+
+    - name: get pnpm store directory
+      id: pnpm-cache
+      shell: bash
+      run: |
+        echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+    - name: setup pnpm cache
+      uses: actions/cache@v4
+      with:
+        path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+        key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+        restore-keys: |
+          ${{ runner.os }}-pnpm-store-
+
+    - name: setup node_modules cache
+      id: dependencies-cache
+      uses: actions/cache@v4
+      with:
+        path: |
+          **/node_modules
+        key: ${{ runner.os }}-node-modules-${{ hashFiles('**/pnpm-lock.yaml') }}
+        restore-keys: |
+          ${{ runner.os }}-node-modules-
+
+    - name: install dependencies
+      if: steps.dependencies-cache.outputs.cache-hit != 'true'
+      shell: bash
+      run: pnpm install

package/template-vue/.github/renovate.json

@@ -1,12 +1,12 @@
-{
-  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": ["config:base", "group:allNonMajor", "schedule:weekly", ":semanticCommitTypeAll(chore)"],
-  "labels": ["dependencies"],
-  "rangeStrategy": "bump",
-  "packageRules": [
-    {
-      "depTypeList": ["peerDependencies"],
-      "enabled": false
-    }
-  ]
-}
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["config:base", "group:allNonMajor", "schedule:weekly", ":semanticCommitTypeAll(chore)"],
+  "labels": ["dependencies"],
+  "rangeStrategy": "bump",
+  "packageRules": [
+    {
+      "depTypeList": ["peerDependencies"],
+      "enabled": false
+    }
+  ]
+}

package/template-vue/.github/workflows/ci.yml

@@ -1,22 +1,22 @@
-name: CI Pipeline
-
-on:
-  workflow_call:
-  workflow_dispatch:
-
-jobs:
-  CI:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: setup environment
-        uses: './.github/actions/setup-environment'
-
-      - name: install Playwright browsers
-        run: npx playwright install --with-deps
-
-      - name: run unit test
-        run: pnpm test:unit
-
-      - name: run e2e test
-        run: pnpm test:ci-e2e
+name: CI Pipeline
+
+on:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+  CI:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: setup environment
+        uses: './.github/actions/setup-environment'
+
+      - name: install Playwright browsers
+        run: npx playwright install --with-deps
+
+      - name: run unit test
+        run: pnpm test:unit
+
+      - name: run e2e test
+        run: pnpm test:ci-e2e

package/template-vue/.github/workflows/deploy.yml

@@ -1,27 +1,27 @@
-name: Deploy to Production
-
-on:
-  push:
-    branches: [main]
-    paths:
-      - 'src/**'
-      - 'pnpm-lock.yaml'
-      - 'package.json'
-
-jobs:
-  CI:
-    uses: './.github/workflows/ci.yml'
-
-  deploy:
-    runs-on: ubuntu-latest
-    needs: CI
-    steps:
-      - uses: actions/checkout@v4
-      # - name: setup environment
-      #   uses: './.github/actions/setup-environment'
-
-      # - name: build production
-      #   run: pnpm build:production
-
-      # - name: deploy to production
-      #   run: pnpm deploy
+name: Deploy to Production
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'src/**'
+      - 'pnpm-lock.yaml'
+      - 'package.json'
+
+jobs:
+  CI:
+    uses: './.github/workflows/ci.yml'
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: CI
+    steps:
+      - uses: actions/checkout@v4
+      # - name: setup environment
+      #   uses: './.github/actions/setup-environment'
+
+      # - name: build production
+      #   run: pnpm build:production
+
+      # - name: deploy to production
+      #   run: pnpm deploy

package/template-vue/.github/workflows/preview.yml

@@ -1,17 +1,17 @@
-name: Prewiew Pull Request
-
-on:
-  pull_request:
-    types: [opened, synchronize, reopened]
-
-jobs:
-  CI:
-    uses: './.github/workflows/ci.yml'
-
-  preview:
-    runs-on: ubuntu-latest
-    needs: CI
-    steps:
-      - uses: actions/checkout@v4
-      # - name: setup environment
-      #   uses: './.github/actions/setup-environment'
+name: Prewiew Pull Request
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  CI:
+    uses: './.github/workflows/ci.yml'
+
+  preview:
+    runs-on: ubuntu-latest
+    needs: CI
+    steps:
+      - uses: actions/checkout@v4
+      # - name: setup environment
+      #   uses: './.github/actions/setup-environment'

package/template-vue/.gitlab/setup.yml

@@ -1,18 +1,18 @@
-variables:
-  NODE_VERSION: '20'
-  CACHE_KEY: '${CI_PROJECT_PATH_SLUG}-${CI_COMMIT_REF_SLUG}'
-
-image: node:${NODE_VERSION}-alpine
-
-cache:
-  key: ${CACHE_KEY}
-  paths:
-    - .pnpm-store
-    - node_modules/
-  policy: pull-push
-
-before_script:
-  - corepack enable
-  - corepack prepare --activate
-  - pnpm config set store-dir .pnpm-store
-  - pnpm install
+variables:
+  NODE_VERSION: '20'
+  CACHE_KEY: '${CI_PROJECT_PATH_SLUG}-${CI_COMMIT_REF_SLUG}'
+
+image: node:${NODE_VERSION}-alpine
+
+cache:
+  key: ${CACHE_KEY}
+  paths:
+    - .pnpm-store
+    - node_modules/
+  policy: pull-push
+
+before_script:
+  - corepack enable
+  - corepack prepare --activate
+  - pnpm config set store-dir .pnpm-store
+  - pnpm install

package/template-vue/.husky/commit-msg

@@ -1,3 +1,3 @@
-#!/bin/sh
-
-npx --no -- commitlint --edit ${1}
+#!/bin/sh
+
+npx --no -- commitlint --edit ${1}

package/template-vue/.husky/pre-commit

@@ -1,3 +1,3 @@
-#!/bin/sh
-
-npx lint-staged
+#!/bin/sh
+
+npx lint-staged

package/template-vue/.vscode/extensions.json

@@ -1,10 +1,10 @@
-{
-  "recommendations": [
-    "vue.volar",
-    "bradlc.vscode-tailwindcss",
-    "esbenp.prettier-vscode",
-    "csstools.postcss",
-    "cpylua.language-postcss",
-    "streetsidesoftware.code-spell-checker"
-  ]
-}
+{
+  "recommendations": [
+    "vue.volar",
+    "bradlc.vscode-tailwindcss",
+    "esbenp.prettier-vscode",
+    "csstools.postcss",
+    "cpylua.language-postcss",
+    "streetsidesoftware.code-spell-checker"
+  ]
+}

package/template-vue/.vscode/settings.json

@@ -1,27 +1,27 @@
-{
-  "[nginx]": {
-    "editor.defaultFormatter": "raynigon.nginx-formatter"
-  },
-  "editor.tabSize": 2,
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "debug.javascript.autoAttachFilter": "smart",
-  "editor.formatOnSave": true,
-  "[dart]": {
-    "editor.formatOnSave": true,
-    "editor.formatOnType": true,
-    "editor.rulers": [120],
-    "editor.selectionHighlight": false,
-    "editor.suggest.snippetsPreventQuickSuggestions": false,
-    "editor.suggestSelection": "first",
-    "editor.tabCompletion": "onlySnippets",
-    "editor.wordBasedSuggestions": "off"
-  },
-  "workbench.editor.splitInGroupLayout": "vertical",
-  "terminal.integrated.shellIntegration.enabled": true,
-  "volar.format.initialIndent": {
-    "html": true
-  },
-  "files.associations": {},
-  "typescript.tsdk": "node_modules/typescript/lib",
-  "cSpell.words": ["dotenv", "pinia", "persistedstate", "unplugin", "Sonarjs", "typecheck"]
-}
+{
+  "[nginx]": {
+    "editor.defaultFormatter": "raynigon.nginx-formatter"
+  },
+  "editor.tabSize": 2,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "debug.javascript.autoAttachFilter": "smart",
+  "editor.formatOnSave": true,
+  "[dart]": {
+    "editor.formatOnSave": true,
+    "editor.formatOnType": true,
+    "editor.rulers": [120],
+    "editor.selectionHighlight": false,
+    "editor.suggest.snippetsPreventQuickSuggestions": false,
+    "editor.suggestSelection": "first",
+    "editor.tabCompletion": "onlySnippets",
+    "editor.wordBasedSuggestions": "off"
+  },
+  "workbench.editor.splitInGroupLayout": "vertical",
+  "terminal.integrated.shellIntegration.enabled": true,
+  "volar.format.initialIndent": {
+    "html": true
+  },
+  "files.associations": {},
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "cSpell.words": ["dotenv", "pinia", "persistedstate", "unplugin", "Sonarjs", "typecheck"]
+}

package/template-vue/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.