programming-tool
所属分类：Leetcode/题库
开发工具：TypeScript
文件大小：0KB
下载次数：0
上传日期：2023-12-26 02:16:27
上 传 者：
sh-1993
说明： 这是一个全面的公司编程工具和组件集合。该项目设计用于支持各种开发需求,包含了从测试、代码检查到格式化和文档生成的多种工具。这个仓库旨在为您的项目提供坚实的基础设施,同时也是公司集体编程实践的积累,希望它能对您的开发工作带来便利。
(This is a comprehensive collection of corporate programming tools and components. The project is designed to support various development requirements, including a variety of tools from testing, code checking to formatting and document generation. This warehouse is designed to provide a solid infrastructure for your project, as well as the accumulation of the company s collective programming practices. I hope it can bring convenience to your development work.)
文件列表:
coverage/
docs/
src/
CHANGELOG.md
LICENSE
commitlint.config.js
jest.config.js
package.json
package.jsonc
pnpm-lock.yaml
tsconfig.json
typedoc.json
vite.config.js
# lujh
## Languages
- [English](https://github.com/abc821178885/programming-tool/blob/master/README.md)
- [中文](https://github.com/abc821178885/programming-tool/blob/master/README.zh.md)
Welcome to lujh, a comprehensive collection of company programming utilities and components by lujh Group. This project is designed to be a versatile toolkit for various development needs, encompassing testing, linting, formatting, and documentation generation.
## Getting Started
1.**Clone the repository**
2.**Install the dependencies**
Make sure you have Node.js (v18.0.0 or newer) and npm (v8.0.0 or newer) installed. This project recommends using pnpm for managing dependencies, although npm or yarn would work just fine.
```bash
pnpm install
```
## Scripts
Here are some scripts provided to help you manage the project:
- **Testing:** Run tests using Jest.
```bash
pnpm run test
```
- **Linting:** Check your code for stylistic and programming errors with ESLint.
```bash
pnpm run lint
```
- **Formatting:** Format your code with Prettier.
```bash
pnpm run format
```
- **Check Formatting:** Check if your code is well formatted.
```bash
pnpm run check-format
```
- **Cleaning:** Delete the \`dist\` directory to clean old build outputs.
```bash
pnpm run clean
```
- **Documentation:** Generate documentation for your code with TypeDoc.
```bash
pnpm run docs
```
- **Building:** Build your project with Vite.
```bash
pnpm run build
```
- **Committing Changes:** We use Commitizen for formatted commit messages.
```bash
pnpm run commit
```
This command will prompt you for details about the commit which will then be formatted according to conventional commit standards.
## Committing Guidelines
We follow the Conventional Commits guidelines for commit messages. When you're ready to commit your changes, run \`pnpm run commit\` and follow the prompts to generate a formatted commit message.
## Documentation
The generated documentation will be placed in the \`./docs\` directory, which you can browse locally or host it on a web server.
## Issues and Feedback
For bugs reporting, feature requests or any other feedback, please visit [GitHub Issues](https://github.com/abc821178885/programming-tool/blob/master/http://gitlab.lujh88.com/ganxing/lujh/issues).
## License
This project is licensed under the ISC license. For more information, see the [LICENSE](https://github.com/abc821178885/programming-tool/blob/master/LICENSE) file in the repository.
---
Thank you for checking out lujh. Happy coding!
近期下载者：
相关文件：
收藏者：