@2600hz/commio-native-utilities 中文文档教程

Question

@2600hz/commio-native-utilities

包含所有可共享实用程序和配置文件的库，用 Javascript 编写。

[](https://img.shields.io/npm/ v/@2600hz/commio-native-utilities?style=flat-square) [](https://github.com/prettier/prettier)

---

2600Hz - Commio

JS Utilities Library

Installation

yarn add @2600hz/commio-native-utilities

Usage

import { capitalize, humanize } from '@2600hz/commio-native-utilities';

// ...

<Text>{capitalize(headerText)}</Text>
<Button title={humanize(buttonName)} onPress={}.... />

您还可以直接从文件夹

const {
  prettierBaseConfig,
} = require('@2600hz/commio-native-utilities/lib/prettier-config');

prettierBaseConfig.jsxBracketSameLine = false;

module.exports = prettierBaseConfig;

配置文件 导入或要求 您可以扩展以下任何配置：

• eslint (.eslintrc.js)
• prettier (..prettierrc.js)
• release-it (.release-it.js)
• commitlint (commitlint.config.js)
• svgrrc (.svgrrc.js)
• jest (jest.config.js)
• lint-staged (lint-staged.config.js)
• tsconfig (tsconfig.json)

所有配置文件都以相同的方式导入和使用，只有两个文件需要不同的处理

eslint Eslint文件导出一个接收根文件夹

const {
  eslintBaseConfig,
} = require('@2600hz/commio-native-utilities/lib/eslint-config');

module.exports = eslintBaseConfig(__dirname);

tsconfig 的函数 此文件必须从任何可用的 ts 配置文件扩展

{
  "extends": "@2600hz/commio-native-utilities/tsconfig.base",
  "compilerOptions": {
    "baseUrl": "./",
    ...
  },
  "exclude": [...],
  "include": [...],
}

Development

此项目需要 Node.js v14+ 才能运行。

使用 .nvmrc 文件有助于规范所有维护者使用的节点版本。 如果您需要使用此文件中指定的版本，请运行这些命令。

nvm use
nvm install

使用包管理器 yarn v1+ 安装依赖项和 devDependencies。

yarn install
# Or just
yarn

创建符号链接 在包根文件夹上运行以下命令，以便您可以在本地使用应用

yarn link

观看项目 每当有变化时构建包

yarn watch

使用包 两个项目必须放在同一个文件夹中，否则将无法工作

yarn link @2600hz/commio-native-utilities

构建包 将自动构建项目

yarn build

Utilities

使用 Eslint

yarn run lint:fix

格式化代码 使用 Prettier

yarn run format

使用 Prettier 和 Eslint

yarn run prettify

检查文件上的 Typescript

yarn run typescript

运行全面检查

yarn run full-check

Tech

Components 库使用了一些开源项目来正常工作：

• Typescript - Strongly typed programming language which builds on JavaScript
• NodeJs - Allows execute javascript scripts on the terminal
• Luxon - library for dealing with dates and times in JavaScript (better alternative than Moment.js)

Contributing

欢迎请求请求。 对于重大更改，请先打开一个问题来讨论您想要更改的内容。

请参阅贡献指南，了解如何为存储库和开发工作流程做出贡献。

承诺 提交必须遵循常规提交格式 确保您的消息看起来像以下示例

feat: Adding new badge component
fix: Touchable component not being exported correctly
fix!: Drop support for Typescript

请注意，最后一个将生成主要提交。 它与添加重大更改页脚具有相同的结果

按照Semantic Versioning 2.0.0 更新项目版本。

Release-It 将负责版本控制，您只需提供正确的类型即可提交：

• fix - to indicate a bug fix (PATCH) ex . v0.0.1
• feat - to indicate a new feature (MINOR) ex. v0.1.0
• chore - for updates that do not require a version bump (.gitignore, comments, etc.)
• docs - for updates to the documentation
• BREAKING CHANGE - regardless of type, indicates a Major release (MAJOR) ex. v1.0.0

访问 常规提交 获取更多示例。

发布 在上次提交/修改后运行以下命令。 然后用 Y/N 回答提示

yarn release

License

MIT