Brazilian-Values 项目教程

Brazilian-Values 项目教程

brazilian-values🇧🇷 Funções de formatação, conversão e validação para valores, documentos e outras unidades usadas no Brasil. Como CEP, CNPJ, CPF, BRL (R$), datas, números etc.项目地址:https://gitcode.com/gh_mirrors/br/brazilian-values

1. 项目目录结构及介绍

brazilian-values/
├── dist/
│   ├── index.js
│   ├── index.d.ts
│   └── ...
├── src/
│   ├── formatters/
│   │   ├── formatToBRL.js
│   │   ├── formatToCNPJ.js
│   │   └── ...
│   ├── parsers/
│   │   ├── parseToDate.js
│   │   ├── parseToNumber.js
│   │   └── ...
│   ├── validators/
│   │   ├── isCNPJ.js
│   │   ├── isCPF.js
│   │   └── ...
│   ├── index.js
│   └── ...
├── .gitignore
├── package.json
├── README.md
└── ...

目录结构介绍

• dist/: 包含编译后的 JavaScript 文件和类型定义文件。

  • index.js: 主入口文件。
  • index.d.ts: TypeScript 类型定义文件。

• src/: 包含项目的源代码。

  • formatters/: 包含格式化巴西值的函数。
    • formatToBRL.js: 格式化巴西货币（BRL）。
    • formatToCNPJ.js: 格式化巴西 CNPJ 号码。
    • ...
  • parsers/: 包含解析巴西值的函数。
    • parseToDate.js: 解析日期。
    • parseToNumber.js: 解析数字。
    • ...
  • validators/: 包含验证巴西值的函数。
    • isCNPJ.js: 验证 CNPJ 号码。
    • isCPF.js: 验证 CPF 号码。
    • ...
  • index.js: 项目的入口文件。

• .gitignore: Git 忽略文件配置。

• package.json: 项目的依赖和脚本配置。

• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js，它作为项目的入口文件，导出了所有格式化、解析和验证巴西值的函数。

// src/index.js
export * from './formatters';
export * from './parsers';
export * from './validators';

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的元数据和依赖配置。以下是一些关键配置项：

{
  "name": "brazilian-values",
  "version": "1.0.0",
  "description": "Validates and formats brazilian values like money (BRL), CPF, CNPJ, dates, etc.",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "some-dependency": "^1.0.0"
  },
  "devDependencies": {
    "typescript": "^4.0.0",
    "jest": "^26.0.0"
  }
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 主入口文件路径。
• types: TypeScript 类型定义文件路径。
• scripts: 包含项目的构建和测试脚本。
• dependencies: 项目运行时的依赖。
• devDependencies: 项目开发时的依赖。

.gitignore

.gitignore 文件用于配置 Git 忽略的文件和目录，避免将不必要的文件提交到版本库中。

node_modules/
dist/
*.log

• node_modules/: 忽略 node_modules 目录。
• dist/: 忽略编译后的 dist 目录。
• *.log: 忽略所有日志文件。

README.md

README.md 文件是项目的说明文档，通常包含项目的介绍、安装方法、使用示例等内容。

# Brazilian Values

Validates and formats brazilian values like money (BRL), CPF, CNPJ, dates, etc.

## Installation

```bash
npm install brazilian-values --save

Usage

import { formatToBRL, isCNPJ } from 'brazilian-values';

console.log(formatToBRL(100)); //=> 'R$ 100,00'
console.log(isCNPJ('12.727.442/0001-13')); //=> true

以上是 `brazilian-values` 项目的目录结构、启动文件和配置文件的介绍。

brazilian-values🇧🇷 Funções de formatação, conversão e validação para valores, documentos e outras unidades usadas no Brasil. Como CEP, CNPJ, CPF, BRL (R$), datas, números etc.项目地址:https://gitcode.com/gh_mirrors/br/brazilian-values