GraphQL Scalars 项目教程

1. 项目的目录结构及介绍

graphql-scalars/
├── src/
│   ├── scalars/
│   │   ├── DateTime.ts
│   │   ├── EmailAddress.ts
│   │   ├── ...
│   ├── index.ts
├── tests/
│   ├── scalars/
│   │   ├── DateTime.test.ts
│   │   ├── EmailAddress.test.ts
│   │   ├── ...
├── package.json
├── tsconfig.json
├── README.md

目录结构介绍

• src/: 项目的源代码目录，包含了所有的自定义标量类型。

  • scalars/: 存放了各种自定义标量类型的实现文件，如 DateTime.ts、EmailAddress.ts 等。
  • index.ts: 项目的入口文件，导出了所有的自定义标量类型。

• tests/: 项目的测试代码目录，包含了所有自定义标量类型的测试文件。

  • scalars/: 存放了各种自定义标量类型的测试文件，如 DateTime.test.ts、EmailAddress.test.ts 等。

• package.json: 项目的配置文件，包含了项目的依赖、脚本等信息。

• tsconfig.json: TypeScript 的配置文件，定义了 TypeScript 编译器的配置选项。

• README.md: 项目的说明文档，包含了项目的介绍、安装、使用等信息。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts，该文件导出了所有的自定义标量类型，使得其他项目可以通过导入该文件来使用这些标量类型。

// src/index.ts

export * from './scalars/DateTime';
export * from './scalars/EmailAddress';
// 其他标量类型的导出

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的依赖、脚本等信息。以下是一些关键配置项的介绍：

{
  "name": "graphql-scalars",
  "version": "1.0.0",
  "main": "dist/index.js",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "graphql": "^15.5.0"
  },
  "devDependencies": {
    "@types/jest": "^26.0.20",
    "jest": "^26.6.3",
    "typescript": "^4.2.3"
  }
}

• name: 项目的名称。
• version: 项目的版本号。
• main: 项目的入口文件路径。
• scripts: 定义了项目的脚本命令，如 build 用于编译 TypeScript 代码，test 用于运行测试。
• dependencies: 项目的运行时依赖，如 graphql。
• devDependencies: 项目的开发依赖，如 jest 和 typescript。

tsconfig.json

tsconfig.json 文件定义了 TypeScript 编译器的配置选项。以下是一些关键配置项的介绍：

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "**/*.spec.ts"]
}

• compilerOptions: 编译器的配置选项。
  • target: 指定编译后的 JavaScript 版本。
  • module: 指定模块系统。
  • strict: 启用所有严格类型检查选项。
  • esModuleInterop: 允许使用 ES 模块语法导入 CommonJS 模块。
  • skipLibCheck: 跳过对库文件的类型检查。
  • forceConsistentCasingInFileNames: 强制文件名大小写一致。
• include: 指定需要编译的文件或目录。
• exclude: 指定不需要编译的文件或目录。

通过以上配置，项目可以正确地编译和运行。