@qlover/create-app 0.1.8 → 0.1.9

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 
 
+## [0.1.9](https://github.com/qlover/fe-base/compare/create-app-v0.1.8...create-app-v0.1.9) (2025-02-20)
+
+
+### Bug Fixes
+
+* add pnpm install ([#248](https://github.com/qlover/fe-base/issues/248)) ([e1e9f48](https://github.com/qlover/fe-base/commit/e1e9f4841365c51e9b8ea7b01ac6fc70e35eec37))
+
 ## [0.1.8](https://github.com/qlover/fe-base/compare/create-app-v0.1.7...create-app-v0.1.8) (2025-02-19)
 
 ## [0.1.7](https://github.com/qlover/fe-base/compare/create-app-v0.1.6...create-app-v0.1.7) (2025-02-19)

package/configs/_common/.github/workflows/general-check.yml

@@ -31,6 +31,9 @@ jobs:
           npm install -g pnpm
           pnpm -v
 
+      - name: Install dependencies
+        run: pnpm install
+
       - name: Pnpm Lint
         run: pnpm lint
 

package/configs/_common/.github/workflows/release.yml.template

@@ -40,6 +40,9 @@ jobs:
           npm install -g pnpm
           pnpm -v
 
+      - name: Install dependencies
+        run: pnpm install
+
       - name: Pnpm Lint
         run: pnpm lint
 

package/configs/_common/.husky/commit-msg

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+npx --no-install commitlint --edit "$1"

package/configs/_common/.husky/pre-commit

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+pnpm lint-staged

package/configs/_common/commitlint.config.js

@@ -0,0 +1,10 @@
+import { FeScriptContext } from '@qlover/scripts-context';
+
+const { feConfig } = new FeScriptContext();
+
+/**
+ * @type {import('@commitlint/types').UserConfig}
+ */
+export default {
+  ...feConfig.commitlint
+};

package/configs/_common/package.json.template

@@ -53,7 +53,11 @@
     "@qlover/env-loader": "latest",
     "@qlover/fe-standard": "latest",
     "@qlover/fe-scripts": "latest",
-    "@qlover/scripts-context": "latest"
+    "@qlover/scripts-context": "latest",
+    "@commitlint/cli": "^19.7.1",
+    "@commitlint/config-conventional": "^19.7.1",
+    "husky": "^9.1.7",
+    "lint-staged": "^15.0.0",
   },
   "dependencies": {
     "@qlover/fe-utils": "latest"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qlover/create-app",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "type": "module",
   "private": false,
   "main": "./dist/es/index.js",

package/templates/pack-app/README.md

@@ -1 +1,108 @@
-# fe pack-app
+# pack-app
+
+A tools....
+
+A private monorepo for managing ...
+
+## Directory Structure
+
+```bash
+├── .github/ # GitHub config files
+│ ├── workflows/ # GitHub Actions workflows
+├── .vscode/ # VSCode config files
+├── .husky/ # husky config files
+├── packages/
+│ ├── node-lib/
+│ ├── node-lib2/
+│ ├── ....
+├── .gitignore # Git ignore files
+├── package.json # project config file
+└── README.md # project description
+```
+
+## Pre-check
+
+### Commit Message Lint
+
+Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) to standardize commit messages
+
+Conventional Commits is a commit message convention, it is recommended to follow a certain format for each Git commit message. The basic format is as follows:
+
+Example：
+
+```bash
+<type>(<scope>): <message>
+```
+
+- type: commit type, for example, feat (new feature), fix (bug fix), chore (miscellaneous tasks), etc.
+- scope (optional): the scope of the feature, for example, a module or file.
+- message: a brief description of the purpose of this commit.
+
+Common commit types include:
+
+- feat: new feature
+- fix: bug fix
+- docs: document modification
+- style: code format related modifications (do not affect code logic)
+- refactor: code refactoring
+- test: add or modify tests
+- chore: other modifications that do not affect the source code (such as dependency updates)
+
+fe-release uses release-it, and the current project uses the @release-it/conventional-changelog plugin, so it needs to follow the conventional commits specification
+
+When the project is released, it will generate the CHANGELOG.md file according to the commit information of each commit, and generate the release version according to the commit information
+
+For example, feat: Add Docs
+
+changelog will generate the following similar md:
+
+```md
+### Features
+
+- feat: Add Docs [#5](https://github.com/qlover/brainai-frontend/pull/5) [25dcc5](https://github.com/qlover/brainai-frontend/pull/5/commits/25dcc5d180604f5d46bd3f114cfe0eb01dd13b90)
+```
+
+You can also use commitlint + husky to limit submissions
+
+If you are afraid of forgetting, you can directly use the fe-commit command to complete the submission, it is interactive
+
+### Commit Lint
+
+When git commit, it will check whether the current submission code meets the eslint + prettier format requirements
+
+The current project uses lint-staged to limit the code submitted, only check the code in the staging area
+
+**Note:** When submitting too many codes, there will be a slow verification situation, please avoid submitting too many codes at once
+
+## node-lib
+
+```bash
+npx node-lib
+```
+
+## Release
+
+**Note:** When publishing, you need to use npm, not pnpm or yarn, because fe-release internally depends on relesae-it, and release-it only supports npm
+
+And you need to provide a higher permission GITHUB_TOKEN, as well as NPM_TOKEN
+
+Below is an example of how to publish `node-lib`
+
+The current project is hosted on github, so you need to use the github workflow workflow
+
+0. Create a corresponding release.yml file in the .github/workflow directory
+
+1. Submit code and create a Merge PR to the `main` branch
+
+   If there is a modification to the `packages/node-lib` directory in the current submission, the `workflows/general-check.yml` will give the current PR the `changes:packages/node-lib` label
+
+2. After the current Merge PR is merged into the `main` branch, it will trigger `workflows/release.yml`, the same Merge PR must have `packages/node-lib/**` modifications, otherwise it will not be triggered
+
+   - When the `release-PR` is triggered, the corresponding `npm run release-pr:node-lib` will be executed, and a Release PR will be created using the bot identity, and the `CI-Release` label will be added, and the commitlint rules will automatically process the `CHANGELOG.md` and `package.json` version number
+   - When the Release PR is merged, the corresponding `npm run release:node-lib` will be executed, and the NPM and GitHub release will be published, and a unique tag will be generated
+
+   Release PR will automatically use the patch version number
+
+   If the .env(.env.local) setting of FE_RELEASE is false, it will skip the release
+
+   **Note:** Only when the PR has the `changes:packages/node-lib` and `CI-Release` labels will the release be triggered, of course, you can also directly skip all steps and manually add labels to release, or delete labels to cancel the release

package/templates/pack-app/package.json

@@ -13,7 +13,7 @@
     "build": "pnpm -r run build",
     "prettier": "prettier --ignore-path .prettierignore **/*.{js,ts,json,cjs,mjs} --write",
     "lint": "eslint . --fix",
-    "test": "pnpm run test",
+    "test": "pnpm -r run test",
     "clean": "fe-clean",
     "clean:build": "fe-clean -f packages/*/dist -r",
     "check-packages": "fe-check-packages",
@@ -33,6 +33,7 @@
     "@qlover/fe-scripts": "latest",
     "@qlover/fe-standard": "latest",
     "@qlover/fe-utils": "latest",
+    "@qlover/fe-release": "latest",
     "@rollup/plugin-commonjs": "^28.0.1",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.3.0",