@celljs/cli 3.7.7 → 3.8.0

package/templates/monorepo/scripts/compile-references.js

@@ -1,286 +0,0 @@
-// @ts-check
-'use-strict';
-
-const cp = require('child_process');
-const path = require('path').posix;
-const fs = require('fs');
-
-const ROOT = path.join(__dirname, '..');
-
-const DRY_RUN = popFlag(process.argv, '--dry-run');
-
-const FORCE_REWRITE = popFlag(process.argv, '--force-rewrite') && !DRY_RUN;
-
-/** @type {{ [packageName: string]: YarnWorkspace }} */
-const YARN_WORKSPACES = JSON.parse(cp.execSync('yarn --silent workspaces info').toString());
-
-// Add the package name inside each package object.
-for (const [packageName, yarnWorkspace] of Object.entries(YARN_WORKSPACES)) {
-    yarnWorkspace.name = packageName;
-}
-
-/** @type {YarnWorkspace} */
-const MONOREPO = {
-    name: 'monorepo',
-    workspaceDependencies: Object.keys(YARN_WORKSPACES),
-    location: ROOT,
-};
-
-try {
-    let rewriteRequired = false;
-    let result = false;
-
-    // Configure all `compile.tsconfig.json` files of this monorepo
-    for (const packageName of Object.keys(YARN_WORKSPACES)) {
-        const workspacePackage = YARN_WORKSPACES[packageName];
-        const tsconfigCompilePath = path.join(ROOT, workspacePackage.location, 'compile.tsconfig.json');
-        const references = getTypescriptReferences(workspacePackage);
-        result = configureTypeScriptCompilation(workspacePackage, tsconfigCompilePath, references);
-        rewriteRequired = rewriteRequired || result;
-    }
-
-    // Configure our root compilation configuration, living inside `configs/root-compilation.tsconfig.json`.
-    const configsFolder = path.join(ROOT, 'configs');
-    const tsconfigCompilePath = path.join(configsFolder, 'root-compilation.tsconfig.json');
-    const references = getTypescriptReferences(MONOREPO, configsFolder);
-    result = configureTypeScriptCompilation(MONOREPO, tsconfigCompilePath, references);
-    rewriteRequired = rewriteRequired || result;
-
-    // Configure the root `tsconfig.json` for code navigation using `tsserver`.
-    const tsconfigNavPath = path.join(ROOT, 'tsconfig.json');
-    result = configureTypeScriptNavigation(MONOREPO, tsconfigNavPath);
-    rewriteRequired = rewriteRequired || result;
-
-    // CI will be able to tell if references got changed by looking at the exit code.
-    if (rewriteRequired) {
-        if (DRY_RUN) {
-            // Running a dry run usually only happens when a developer or CI runs the tests, so we only print the help then.
-            console.error('TypeScript references seem to be out of sync, run "yarn prepare:references" to fix.');
-            process.exitCode = 1;
-        } else {
-            console.warn('TypeScript references were out of sync and got updated.');
-        }
-    }
-
-} catch (error) {
-    console.error(error);
-    process.exitCode = 1;
-}
-
-/**
- * @param {YarnWorkspace} requestedPackage
- * @param {string} [overrideLocation] affects how relative paths are computed.
- * @returns {string[]} project references for `requestedPackage`.
- */
-function getTypescriptReferences(requestedPackage, overrideLocation) {
-    const references = [];
-    for (const dependency of requestedPackage.workspaceDependencies || []) {
-        const depWorkspace = YARN_WORKSPACES[dependency];
-        const depConfig = path.join(depWorkspace.location, 'compile.tsconfig.json');
-        if (!fs.existsSync(depConfig)) {
-            continue;
-        }
-        const relativePath = path.relative(overrideLocation || requestedPackage.location, depWorkspace.location);
-        references.push(relativePath);
-    }
-    return references;
-}
-
-/**
- * Wires a given compilation tsconfig file according to the provided references.
- * This allows TypeScript to operate in build mode.
- *
- * @param {YarnWorkspace} targetPackage for debug purpose.
- * @param {string} tsconfigPath path to the tsconfig file to edit.
- * @param {string[]} references list of paths to the related project roots.
- * @returns {boolean} rewrite was needed.
- */
-function configureTypeScriptCompilation(targetPackage, tsconfigPath, references) {
-    if (!fs.existsSync(tsconfigPath)) {
-        return false;
-    }
-    const tsconfigJson = readJsonFile(tsconfigPath);
-
-    let needRewrite = FORCE_REWRITE;
-
-    if (!tsconfigJson.compilerOptions) {
-        // Somehow no `compilerOptions` literal is defined.
-        tsconfigJson.compilerOptions = {
-            composite: true,
-            rootDir: 'src',
-            outDir: 'lib',
-        };
-        needRewrite = true;
-
-    } else if (!tsconfigJson.compilerOptions.composite) {
-        // `compilerOptions` is missing the `composite` literal.
-        tsconfigJson.compilerOptions = {
-            composite: true,
-            ...tsconfigJson.compilerOptions,
-        };
-        needRewrite = true;
-    }
-
-    /** @type {string[]} */
-    const tsconfigReferences = references
-        .map(reference => path.join(reference, 'compile.tsconfig.json'));
-
-    /** @type {string[]} */
-    const currentReferences = (tsconfigJson['references'] || [])
-        // We will work on a set of paths, easier to handle than objects.
-        .map(reference => reference.path)
-        // Remove any invalid reference (maybe outdated).
-        .filter((referenceRelativePath, index, self) => {
-            if (!tsconfigReferences.includes(referenceRelativePath)) {
-                // Found a reference that wasn't automatically computed, will remove.
-                console.warn(`error: ${targetPackage.name} untracked reference: ${referenceRelativePath}`);
-                needRewrite = true;
-                return false; // remove
-            }
-            if (self.indexOf(referenceRelativePath) !== index) {
-                // Remove duplicates.
-                console.error(`error: ${targetPackage.name} duplicate reference: ${referenceRelativePath}`);
-                needRewrite = true;
-                return false; // remove
-            }
-            const referencePath = path.join(path.dirname(tsconfigPath), referenceRelativePath);
-            try {
-                const referenceStat = fs.statSync(referencePath);
-                if (referenceStat.isDirectory() && fs.statSync(path.join(referencePath, 'tsconfig.json')).isFile()) {
-                    return true; // keep
-                } else if (referenceStat.isFile()) { // still could be something else than a tsconfig, but good enough.
-                    return true; // keep
-                }
-            } catch {
-                // passthrough
-            }
-            console.error(`error: ${targetPackage.name} invalid reference: ${referenceRelativePath}`);
-            needRewrite = true;
-            return false; // remove
-        });
-
-    for (const tsconfigReference of tsconfigReferences) {
-        if (!currentReferences.includes(tsconfigReference)) {
-            console.error(`error: ${targetPackage.name} missing reference: ${tsconfigReference}`);
-            currentReferences.push(tsconfigReference);
-            needRewrite = true;
-        }
-    }
-    if (!DRY_RUN && needRewrite) {
-        tsconfigJson.references = currentReferences.map(path => ({ path }));
-        const content = JSON.stringify(tsconfigJson, undefined, 2);
-        fs.writeFileSync(tsconfigPath, content + '\n');
-        console.warn(`info: ${tsconfigPath} updated.`);
-    }
-    return needRewrite;
-}
-
-/**
- * Wire the root `tsconfig.json` to map scoped import to real location in the monorepo.
- * This setup is a shim for the TypeScript language server to provide cross-package navigation.
- * Compilation is done via `compile.tsconfig.json` files.
- *
- * @param {YarnWorkspace} targetPackage for debug purpose.
- * @param {string} tsconfigPath
- * @returns {boolean} rewrite was needed.
- */
-function configureTypeScriptNavigation(targetPackage, tsconfigPath) {
-    const tsconfigJson = readJsonFile(tsconfigPath);
-
-    let needRewrite = FORCE_REWRITE;
-
-    if (typeof tsconfigJson.compilerOptions === 'undefined') {
-        // Somehow no `compilerOptions` literal is defined.
-        tsconfigJson.compilerOptions = {
-            baseUrl: '.',
-            paths: {},
-        };
-        needRewrite = true;
-
-    } else if (typeof tsconfigJson.compilerOptions.paths === 'undefined') {
-        // `compilerOptions` is missing the `paths` literal.
-        tsconfigJson.compilerOptions = {
-            ...tsconfigJson.compilerOptions,
-            paths: {},
-        };
-        needRewrite = true;
-    }
-
-    /** @type {{ [prefix: string]: string[] }} */
-    const currentPaths = tsconfigJson.compilerOptions.paths;
-
-    for (const packageName of MONOREPO.workspaceDependencies) {
-        const depWorkspace = YARN_WORKSPACES[packageName];
-
-        /** @type {string} */
-        let originalImportPath;
-        /** @type {string} */
-        let mappedFsPath;
-
-        const depSrcPath = path.join(depWorkspace.location, 'src');
-        const depConfigPath = path.join(depWorkspace.location, 'compile.tsconfig.json');
-
-        if (fs.existsSync(depConfigPath) && fs.existsSync(depSrcPath)) {
-            // If it is a TypeScript dependency, map `lib` imports to our local sources in `src`.
-            const depConfigJson = readJsonFile(depConfigPath);
-            originalImportPath = `${packageName}/${depConfigJson.compilerOptions.outDir}/*`;
-            mappedFsPath = path.relative(MONOREPO.location, path.join(depSrcPath, '*'));
-
-        } else {
-            // I don't really know what to do here, simply point to our local package root.
-            originalImportPath = `${packageName}/*`;
-            mappedFsPath = path.relative(MONOREPO.location, path.join(depWorkspace.location, '*'));
-        }
-
-        /** @type {string[] | undefined} */
-        const currentFsPaths = currentPaths[originalImportPath];
-
-        if (typeof currentFsPaths === 'undefined' || currentFsPaths.length !== 1 || currentFsPaths[0] !== mappedFsPath) {
-            console.error(`error: ${targetPackage.name} invalid mapped path: {"${originalImportPath}": "${currentFsPaths}"}`);
-            currentPaths[originalImportPath] = [mappedFsPath];
-            needRewrite = true;
-        }
-    }
-    if (!DRY_RUN && needRewrite) {
-        const content = JSON.stringify(tsconfigJson, undefined, 2);
-        fs.writeFileSync(tsconfigPath, content + '\n');
-        console.warn(`info: ${tsconfigPath} updated.`);
-    }
-    return needRewrite;
-}
-
-/**
- *
- * @param {string[]} argv
- * @param {string} flag
- * @returns {boolean}
- */
-function popFlag(argv, flag) {
-    const flagIndex = argv.indexOf(flag)
-    if (flagIndex !== -1) {
-        argv.splice(flagIndex, 1);
-        return true;
-    } else {
-        return false;
-    }
-}
-
-/**
- * @param {string} filePath
- * @returns {any}
- */
-function readJsonFile(filePath) {
-    try {
-        return JSON.parse(fs.readFileSync(filePath).toString());
-    } catch (error) {
-        console.error('ParseError in file:', filePath);
-        throw error;
-    }
-}
-
-/**
- * @typedef YarnWorkspace
- * @property {string} name
- * @property {string} location
- * @property {string[]} workspaceDependencies
- */

package/templates/monorepo/tsconfig.json

@@ -1,20 +0,0 @@
-{
-  "extends": "@celljs/style-guide/typescript",
-  "compilerOptions": {
-    "allowJs": true,
-    "noEmit": true,
-    "baseUrl": ".",
-    "paths": {
-      "@app/core/lib/*": [
-        "packages/core/src/*"
-      ],
-      "@app/app-sample-app/*": [
-        "apps/sample-app/*"
-      ]
-    }
-  },
-  "include": [
-    "packages/*/src",
-    "apps/*/test"
-  ]
-}

package/templates/monorepo/tsfmt.json

@@ -1,3 +0,0 @@
-{
-  "insertSpaceAfterFunctionKeywordForAnonymousFunctions": true
-}

package/templates/puppeteer/.github/workflows/deploy.yml

@@ -1,25 +0,0 @@
-name: Cell Deploy
-
-on: push
-
-jobs:
-  cell-deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Setup node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '12'
-      - uses: bahmutov/npm-install@v1
-      - run: npm run lint --if-present
-      - run: npm test
-      - if: ${{ github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main' }}
-        env: ${{ secrets }}
-        run: npx cell deploy -m prod
-      - if: ${{ github.ref == 'refs/heads/pre' }}
-        env: ${{ secrets }}
-        run: npx cell deploy -m pre
-      - if: ${{ github.ref != 'refs/heads/master' && github.ref == 'refs/heads/main' && github.ref != 'refs/heads/pre' }}
-        env: ${{ secrets }}
-        run: npx cell deploy -m test

package/templates/puppeteer/.vscode/launch.json

@@ -1,23 +0,0 @@
-{
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Cell Debug",
-            "request": "launch",
-            "runtimeArgs": [
-                "cell",
-                "serve"
-            ],
-            "runtimeExecutable": "npx",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
-            "env": {
-                "NODE_ENV": "development"
-            },
-            "internalConsoleOptions": "openOnSessionStart",
-            "outputCapture": "std",
-            "type": "pwa-node"
-        }
-    ]
-}

package/templates/puppeteer/README.md

@@ -1,92 +0,0 @@
-# 开发说明
-
-## 安装依赖
-
-以下使用 yarn 工具来说明，你也可以使用 npm。
-
-```bash
-# 通过 cell init 初始化应用的时候已经自动安装了依赖，所以你只需要安装你额外需要的依赖即可
-
-$ yarn add xxxx
-```
-
-## 本地运行
-
-```shell
-# 启动本地服务，端口默认 3000 或者 9000
-# 在终端中会输出本地服务的 URL 链接
-
-$ yarn start  # 或者执行 cell serve 命令
-```
-
-## 构建部署
-
-模板默认提供了四套隔离环境：本地（local）、测试（test）、预发（pre）、线上（prod）。每个环境对应着一个 cell 配置文件（可选），类似 cell-test.yml。而 cell.yml 文件一般用于放所有环境的公共配置。第一次部署的时候可能会提示你填写相关云厂商 ak 信息。如果是 Vercel 云平台的模板，会提示你需要登录到 Vercel 平台。你也可以在项目通过 .env 提供云厂商的 ak 信息。
-
-```bash
-
-$ cell deploy -m scf            # 部署到腾讯云函数测试环境
-$ cell deploy -m scf -m test    # 部署到腾讯云测试环境
-$ cell deploy -m scf -m pre     # 部署到腾讯云预发环境
-$ cell deploy -m scf -m prod    # 部署到腾讯云线上环境
-
-```
-
-## 关于 Cell Framework
-
-Cell 是基于 TypeScript 的 Serverless First、组件化、平台无关的渐进式应用框架。
-
-## 特征
-
--   约定大于配置，零配置，开箱即用
--   TypeScript 版 Spring Boot
--   Serverless First
--   平台不锁定
--   支持前后端一体化，前端框架不锁定
--   支持微服务
--   组件化，渐进式
--   命令行工具插件化
--   依赖注入
--   面向切面编程（AOP）
--   集成了流行的 ORM 框架，使用装饰器声明式事务管理
--   支持 OIDC 认证
--   支持 OAuth2 授权
--   使用 rxjs 管理状态
--   提供 REST 和 RPC 两种接口风格
-
-Cell 名字由来：在我的家乡，谐音“吗啦咕”是小石头的意思，小石头堆砌起来可以建成高楼大厦、道路桥梁，而 Cell 组件编排可以实现千变万化的应用。
-
-## 快速开始
-
-```bash
-# 安装命令行工具
-npm install -g @celljs/cli
-
-# 初始化
-cell init -o project-name
-cd project-name            # 进入项目根目录
-
-# 运行
-cell serve
-
-# 部署
-cell deploy
-```
-
-[![Quick Start](https://asciinema.org/a/474104.svg)](https://asciinema.org/a/474104?speed=2.5&autoplay=1)
-
-### 文档
-
--   [介绍](https://cell.cellbang.com/guide/%E4%BB%8B%E7%BB%8D)
--   [创建第一个应用](https://cell.cellbang.com/guide/%E5%88%9B%E5%BB%BA%E7%AC%AC%E4%B8%80%E4%B8%AA%E5%BA%94%E7%94%A8)
--   [命令行工具](https://cell.cellbang.com/guide/%E5%91%BD%E4%BB%A4%E8%A1%8C%E5%B7%A5%E5%85%B7)
--   [控制器](https://cell.cellbang.com/guide/%E6%8E%A7%E5%88%B6%E5%99%A8)
--   [数据库操作](https://cell.cellbang.com/guide/%E6%95%B0%E6%8D%AE%E5%BA%93typeorm)
--   [微服务](https://cell.cellbang.com/dev/%E5%BE%AE%E6%9C%8D%E5%8A%A1)
--   [认证与授权](https://cell.cellbang.com/guide/%E8%AE%A4%E8%AF%81%E4%B8%8E%E6%8E%88%E6%9D%83)
--   [云平台适配](https://cell.cellbang.com/cloud/%E4%BA%91%E5%B9%B3%E5%8F%B0%E9%80%82%E9%85%8D)
--   [依赖注入](https://cell.cellbang.com/guide/%E4%BE%9D%E8%B5%96%E6%B3%A8%E5%85%A5)
--   [组件设计](https://cell.cellbang.com/guide/%E7%BB%84%E4%BB%B6%E8%AE%BE%E8%AE%A1)
--   [前端架构](https://cell.cellbang.com/guide/%E5%89%8D%E7%AB%AF%E6%9E%B6%E6%9E%84)
--   [React 开发](https://cell.cellbang.com/dev/react)
--   [前后端一体化开发](https://cell.cellbang.com/dev/%E5%89%8D%E5%90%8E%E7%AB%AF%E4%B8%80%E4%BD%93%E5%8C%96%E5%BC%80%E5%8F%91)

package/templates/puppeteer/cell.yml

@@ -1,11 +0,0 @@
-mode: fc
-
-cell:
-  cloud:
-    region: cn-hangzhou                            # 指定存放 headless 相关二进制的 oss 的地域，建议与应用部署的地域一致
-    credentials:
-      accessKeyId: xxxxxxxxxxxxxxxxxxxxxxxx         # 指定能够访问存放 headless 相关二进制 accessKeyId，至少具有读该 Object 的权限
-      accessKeySecret: xxxxxxxxxxxxxxxxxxxxxx
-  puppeteer:
-    bucket: headless-lib                            # 指定存放 headless 相关二进制的 oss 的 Bucket 名称 headless-lib
-    object: headless-lib.tar.gz                     # 指定存放 headless 相关二进制的 oss 的 objeck 名称，默认 headless-lib.tar.gz

package/templates/puppeteer/package.json

@@ -1,31 +0,0 @@
-{
-  "name": "puppeteer",
-  "keywords": [
-    "cell-component"
-  ],
-  "version": "0.0.0",
-  "license": "MIT",
-  "files": [
-    "lib",
-    "src"
-  ],
-  "dependencies": {
-    "@celljs/core": "{{ version }}",
-    "@celljs/mvc": "{{ version }}",
-    "@celljs/web": "{{ version }}",
-    "@celljs/puppeteer": "{{ version }}",
-    "@celljs/oss": "{{ version }}"
-  },
-  "devDependencies": {
-    "@celljs/cli": "{{ version }}"
-  },
-  "scripts": {
-    "clean": "rimraf lib dist .cell",
-    "build": "cell build",
-    "start": "cell serve",
-    "deploy": "cell deploy -m fc -m test",
-    "deploy:test": "cell deploy -m fc -m test",
-    "deploy:pre": "cell deploy -m fc -m pre",
-    "deploy:prod": "cell deploy -m fc -m prod"
-  }
-}

package/templates/puppeteer/src/home-controller.ts

@@ -1,11 +0,0 @@
-import { Controller, Get, Text } from '@celljs/mvc/lib/node';
-
-@Controller()
-export class HomeController {
-    
-    @Get()
-    @Text()
-    home(): string {
-        return 'Welcome to Cell';
-    }
-}

package/templates/puppeteer/src/module.ts

@@ -1,5 +0,0 @@
-import './home-controller';
-import './puppeteer-controller';
-import { autoBind } from '@celljs/core';
-
-export default autoBind();

package/templates/puppeteer/src/puppeteer-controller.ts

@@ -1,26 +0,0 @@
-import { Autowired } from '@celljs/core';
-import { Context } from '@celljs/web/lib/node';
-import { Controller, Get, Query, File } from '@celljs/mvc/lib/node';
-import { BrowserProvider } from '@celljs/puppeteer';
-
-@Controller()
-export class PuppeteerController {
-
-    @Autowired(BrowserProvider)
-    protected readonly browserProvider: BrowserProvider;
-
-    @Get('screenshot')
-    @File()
-    async screenshot(@Query('url') url?: string) {
-        const response = Context.getResponse();
-        response.attachment('download.png');
-        const browser = await this.browserProvider.provide();
-        const page = await browser.newPage();
-        try {
-            await page.goto(url || 'https://baidu.com', { waitUntil: 'networkidle0' });
-            return await page.screenshot();
-        } finally {
-            await page.close();
-        }
-    }
-}

package/templates/puppeteer/tsconfig.json

@@ -1,29 +0,0 @@
-{
-  "compilerOptions": {
-    "skipLibCheck": true,
-    "declaration": true,
-    "declarationMap": true,
-    "noImplicitAny": true,
-    "noEmitOnError": false,
-    "noImplicitThis": true,
-    "noUnusedLocals": true,
-    "strictNullChecks": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "downlevelIteration": true,
-    "module": "commonjs",
-    "moduleResolution": "node",
-    "jsx": "react",
-    "target": "ES2017",
-    "lib": [
-      "ES2017",
-      "dom"
-    ],
-    "sourceMap": true,
-    "rootDir": "src",
-    "outDir": "lib"
-  },
-  "include": [
-    "src"
-  ]
-}