开源项目 `creditcards` 使用教程

开源项目 creditcards 使用教程

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

creditcards/
├── LICENSE
├── README.md
├── index.js
├── lib/
│   ├── card-number.js
│   ├── cvc.js
│   ├── expiration.js
│   ├── index.js
│   └── parse.js
├── package.json
└── test/
    ├── card-number.test.js
    ├── cvc.test.js
    ├── expiration.test.js
    └── parse.test.js

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• index.js: 项目入口文件。
• lib/: 包含项目的主要功能模块。
  • card-number.js: 处理信用卡号码的模块。
  • cvc.js: 处理信用卡安全码的模块。
  • expiration.js: 处理信用卡有效期的模块。
  • index.js: 模块入口文件。
  • parse.js: 解析信用卡信息的模块。
• package.json: 项目的依赖和配置文件。
• test/: 包含项目的测试文件。
  • card-number.test.js: 信用卡号码模块的测试文件。
  • cvc.test.js: 信用卡安全码模块的测试文件。
  • expiration.test.js: 信用卡有效期模块的测试文件。
  • parse.test.js: 解析信用卡信息模块的测试文件。

2. 项目的启动文件介绍

项目的启动文件是 index.js，它作为项目的入口点，导入了 lib 目录下的主要功能模块，并提供了对外的接口。

// index.js
module.exports = require('./lib');

3. 项目的配置文件介绍

项目的配置文件是 package.json，它包含了项目的基本信息、依赖包、脚本命令等。

{
  "name": "creditcards",
  "version": "3.1.1",
  "description": "Utility methods for credit card data",
  "main": "index.js",
  "scripts": {
    "test": "mocha"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/bendrucker/creditcards.git"
  },
  "keywords": [
    "credit",
    "card",
    "validation",
    "payment"
  ],
  "author": "Ben Drucker <bvdrucker@gmail.com> (http://www.bendrucker.me/)",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/bendrucker/creditcards/issues"
  },
  "homepage": "https://github.com/bendrucker/creditcards#readme",
  "devDependencies": {
    "chai": "^4.2.0",
    "mocha": "^6.2.2"
  },
  "dependencies": {
    "fast-luhn": "^1.0.1"
  }
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 项目入口文件。
• scripts: 项目脚本命令。
• repository: 项目仓库信息。
• keywords: 项目关键词。
• author: 项目作者。
• license: 项目许可证。
• bugs: 项目问题追踪链接。
• homepage: 项目主页。
• devDependencies: 开发依赖包。
• dependencies: 运行依赖包。