@qlover/create-app 0.1.4 → 0.1.6

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 
 
+## [0.1.6](https://github.com/qlover/fe-base/compare/create-app-v0.1.5...create-app-v0.1.6) (2025-02-14)
+
+
+### Features
+
+* template context ([#241](https://github.com/qlover/fe-base/issues/241)) ([9fb3046](https://github.com/qlover/fe-base/commit/9fb3046e3e67c02e5fe4fea81a9a3ef8422e3013))
+
+## [0.1.5](https://github.com/qlover/fe-base/compare/create-app-v0.1.4...create-app-v0.1.5) (2025-02-13)
+
 ## [0.1.4](https://github.com/qlover/fe-base/compare/create-app-v0.1.3...create-app-v0.1.4) (2025-01-20)
 
 ## [0.1.3](https://github.com/qlover/fe-base/compare/create-app-v0.1.2...create-app-v0.1.3) (2025-01-17)

package/bin/create-app.js

@@ -3,24 +3,64 @@
 import { fileURLToPath } from 'url';
 import { dirname, join } from 'path';
 import { Generator } from '../dist/es/index.js';
-import { existsSync } from 'fs';
+import { existsSync, readFileSync } from 'fs';
+import { Command } from 'commander';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const pkg = JSON.parse(
+  readFileSync(join(__dirname, '../package.json'), 'utf-8')
+);
+
+function programArgs() {
+  const program = new Command();
+
+  program.version(pkg.version, '-v, --version', 'Show version');
+
+  program
+    .option(
+      '-d, --dry-run',
+      'Do not touch or write anything, but show the commands'
+    )
+    .option('-V, --verbose', 'Show more information')
+    .option('--config', 'Copy config files (default: true)', true)
+    .option('--no-config', 'Do not copy config files');
+
+  // parse arguments
+  program.parse();
+
+  return program.opts();
+}
 
 async function main() {
-  const __dirname = dirname(fileURLToPath(import.meta.url));
+  const { dryRun, verbose, ...commandOptions } = programArgs();
+
   const templateRootPath = join(__dirname, '../templates');
+  const configsRootPath = join(__dirname, '../configs');
 
   if (!existsSync(templateRootPath)) {
     console.error('Template is empty!');
     process.exit(1);
   }
 
+  if (!existsSync(configsRootPath)) {
+    console.error('Configs is empty!');
+    process.exit(1);
+  }
+
   const generator = new Generator({
+    dryRun,
+    verbose,
     options: {
-      templateRootPath
+      ...commandOptions,
+      templateRootPath,
+      configsRootPath
     }
   });
 
   await generator.generate();
 }
 
-main();
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

package/{templates/pack-app → configs/_common}/.env.template

@@ -1,6 +1,13 @@
 NODE_ENV=production
+
+# ci
 NPM_TOKEN=
 GITHUB_TOKEN=
+
+# fe-scripts
 FE_RELEASE_BRANCH=master
 FE_RELEASE=false
-FE_RELEASE_ENV=production
+FE_RELEASE_ENV=production
+
+# vite
+VITE_PUBLIC_PATH=

package/{templates/pack-app → configs/_common}/.github/workflows/general-check.yml

@@ -26,19 +26,19 @@ jobs:
         with:
           node-version: '18.19.0'
 
-      - name: Install dependencies
+      - name: Install Pnpm
         run: |
-          npm install -g yarn
-          yarn
+          npm install -g pnpm
+          pnpm -v
 
-      - name: Lint
-        run: yarn lint
+      - name: Pnpm Lint
+        run: pnpm lint
 
-      - name: Test
-        run: yarn test
+      - name: Pnpm Test
+        run: pnpm test
 
-      - name: Build dist
-        run: yarn build
+      - name: Pnpm Build
+        run: pnpm build
 
       # check packages
       # - name: Check packages

package/{templates/pack-app → configs/_common}/.github/workflows/release.yml.template

@@ -1,4 +1,4 @@
-name: Release [PATH_NAMES]
+name: Release [TPL:projectName]
 
 on:
   workflow_dispatch:
@@ -8,14 +8,14 @@ on:
     types:
       - closed
     paths:
-      - [PATH_NAMES]/**
+      - [TPL:releasePath]/**
 
 jobs:
   release-PR:
-    # only run when PR merged and has changes:[PATH_NAMES] and CI-Release labels
+    # only run when PR merged and has changes:[TPL:projectName] 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, 'changes:[TPL:projectName]') &&
       !contains(github.event.pull_request.labels.*.name, 'CI-Release')
     runs-on: ubuntu-latest
 
@@ -35,32 +35,32 @@ jobs:
         with:
           node-version: '18.19.0'
 
-      - name: Install dependencies
+      - name: Install Pnpm
         run: |
-          npm install -g yarn
-          yarn
+          npm install -g pnpm
+          pnpm -v
 
-      - name: Lint
-        run: yarn lint
+      - name: Pnpm Lint
+        run: pnpm lint
 
-      - name: Test
-        run: yarn test
+      - name: Pnpm Test
+        run: pnpm test
 
-      - name: Build dist
-        run: yarn build
+      - name: Pnpm Build
+        run: pnpm build
 
       - name: Create release PR
-        run: npm run release-pr:[PATH_NAMES]
+        run: npm run release-pr:[TPL:projectName]
         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
+    # only run when PR merged and has changes:[TPL:projectName] 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, 'changes:[TPL:projectName]') &&
       contains(github.event.pull_request.labels.*.name, 'CI-Release')
 
     runs-on: ubuntu-latest
@@ -82,22 +82,22 @@ jobs:
         with:
           node-version: '18.19.0'
 
-      - name: Install dependencies
+      - name: Install Pnpm
         run: |
-          npm install -g yarn
-          yarn
+          npm install -g pnpm
+          pnpm -v
 
-      - name: Lint
-        run: yarn lint
+      - name: Pnpm Lint
+        run: pnpm lint
 
-      - name: Test
-        run: yarn test
+      - name: Pnpm Test
+        run: pnpm test
 
-      - name: Build dist
-        run: yarn build
+      - name: Pnpm Build
+        run: pnpm build
 
       - name: Create tag and publish
-        run: npm run release:[PATH_NAMES]
+        run: npm run release:[TPL:projectName]
         env:
           GITHUB_TOKEN: ${{ secrets.PAT_TOKEN}}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN}}

package/configs/_common/.prettierrc.js

@@ -0,0 +1,7 @@
+/** @type {import('prettier').Config} */
+export default {
+  semi: true,
+  singleQuote: true,
+  trailingComma: 'none',
+  endOfLine: 'lf'
+};

package/configs/_common/.release-it.json.template

@@ -0,0 +1,42 @@
+{
+  "git": {
+    "commitMessage": "chore(tag): [TPL:projectName] v${version}",
+    "tagName": "[TPL:projectName]-v${version}",
+    "tagMatch": "[TPL:projectName]-v*",
+    "tagAnnotation": "chore(tag): [TPL:projectName] v${version}",
+    "push": true,
+    "pushArgs": ["--follow-tags"]
+  },
+  "npm": {
+    "publishPath": "",
+    "versionArgs": ["--allow-same-version", "--workspaces-update=false"]
+  },
+  "github": {
+    "release": true,
+    "releaseName": "chore(tag): [TPL:projectName] v${version}"
+  },
+
+  "plugins": {
+    "@release-it/conventional-changelog": {
+      "infile": "CHANGELOG.md",
+      "preset": {
+        "name": "conventionalcommits",
+        "types": [
+          { "type": "feat", "section": "Features" },
+          { "type": "fix", "section": "Bug Fixes" },
+          { "type": "revert", "section": "Reverts" },
+          { "type": "build", "hidden": true, "section": "Build System" },
+          { "type": "chore", "hidden": true },
+          { "type": "docs", "section": "Documentation" },
+          { "type": "style", "hidden": true },
+          { "type": "refactor", "hidden": true },
+          { "type": "perf", "hidden": true },
+          { "type": "test", "hidden": true }
+        ]
+      },
+      "gitRawCommitsOpts": {
+        "path": "."
+      }
+    }
+  }
+}

package/configs/_common/.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint", // ESLint
+    "esbenp.prettier-vscode", // Prettier
+    "bradlc.vscode-tailwindcss", // Tailwind CSS
+    "wayou.vscode-todo-highlight", // Mark Highlight(TODO, FIXME, etc.),
+    "vitest.explorer" // Vitest
+  ]
+}

package/configs/_common/.vscode/react.code-snippets

@@ -0,0 +1,19 @@
+{
+  "react-component": {
+    "prefix": "react-component",
+    "scope": "typescriptreact",
+    "body": [
+      "import clsx from 'clsx';",
+      "",
+      "export type $1Props = {",
+      "  $2",
+      "  className?: string;",
+      "}",
+      "",
+      "export function $1({ $2, className }: $1Props) {",
+      "  return <div data-testid=\"$1\" className={clsx('$3', className)}>$3</div>;",
+      "}"
+    ],
+    "description": "创建一个 React 组件"
+  }
+}

package/configs/_common/.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "eslint.enable": true,
+  "eslint.format.enable": false,
+  "files.eol": "\n",
+  "editor.tabSize": 2,
+  "jest.runMode": "on-demand",
+  "tailwindCSS.rootFontSize": 10,
+  "editor.snippetSuggestions": "top",
+  "vitest.autoRun": false,
+  "workbench.view.alwaysShowHeaderActions": true
+}

package/configs/_common/package.json.template

@@ -0,0 +1,61 @@
+{
+  "name": "[TPL:projectName]",
+  "description": "[TPL:projectName] description",
+  "version": "0.0.0",
+  "type": "module",
+  "private": true,
+  "homepage": "",
+  "author": "",
+  "license": "ISC",
+  "main": "./dist/es/index.js",
+  "module": "./dist/es/index.js",
+  "types": "./dist/es/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/es/index.d.ts",
+      "import": "./dist/es/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./cjs/*": "./dist/cjs/*",
+    "./es/*": "./dist/es/*",
+    "./package.json": "./package.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "",
+    "directory": ""
+  },
+  "files": [
+    "bin",
+    "dist",
+    "package.json",
+    "README.md"
+  ],
+  "keywords": [
+    "[TPL:projectName]"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {},
+  "scripts": {
+    "build": "pnpm build",
+    "test": "vitest run",
+    "prettier": "prettier --ignore-path .prettierignore **/*.{js,ts,json,cjs,mjs} --write",
+    "lint": "eslint . --fix",
+    "clean": "fe-clean",
+    "check-packages": "fe-check-packages",
+    "commit": "fe-commit",
+    "clean-branch": "fe-clean-branch",
+    "release:[TPL:projectName]": "release-it"
+  },
+  "devDependencies": {
+    "@qlover/env-loader": "latest",
+    "@qlover/fe-standard": "latest",
+    "@qlover/fe-scripts": "latest",
+    "@qlover/scripts-context": "latest"
+  },
+  "dependencies": {
+    "@qlover/fe-utils": "latest"
+  }
+}

package/configs/node-lib/eslint.config.js

@@ -0,0 +1,50 @@
+import js from '@eslint/js';
+import globals from 'globals';
+import prettierConfig from '../../packages/node-lib/.prettierrc.js';
+import prettier from 'eslint-plugin-prettier';
+import tseslint from '@typescript-eslint/eslint-plugin';
+import tsparser from '@typescript-eslint/parser';
+import * as feDev from '@qlover/eslint-plugin-fe-dev';
+
+export default [
+  {
+    ignores: ['dist', 'node_modules']
+  },
+  {
+    files: ['src/**/*.{js,jsx,ts,tsx}'],
+    languageOptions: {
+      parser: tsparser,
+      ecmaVersion: 2020,
+      globals: {
+        ...globals.browser,
+        ...globals.node
+      },
+      parserOptions: {
+        ecmaVersion: 'latest',
+        ecmaFeatures: { jsx: true },
+        sourceType: 'module',
+        project: './tsconfig.json'
+      }
+    },
+    plugins: {
+      prettier,
+      '@typescript-eslint': tseslint,
+      'fe-dev': feDev
+    },
+    rules: {
+      ...js.configs.recommended.rules,
+      ...tseslint.configs.recommended.rules,
+      '@typescript-eslint/no-explicit-any': 'error',
+      'prettier/prettier': ['error', prettierConfig],
+      '@typescript-eslint/ban-ts-comment': [
+        'off',
+        {
+          'ts-expect-error': {
+            descriptionFormat: '^.*$'
+          }
+        }
+      ],
+      'fe-dev/ts-class-method-return': 'error'
+    }
+  }
+];

package/configs/react-app/eslint.config.js

@@ -0,0 +1,66 @@
+import js from '@eslint/js';
+import globals from 'globals';
+import react from 'eslint-plugin-react';
+import reactHooks from 'eslint-plugin-react-hooks';
+import reactRefresh from 'eslint-plugin-react-refresh';
+import tseslint from 'typescript-eslint';
+import tsparser from '@typescript-eslint/parser';
+import * as feDev from '@qlover/eslint-plugin-fe-dev';
+import prettier from 'eslint-plugin-prettier';
+import prettierConfig from './.prettierrc.js';
+
+export default tseslint.config(
+  { ignores: ['dist', 'node_modules'] },
+  {
+    extends: [js.configs.recommended, ...tseslint.configs.recommended],
+    files: ['src/**/*.{ts,tsx}'],
+    languageOptions: {
+      parser: tsparser,
+      ecmaVersion: 2020,
+      globals: {
+        ...globals.browser,
+        ...globals.node
+      },
+      parserOptions: {
+        ecmaVersion: 'latest',
+        ecmaFeatures: { jsx: true },
+        sourceType: 'module',
+        project: './tsconfig.json'
+      }
+    },
+    settings: { react: { version: '18.3' } },
+    plugins: {
+      react,
+      'react-hooks': reactHooks,
+      'react-refresh': reactRefresh,
+      prettier,
+      '@typescript-eslint': tseslint,
+      'fe-dev': feDev
+    },
+    rules: {
+      ...js.configs.recommended.rules,
+      ...react.configs.recommended.rules,
+      ...react.configs['jsx-runtime'].rules,
+      ...reactHooks.configs.recommended.rules,
+      ...tseslint.configs.recommended.rules,
+      'react/jsx-no-target-blank': 'off',
+      'react/prefer-stateless-function': 'error',
+      'react-refresh/only-export-components': [
+        'warn',
+        { allowConstantExport: true }
+      ],
+      '@typescript-eslint/no-explicit-any': 'error',
+      'prettier/prettier': ['error', prettierConfig],
+      '@typescript-eslint/ban-ts-comment': [
+        'off',
+        {
+          'ts-expect-error': {
+            descriptionFormat: '^.*$'
+          }
+        }
+      ],
+      'react-hooks/exhaustive-deps': 'off',
+      'fe-dev/ts-class-method-return': 'error'
+    }
+  }
+);

package/dist/cjs/index.d.ts

@@ -6,21 +6,54 @@ import ignore from 'ignore';
 type GeneratorPrompt = DistinctQuestion;
 type GeneratorOptions = {
     prompts?: GeneratorPrompt[];
+    /**
+     * template root path
+     */
     templateRootPath: string;
+    /**
+     * configs root path
+     */
+    configsRootPath: string;
+    /**
+     * whether to copy config files
+     */
+    config?: boolean;
 };
-interface GeneratorResult extends GeneratorOptions {
-    name: string;
+interface GeneratorContext extends GeneratorOptions {
+    /**
+     * project name
+     */
+    projectName: string;
+    /**
+     * choose template name
+     *
+     * mayby is pack-app
+     */
     template: string;
+    /**
+     * choose sub packages
+     *
+     * mayby is ['node-lib', 'react-app']
+     */
     subPackages?: string[];
     /**
      * @default `packages`
      */
     packagesNames?: string;
+    /**
+     * Generated project path
+     * @default `./`
+     */
     targetPath?: string;
+    /**
+     * release path
+     * @default `src`
+     */
+    releasePath?: string;
 }
 type TaskOptions = {
     templateFiles: TemplateFile[];
-    result: GeneratorResult;
+    result: GeneratorContext;
 };
 type TemplateFile = {
     path: string;
@@ -30,42 +63,35 @@ type TemplateFile = {
 declare class Generator {
     private ora;
     protected context: FeScriptContext<GeneratorOptions>;
+    private subPackages;
+    private copyer;
+    private compose;
     constructor(context: Partial<FeScriptContext<GeneratorOptions>>);
     get logger(): Logger;
-    steps(prompts: GeneratorPrompt[]): Promise<GeneratorResult>;
+    steps(prompts: GeneratorPrompt[]): Promise<GeneratorContext>;
     action({ label, task }: {
         label: string;
         task: (() => Promise<unknown>) | (() => unknown);
     }): Promise<unknown>;
-    /**
-     * Creates files and directories based on the provided template files.
-     *
-     * This method iterates through the template files and writes their content
-     * to the file system. It handles both files and directories, ensuring that
-     * the directory structure is preserved.
-     *
-     * @param result - The result object containing the name and template name.
-     *
-     * @returns A promise that resolves when all files have been created.
-     *
-     * @example
-     * const result = { name: 'my-app', template: 'react-app' };
-     * await this.create(result);
-     */
-    create(result: GeneratorResult): Promise<void>;
     private isPackageTemplate;
-    getGeneratorResult(): Promise<GeneratorResult>;
+    private getGeneratorContext;
     generate(): Promise<void>;
+    generateConfigs(context: GeneratorContext, targetPath: string, configName: string): Promise<void>;
+    generateTemplateDir(context: GeneratorContext): Promise<void>;
+    generateSubPackages(context: GeneratorContext): Promise<void>;
 }
 
 declare const validRequiredString: (value: string, key: string) => string | true;
-declare const defaultPrompts: GeneratorPrompt[];
-declare const packagePrompts: GeneratorPrompt[];
+declare function createDefaultPrompts(templates: string[], packages: string[]): GeneratorPrompt[];
+declare function createPackagePrompts(templates: string[]): GeneratorPrompt[];
 
+type CopyCallback = (sourceFilePath: string, targetFilePath: string) => boolean | Promise<boolean>;
 declare class Copyer {
+    private readonly ignoreTargetPath;
+    private readonly ignoreFile;
     static IGNORE_FILE: string;
-    getIg(targetDir: string): ignore.Ignore | undefined;
-    ensureDir(dir: string): void;
+    constructor(ignoreTargetPath: string, ignoreFile?: string);
+    getIg(targetDir?: string): ignore.Ignore | undefined;
     /**
      * Asynchronously copy files from source to target directory.
      * @param {string} sourcePath - Source directory.
@@ -75,18 +101,12 @@ declare class Copyer {
      * @example
      * await copyer.copyFilesPromise('src', 'dest', ignoreInstance);
      */
-    copyFilesPromise(sourcePath: string, targetDir: string, ig?: ignore.Ignore): Promise<void>;
-    /**
-     * copy templates recursively
-     * @param {string} sourePath - source directory
-     * @param {string} targetDir - target directory
-     * @param {ignore.Ignore} ig - ignore rules
-     */
-    copyFilesSync(sourePath: string, targetDir: string, ig?: ignore.Ignore): void;
-    create(result: GeneratorResult): void;
-    createPromise(result: GeneratorResult): Promise<void>;
-    createPath(result: GeneratorResult): void;
-    createPathPromise(result: GeneratorResult): Promise<void>;
+    copyFiles(sourcePath: string, targetDir: string, ig?: ignore.Ignore, copyCallback?: CopyCallback): Promise<void>;
+    copyPaths({ sourcePath, targetPath, copyCallback }: {
+        sourcePath: string;
+        targetPath: string;
+        copyCallback?: CopyCallback;
+    }): Promise<void>;
 }
 
-export { Copyer, Generator, type GeneratorOptions, type GeneratorPrompt, type GeneratorResult, type TaskOptions, type TemplateFile, defaultPrompts, packagePrompts, validRequiredString };
+export { type CopyCallback, Copyer, Generator, type GeneratorContext, type GeneratorOptions, type GeneratorPrompt, type TaskOptions, type TemplateFile, createDefaultPrompts, createPackagePrompts, validRequiredString };