feat: 🚀 Optimizing CLI Processes

README.md

@@ -1,2 +1,103 @@
-# cleants
-Convert TypeScript to a cleaner JavaScript project
+# Cleants
+
+[![npm version][]](https://www.npmjs.com/package/cleants)[![License: MIT][]](https://opensource.org/licenses/MIT)
+
+🧹 Convert TypeScript to a cleaner JavaScript project
+
+## Features
+
+- Vue: 对 Vue 项目转换具有第一优先级的支持
+- 可扩展: 通过插件扩展对不同类型文件转换支持
+- 快速的: 使用 ts.transpileModule 具有极快的转译速度
+- 便捷性: 提供 CLI 命令只需要一句命令即可快速转换
+- 集成: 你可以导入NPM包将集成到你的项目中
+
+## Install
+
+```bash
+npm install cleants
+# or
+yarn add cleants
+# or
+pnpm add cleants
+```
+
+## Usage
+
+1. CLI Usage
+
+```bash
+npx cleants
+```
+
+2. Programmatic Usage
+
+```javascript
+import { Cleants } from 'cleants'
+
+const cleaner = new Cleants(inputDir, outputDir, options)
+await cleaner.run()
+```
+
+当然，我可以为您将该 JSDoc 转换为简洁美观的 Markdown 格式。以下是转换后的 API 文档：
+
+## API
+
+### `Cleants`
+
+主要类，用于将 TypeScript 项目转换为更清洁的 JavaScript 项目。
+
+#### 构造函数
+
+```typescript
+constructor(inputDir: string, outputDir: string, options?: CleantsOptions)
+```
+
+##### 参数
+
+- `inputDir: string` - 输入目录路径
+- `outputDir: string` - 输出目录路径
+- `options?: CleantsOptions` - 可选配置选项
+
+##### CleantsOptions
+
+| 选项                         | 类型                                  | 描述                  |
+| ---------------------------- | ------------------------------------- | --------------------- |
+| `progressCallback?`          | `Function`                            | 进度回调函数          |
+| `compilerOptions?`           | `Object`                              | TypeScript 编译器选项 |
+| `ignoredCopyPatterns?`       | `Array<string \| RegExp \| Function>` | 复制时要忽略的模式    |
+| `ignoredConversionPatterns?` | `Array<string \| RegExp \| Function>` | 转换时要忽略的模式    |
+| `getOutputDir?`              | `Function`                            | 获取输出目录的函数    |
+| `removeDependencies?`        | `Array<string>`                       | 要移除的依赖项        |
+| `replaceInternalImports?`    | `boolean`                             | 是否替换内部导入      |
+
+## Contributing
+
+Contributions, issues and feature requests are welcome! Feel free to check [issues page](https://github.com/viarotel-org/cleants/issues).
+
+## Support
+
+If you feel that this project is helpful for your work or study, please help me order a ✨ Star, which will be a great encouragement and support for me, or you can buy me a cup of coffee below
+
+<div style="display:flex;">
+  <img src="https://cdn.jsdelivr.net/gh/viarotel-org/escrcpy@main/screenshots/zh-CN/viarotel-wepay.jpg" alt="viarotel-wepay" width="30%">
+  <img src="https://cdn.jsdelivr.net/gh/viarotel-org/escrcpy@main/screenshots/zh-CN/viarotel-alipay.jpg" alt="viarotel-alipay" width="30%">
+  <a href="https://www.paypal.com/paypalme/viarotel" target="_blank" rel="noopener noreferrer">
+    <img src="https://cdn.jsdelivr.net/gh/viarotel-org/escrcpy@main/screenshots/en-US/viarotel-paypal.png" alt="viarotel-paypal" width="30%">
+  </a>
+</div>
+
+## Contributors
+
+Thanks for all their contributions!
+
+<a href="https://github.com/viarotel-org/cleants/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=viarotel-org/cleants" alt="contributors" />
+</a>
+
+## 📚 Keywords
+`typescript` `javascript` `converter` `electron` `vue`
+
+## License
+
+This project is licensed under the [MIT](LICENSE) License.

eslint.config.js

@@ -3,7 +3,6 @@ import antfu from '@antfu/eslint-config'
 export default antfu(
   {
     typescript: false,
-    markdown: false,
     ignores: [
       '.github',
       '.vscode',
@@ -36,12 +35,12 @@ export default antfu(
       'prefer-promise-reject-errors': 'off',
       'no-unused-expressions': 'off',
       'sort-imports': 'off',
+      'no-useless-constructor': 'off',
 
       'unicorn/consistent-function-scoping': 'off',
       'regexp/no-unused-capturing-group': 'off',
       'regexp/no-dupe-disjunctions': 'off',
       'perfectionist/sort-imports': 'off',
-      'antfu/no-top-level-await': 'off',
     },
   },
 )

package.json

@@ -14,7 +14,6 @@
     "typescript",
     "javascript",
     "converter",
-    "electron",
     "vue"
   ],
   "publishConfig": {

src/bin.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 
 import Cleants from './index.js'
+import { capitalizeFirstLetter } from './helpers/index.js'
 import yargs from 'yargs'
 import { hideBin } from 'yargs/helpers'
 import * as p from '@clack/prompts'
@@ -9,7 +10,7 @@ import ora from 'ora'
 
 yargs(hideBin(process.argv))
   .command('$0', description, () => {}, async (argv) => {
-    p.intro(`Welcome to ${name} v${version}`)
+    p.intro(`${capitalizeFirstLetter(name)}: ${description}. Supported by Viarotel v${version}`)
 
     const inputDir = await p.text({
       message: 'Enter the TypeScript project directory to convert:',

src/helpers/index.js

@@ -58,3 +58,14 @@ export function getNewFilePath(filePath) {
 
   return filePath.replace(ext, extensionMap[ext])
 }
+
+/**
+ * 将字符串首字母转为大写
+ * @param {*} str
+ * @returns {string}
+ */
+export function capitalizeFirstLetter(str) {
+  if (!str)
+    return str
+  return str.charAt(0).toUpperCase() + str.slice(1)
+}