@qlover/create-app 0.0.1

package/templates/pack-app/.github/workflows/release.yml.template

@@ -0,0 +1,110 @@
+name: Release [PATH_NAMES]
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - master
+    types:
+      - closed
+    paths:
+      - [PATH_NAMES]/**
+
+jobs:
+  release-PR:
+    # only run when PR merged and has changes:[PATH_NAMES] and CI-Release labels
+    if: |
+      github.event.pull_request.merged == true && 
+      contains(github.event.pull_request.labels.*.name, 'changes:[PATH_NAMES]') &&
+      !contains(github.event.pull_request.labels.*.name, 'CI-Release')
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          # ref: ${{ github.head_ref || github.ref_name }}
+
+      - name: Config Git
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"  
+      - name: Install Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18.19.0'
+
+      - name: Install dependencies
+        run: |
+          npm install -g yarn
+          yarn
+
+      - name: Lint
+        run: yarn lint
+
+      - name: Test
+        run: yarn test
+
+      - name: Build dist
+        run: yarn build
+
+      - name: Create release PR
+        run: npm run release-pr:[PATH_NAMES]
+        env:
+          GITHUB_TOKEN: ${{ secrets.PAT_TOKEN}}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN}}
+          PAT_TOKEN: ${{ secrets.PAT_TOKEN }} 
+
+  release:
+    # only run when PR merged and has changes:[PATH_NAMES] and CI-Release labels
+    if: |
+      github.event.pull_request.merged == true && 
+      contains(github.event.pull_request.labels.*.name, 'changes:[PATH_NAMES]') &&
+      contains(github.event.pull_request.labels.*.name, 'CI-Release')
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          # ref: ${{ github.head_ref || github.ref_name }}
+
+      - name: Config Git
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"  
+
+      - name: Install Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18.19.0'
+
+      - name: Install dependencies
+        run: |
+          npm install -g yarn
+          yarn
+
+      - name: Lint
+        run: yarn lint
+
+      - name: Test
+        run: yarn test
+
+      - name: Build dist
+        run: yarn build
+
+      - name: Create tag and publish
+        run: npm run release:[PATH_NAMES]
+        env:
+          GITHUB_TOKEN: ${{ secrets.PAT_TOKEN}}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN}}
+          PAT_TOKEN: ${{ secrets.PAT_TOKEN }}
+
+      - name: Debug Git status
+        run: |
+          git status
+          git branch
+          git rev-parse --abbrev-ref HEAD

package/templates/pack-app/.prettierignore

@@ -0,0 +1,5 @@
+.github
+.husky
+**/dist/*
+**/node_modules/*
+**/.output/*

package/templates/pack-app/.prettierrc.js

@@ -0,0 +1,3 @@
+import prettierConfig from '@qlover/fe-standard/config/prettierrc.js';
+
+export default prettierConfig;

package/templates/pack-app/README.md

@@ -0,0 +1 @@
+# fe pack-app

package/templates/pack-app/eslint.config.js

@@ -0,0 +1,77 @@
+import globals from 'globals';
+import jest from 'eslint-plugin-jest';
+import * as eslintChain from '@qlover/fe-standard/eslint/index.js';
+import reactEslint from './packages/react-vite-lib/eslint.config.js';
+
+const { createCommon, createTslintRecommended, chainEnv } = eslintChain;
+const allGlobals = {
+  ...globals.browser,
+  ...globals.node,
+  ...globals.jest
+};
+
+function createBrowserConfig() {
+  return chainEnv({
+    allGlobals,
+    files: ['packages/browser/**/*.ts'],
+    languageOptions: {
+      globals: globals.browser
+    }
+  });
+}
+
+function createNodeConfig() {
+  return chainEnv({
+    allGlobals,
+    files: ['packages/node/**/*.ts'],
+    languageOptions: {
+      globals: globals.node
+    }
+  });
+}
+
+function createReactConfig() {
+  return chainEnv({
+    allGlobals,
+    files: ['packages/react/**/*.tsx'],
+    ...reactEslint
+  });
+}
+
+function createJESTConfig() {
+  const config = chainEnv({
+    allGlobals,
+    files: ['packages/**/*.test.ts', 'packages/**/*.test.js'],
+    plugins: {
+      jest
+    },
+    languageOptions: {
+      globals: {
+        // ...globals.browser,
+        ...globals.node,
+        ...globals.jest
+      }
+    }
+  });
+  return config;
+}
+
+/**
+ * @type {import('eslint').Linter.Config[]}
+ */
+export default [
+  {
+    ignores: ['**/dist/**', '**/build/**', '**/node_modules/**', 'templates/**']
+  },
+  // common js and ts
+  createCommon(),
+  createTslintRecommended(['packages/**/*.ts']),
+  // browser
+  createBrowserConfig(),
+  // node
+  createNodeConfig(),
+  // react
+  createReactConfig(),
+  // jest
+  createJESTConfig()
+];

package/templates/pack-app/fe-config.json

@@ -0,0 +1,10 @@
+{
+  "protectedBranches": ["master", "develop"],
+  "release": {
+    "packagesDirectories": [
+      "packages/browser",
+      "packages/node",
+      "packages/react-vite-lib"
+    ]
+  }
+}

package/templates/pack-app/jest.config.js

@@ -0,0 +1,31 @@
+import tsJestConfig from '@qlover/fe-standard/config/jest.esm.js';
+
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+export default {
+  // ...tsJestConfig,
+  testEnvironment: 'jest-environment-jsdom',
+  extensionsToTreatAsEsm: ['.ts', '.tsx'],
+  projects: [
+    {
+      ...tsJestConfig,
+      displayName: 'pack-app-node',
+      testMatch: tsJestConfig.testMatch.map(
+        (item) => '<rootDir>/packages/node/' + item
+      )
+    },
+    {
+      ...tsJestConfig,
+      displayName: 'pack-app-browser',
+      testMatch: tsJestConfig.testMatch.map(
+        (item) => '<rootDir>/packages/browser/' + item
+      )
+    },
+    {
+      ...tsJestConfig,
+      displayName: 'pack-app-react',
+      testEnvironment: 'jest-environment-jsdom',
+      extensionsToTreatAsEsm: ['.ts', '.tsx'],
+      testMatch: ['<rootDir>/packages/react-vite-lib/__tests__/**/*.test.tsx']
+    }
+  ]
+};

package/templates/pack-app/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@qlover/pack-app",
+  "version": "0.0.0",
+  "description": "A template for fe-pack-app",
+  "type": "module",
+  "private": true,
+  "repository": {
+    "type": "github",
+    "url": "https://github.com/qlover/fe-base"
+  },
+  "homepage": "https://github.com/qlover/fe-base#readme",
+  "scripts": {
+    "build": "pnpm run build:node && pnpm run build:browser && pnpm run build:react",
+    "build:node": "pnpm run build --filter=@qlover/pack-app-node",
+    "build:browser": "pnpm run build --filter=@qlover/pack-app-browser",
+    "build:react": "pnpm run build --filter=@qlover/pack-app-react",
+    "prettier": "prettier --ignore-path .prettierignore **/*.{js,ts,json,cjs,mjs} --write",
+    "lint": "eslint . --fix",
+    "test": "jest",
+    "clean": "fe-clean",
+    "clean:build": "fe-clean -f packages/*/dist -r",
+    "check-packages": "fe-check-packages",
+    "commit": "fe-commit",
+    "clean-branch": "fe-clean-branch"
+  },
+  "keywords": [
+    "template",
+    "fe-pack-app"
+  ],
+  "author": "qlover",
+  "license": "ISC",
+  "devEngines": {
+    "node": ">=18.19.0"
+  },
+  "devDependencies": {
+    "@qlover/fe-scripts": "^0.5.1",
+    "@qlover/fe-standard": "^0.0.2",
+    "@qlover/fe-utils": "^1.1.3",
+    "@rollup/plugin-commonjs": "^28.0.1",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^15.3.0",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.1.1",
+    "@testing-library/jest-dom": "^6.6.3",
+    "@testing-library/react": "^16.1.0",
+    "@types/jest": "^29.5.11",
+    "eslint": "^9.17.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "rollup": "^4.24.2",
+    "rollup-plugin-delete": "^2.1.0",
+    "rollup-plugin-dts": "^6.1.1",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "ts-node": "^10.9.2",
+    "typescript": "~5.4.0"
+  },
+  "workspaces": [
+    "packages/*"
+  ],
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx}": [
+      "eslint --fix"
+    ]
+  },
+  "packageManager": "pnpm@9.1.0"
+}

package/templates/pack-app/packages/browser/__tests__/calc.test.ts

@@ -0,0 +1,9 @@
+import { calc } from '../src/calc';
+
+describe('calc 函数测试', () => {
+  it('应该返回两个数字的和', () => {
+    expect(calc(1, 2)).toBe(3);
+    expect(calc(-1, 1)).toBe(0);
+    expect(calc(0, 0)).toBe(0);
+  });
+});

package/templates/pack-app/packages/browser/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@qlover/pack-app-browser",
+  "version": "0.0.1",
+  "private": true,
+  "main": "index.ts",
+  "type": "module",
+  "scripts": {
+    "build": "rollup -c",
+    "test": "jest"
+  }
+}

package/templates/pack-app/packages/browser/rollup.config.js

@@ -0,0 +1,70 @@
+import resolve from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+import typescript from 'rollup-plugin-typescript2';
+import dts from 'rollup-plugin-dts';
+import terser from '@rollup/plugin-terser';
+import { searchEnv } from '@qlover/fe-scripts';
+import del from 'rollup-plugin-delete';
+import { readFileSync } from 'fs';
+
+const tsConfig = JSON.parse(readFileSync('./tsconfig.json', 'utf-8'));
+const env = searchEnv({ logger: console });
+const NODE_ENV = env.get('NODE_ENV');
+const isProduction = NODE_ENV === 'production';
+console.log('Enveronment is', NODE_ENV);
+
+const buildDir = tsConfig.compilerOptions.outDir;
+
+/**
+ * @param {{ entry: string, formats: string[], external: string[], target: string, clean: boolean }} options
+ * @returns {import('rollup').RollupOptions[]}
+ */
+function createBuilder({ target, entry, formats, external, clean, umdName }) {
+  target = target || `${buildDir}/${entry}`;
+
+  /** @type {import('rollup').OutputOptions[]} */
+  const outputs = formats.map((format) => ({
+    file: `${target}/index.${format}.js`,
+    format,
+    name: umdName,
+    sourcemap: !isProduction
+  }));
+
+  return [
+    {
+      input: `./${entry}/index.ts`,
+      output: outputs,
+      plugins: [
+        clean && del({ targets: `${buildDir}/*` }),
+        resolve({
+          preferBuiltins: false
+        }),
+        commonjs(),
+        typescript({ tsconfig: './tsconfig.json' }),
+        isProduction && terser()
+      ],
+      external: external
+    },
+    {
+      input: `./${entry}/index.ts`,
+      output: {
+        file: `${target}/index.d.ts`,
+        format: 'es'
+      },
+      plugins: [dts()]
+    }
+  ];
+}
+
+/**
+ * @type {import('rollup').RollupOptions[]}
+ */
+export default [
+  ...createBuilder({
+    entry: 'src',
+    formats: ['es', 'umd'],
+    target: buildDir,
+    umdName: 'PackAppBrowser',
+    clean: true
+  })
+];

package/templates/pack-app/packages/browser/src/calc.ts

@@ -0,0 +1,3 @@
+export function calc(a: number, b: number): number {
+  return a + b;
+}

package/templates/pack-app/packages/browser/src/index.ts

@@ -0,0 +1 @@
+export * from './calc';

package/templates/pack-app/packages/browser/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES5",
+    "module": "ESNext",
+    "declaration": false,
+    "outDir": "dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "moduleResolution": "Node",
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "baseUrl": "./"
+  },
+  "include": ["src/**/*"]
+}

package/templates/pack-app/packages/node/__tests__/readJson.test.ts

@@ -0,0 +1,25 @@
+import { readJson } from '../src/readJson';
+import { writeFileSync, unlinkSync } from 'fs';
+
+describe('readJson 函数测试', () => {
+  const testFilePath = './test.json';
+
+  beforeAll(() => {
+    // 创建一个测试文件
+    writeFileSync(testFilePath, JSON.stringify({ key: 'value' }));
+  });
+
+  afterAll(() => {
+    // 删除测试文件
+    unlinkSync(testFilePath);
+  });
+
+  it('应该正确读取 JSON 文件', () => {
+    const result = readJson(testFilePath);
+    expect(result).toEqual({ key: 'value' });
+  });
+
+  it('应该抛出错误当文件不存在时', () => {
+    expect(() => readJson('./nonexistent.json')).toThrow();
+  });
+});

package/templates/pack-app/packages/node/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@qlover/pack-app-node",
+  "version": "0.0.1",
+  "main": "index.js",
+  "type": "module",
+  "private": true,
+  "scripts": {
+    "build": "rollup -c",
+    "test": "jest"
+  }
+}

package/templates/pack-app/packages/node/rollup.config.js

@@ -0,0 +1,89 @@
+import resolve from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+import json from '@rollup/plugin-json';
+import terser from '@rollup/plugin-terser';
+import dts from 'rollup-plugin-dts';
+import typescript from 'rollup-plugin-typescript2';
+import { builtinModules } from 'module';
+import { readFileSync, rmSync } from 'fs';
+
+const pkg = JSON.parse(readFileSync('./package.json'), 'utf-8');
+const tsConfig = JSON.parse(readFileSync('./tsconfig.json'), 'utf-8');
+
+const isProduction = false;
+const buildDir = tsConfig.compilerOptions.outDir;
+
+const treeshake = {
+  moduleSideEffects: false,
+  propertyReadSideEffects: false,
+  tryCatchDeoptimization: false
+};
+const defaultExternal = [
+  ...builtinModules,
+  ...builtinModules.map((mod) => `node:${mod}`),
+  ...Object.keys(pkg.dependencies || {}),
+  ...Object.keys(pkg.devDependencies || {})
+];
+
+function createPlugin(minify) {
+  return [
+    resolve({
+      preferBuiltins: false
+    }),
+    commonjs(),
+    json(),
+    typescript({
+      tsconfig: './tsconfig.json',
+      tsconfigOverride: {
+        include: ['src']
+      }
+    }),
+    minify && terser()
+  ].filter(Boolean);
+}
+
+function cleanBuildDir() {
+  rmSync(buildDir, { recursive: true, force: true });
+  console.log(`${buildDir} cleaned`);
+}
+
+cleanBuildDir();
+
+/**
+ * @type {import('rollup').RollupOptions[]}
+ */
+const config = [
+  {
+    input: 'src/index.ts',
+    external: defaultExternal,
+    output: [
+      {
+        file: 'dist/cjs/index.js',
+        format: 'cjs'
+      },
+      {
+        file: 'dist/es/index.js',
+        format: 'es'
+      }
+    ],
+    plugins: createPlugin(isProduction),
+    treeshake
+  },
+  {
+    input: './src/index.ts',
+    output: [
+      {
+        file: 'dist/cjs/index.d.ts',
+        format: 'cjs'
+      },
+      {
+        file: 'dist/es/index.d.ts',
+        format: 'es'
+      }
+    ],
+    plugins: [dts()],
+    treeshake
+  }
+];
+
+export default config;

package/templates/pack-app/packages/node/src/index.ts

@@ -0,0 +1,7 @@
+import { readJson } from './readJson';
+
+export * from './readJson';
+
+console.log('readJson', readJson('./package.json'));
+
+console.log('process.cwd', process.cwd());

package/templates/pack-app/packages/node/src/readJson.ts

@@ -0,0 +1,6 @@
+import { readFileSync } from 'fs';
+
+export function readJson(path: string): Record<string, unknown> {
+  const packageJson = readFileSync(path, 'utf8');
+  return JSON.parse(packageJson);
+}

package/templates/pack-app/packages/node/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "module": "ESNext",
+    "baseUrl": "./",
+    "outDir": "dist",
+    "skipLibCheck": true,
+    "moduleResolution": "Bundler",
+    "target": "ES2015",
+    "downlevelIteration": true,
+    "strict": true,
+    "allowUnusedLabels": false,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true
+  },
+  "include": ["src"],
+  "exclude": ["dist", "node_modules"]
+}

package/templates/pack-app/packages/react-vite-lib/README.md

@@ -0,0 +1,50 @@
+# React + TypeScript + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+
+- Configure the top-level `parserOptions` property like this:
+
+```js
+export default tseslint.config({
+  languageOptions: {
+    // other options...
+    parserOptions: {
+      project: ['./tsconfig.node.json', './tsconfig.app.json'],
+      tsconfigRootDir: import.meta.dirname,
+    },
+  },
+})
+```
+
+- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
+- Optionally add `...tseslint.configs.stylisticTypeChecked`
+- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
+
+```js
+// eslint.config.js
+import react from 'eslint-plugin-react'
+
+export default tseslint.config({
+  // Set the react version
+  settings: { react: { version: '18.3' } },
+  plugins: {
+    // Add the react plugin
+    react,
+  },
+  rules: {
+    // other rules...
+    // Enable its recommended rules
+    ...react.configs.recommended.rules,
+    ...react.configs['jsx-runtime'].rules,
+  },
+})
+```

package/templates/pack-app/packages/react-vite-lib/__tests__/Sum.test.ts

@@ -0,0 +1,9 @@
+import { sum } from '../src/sum';
+
+describe('sum 函数测试', () => {
+  it('应该返回两个数字的和', () => {
+    expect(sum(1, 2)).toBe(3);
+    expect(sum(-1, 1)).toBe(0);
+    expect(sum(0, 0)).toBe(0);
+  });
+});

package/templates/pack-app/packages/react-vite-lib/__tests__/Text.test.tsx

@@ -0,0 +1,11 @@
+import '@testing-library/jest-dom';
+import { render, screen } from '@testing-library/react';
+import { Text } from '../src/commponents/Text';
+
+describe('Text Component', () => {
+  test('renders the text prop', () => {
+    render(<Text text="Hello, World!" />);
+    const textElement = screen.getByText(/Hello, World!/i);
+    expect(textElement).toBeInTheDocument();
+  });
+});