https://github.com/viarotel-org/cleants
🧹 Convert TypeScript to a cleaner JavaScript project
https://github.com/viarotel-org/cleants
clean cli converter js neat npx pure ts ts2js vue vue3
Last synced: 3 months ago
JSON representation
🧹 Convert TypeScript to a cleaner JavaScript project
- Host: GitHub
- URL: https://github.com/viarotel-org/cleants
- Owner: viarotel-org
- License: mit
- Created: 2024-10-16T06:56:09.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-26T08:06:32.000Z (11 months ago)
- Last Synced: 2025-04-19T20:53:46.916Z (6 months ago)
- Topics: clean, cli, converter, js, neat, npx, pure, ts, ts2js, vue, vue3
- Language: JavaScript
- Homepage: https://viarotel.eu.org/
- Size: 145 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README-CN.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Cleants
[](https://npmjs.com/package/cleants)
[](https://npm.chart.dev/cleants)
> 🧹 将 TypeScript 转换为更简洁的 JavaScript 项目
## 功能
- 🖖 **Vue 优先**：优先支持 Vue 项目转换
- 🔌 **可扩展**：通过插件系统支持多种文件类型
- ⚡ **极致快速**：使用 `ts.transpileModule` 进行快速编译
- 🖥️ **用户友好的 CLI**：一条命令快速转换
- 🧩 **无缝集成**：作为 npm 包导入，轻松集成到项目中
- 🛠️ **可自定义**：通过灵活的选项微调转换过程
- 📊 **进度追踪**：实时反馈转换状态
- 🎯 **选择性转换**：在复制和转换过程中忽略特定模式
- 📦 **依赖管理**：可选择移除指定依赖
- 🔄 **导入优化**：支持替换内部导入
## 安装
```shell
npm install cleants
# 或
yarn add cleants
# 或
pnpm add cleants
```
## 使用方法
### CLI 使用方法
```shell
npx cleants
```
### 编程使用方法
```javascript
import { Cleants } from 'cleants'
const cleaner = new Cleants(inputDir, outputDir, options)
await cleaner.run()
```
### 外部配置文件
> 你可以在执行命令目录下添加 `cleants.config.js` 文件来指定更多配置
```javascript
module.exports = {
inputDir: 'D:\\Projects\\demo',
outputDir: 'C:\\Users\\viarotel\\Downloads',
compilerOptions: {},
ignoredCopyPatterns: [
'.git',
'dist',
/\.d\.ts$/,
file => file.includes('node_modules'),
file => file.endsWith('.log')
],
ignoredConversionPatterns: [
'vendor',
/\.min\.js$/,
file => file.includes('legacy')
],
getOutputDir: inputDir => `${path.basename(inputDir)}.cleants`,
removeDependencies: ['typescript', 'vue-tsc', '@types/node'],
replaceInternalImports: true,
plugins: []
}
```
## API
### `Cleants`
该类是将 TypeScript 项目转换为更简洁的 JavaScript 项目的主要类。
#### 构造函数
`constructor(inputDir: string, outputDir: string, options?: CleantsOptions)`
##### 参数
- `inputDir: string` - 输入目录路径
- `outputDir: string` - 输出目录路径
- `options?: CleantsOptions` - 可选配置选项
#### CleantsOptions
##### `progressCallback?: Function`
进度回调函数。
默认值：`undefined`
##### `compilerOptions?: Object`
TypeScript 编译器选项。
默认值：`{}`
##### `ignoredCopyPatterns?: Array`
在复制阶段要忽略的模式。
默认值：
```javascript
[
'.git',
'dist',
/\.d\.ts$/,
file => file.includes('node_modules'),
file => file.endsWith('.log')
]
```
##### `ignoredConversionPatterns?: Array`
在转换阶段要忽略的模式。
默认值：
```javascript
[
'vendor',
/\.min\.js$/,
file => file.includes('legacy')
]
```
##### `getOutputDir?: Function`
获取输出目录的函数。
默认值：`inputDir => `${path.basename(inputDir)}.cleants``
##### `removeDependencies?: Array`
要移除的依赖。
默认值：`['typescript', 'vue-tsc', '@types/node']`
##### `replaceInternalImports?: boolean`
是否替换内部导入。
默认值：`true`
##### `plugins?: Array`
要使用的插件列表。
默认值：`[basePlugin, vuePlugin]`
#### 注意
- `actualOutputDir` 将设置为 `path.join(outputDir, options.getOutputDir(inputDir))`
- 如果没有提供 `options.plugins`，默认使用 `[basePlugin, vuePlugin]`
## 贡献
欢迎贡献、提出问题和功能请求！请随时查看 [issues 页面](https://github.com/viarotel-org/cleants/issues)。
## 支持
如果这个项目对你的工作或学习有所帮助，请考虑为项目点赞或通过以下链接请我喝杯咖啡：
## 贡献者
感谢所有贡献者！
## 📚 关键词
`typescript` `javascript` `converter` `vue` `cli`
## 许可证
此项目依据 [MIT](LICENSE) 许可证发布。