Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/2214962083/ios-scriptable-tsx

在 vscode 上使用 typescript 和 jsx 开发 ios 小组件的小框架.基于 Scriptable app.
https://github.com/2214962083/ios-scriptable-tsx

ios ios-widget jsx scriptable scriptable-object tsx typescript vscode widget

Last synced: about 1 month ago
JSON representation

在 vscode 上使用 typescript 和 jsx 开发 ios 小组件的小框架.基于 Scriptable app.

Host: GitHub
URL: https://github.com/2214962083/ios-scriptable-tsx
Owner: 2214962083
License: mit
Created: 2020-11-20T09:49:37.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2021-01-06T09:35:58.000Z (about 4 years ago)
Last Synced: 2024-11-18T16:45:49.958Z (about 2 months ago)
Topics: ios, ios-widget, jsx, scriptable, scriptable-object, tsx, typescript, vscode, widget
Language: JavaScript
Homepage:
Size: 503 KB
Stars: 128
Watchers: 11
Forks: 22
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        




  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  



ios-scriptable-tsx






## 介绍

本项目旨在给 `Scriptable` 开发者提供舒适的开发体验,  `Scriptable` 是 ios 上一个用 js 开发桌面小组件的 app ，如果你还没安装，可以[点我下载](https://apps.apple.com/us/app/scriptable/id1405459188)




`ios-scriptable-tsx` 是一个二次封装 `Scriptable` 官方 api 的开发框架，它具有以下特点：




**1. 支持在 pc 开发，支持实时监听修改、编译同步到手机运行。**




**2. 支持使用 typescript 和 tsx 开发小组件，支持 api 类型提示、自动补全。**




**3. 支持打包混淆、加密 js。**




**4. 支持远程输出 console 日志到 pc 的命令窗口。**




**5. 支持环境变量定义，打包时自动替换环境变量为预设值。**




**6. 常用函数封装，使用更便捷。**




## 使用

1. 先克隆本仓库

    ```bash

    git clone https://github.com/2214962083/ios-scriptable-tsx.git

    ```




2. 进入到 `ios-scriptable-tsx` 目录里，执行 `npm install` 安装依赖

   




3. 打开 vscode 愉快开发，打包入口文件默认是 `./src/index.ts`

   




4. 执行 `npm run build` 打包到 `./dist` 文件夹




## 文档

- [快速上手](./docs/quick-start.md#quick-start)

- [命令说明](./docs/quick-start.md#command-introduction)

- [项目目录说明和配置指南](./docs/config.md#config-introduction)

  - [项目目录说明](./docs/config.md#project-dir-introduction)

  - [打包配置](./docs/config.md#scriptable-config)

  - [其他配置](./docs/config.md#others-config)

  - [环境变量](./docs/config.md#env-config)

- [JSX 组件](./docs/widget-element.md#jsx-element)

  - [wbox 盒子组件](./docs/widget-element.md#wbox)

  - [wstack 容器组件](./docs/widget-element.md#wstack)

  - [wimage 图片组件](./docs/widget-element.md#wimage)

  - [wspacer 空格占位组件](./docs/widget-element.md#wspacer)

  - [wtext 文字组件](./docs/widget-element.md#wtext)

  - [wdate 日期组件](./docs/widget-element.md#wdate)

- [常用函数封装](https://github.com/2214962083/ios-scriptable-tsx/blob/master/src/lib/help.ts)

- [常见问题](./docs/questions.md)

- [Scriptable 官方 api 文档](https://docs.scriptable.app/)



## 讨论

- [Scriptable 官方论坛](https://talk.automators.fm/c/scriptable/13)



## 项目参考

- [「小件件」开发框架](https://github.com/im3x/Scriptables)

- [Scriptable](https://github.com/dompling/Scriptable)

- [Transparent-Scriptable-Widget](https://github.com/mzeryck/Transparent-Scriptable-Widget)



## 许可证

[MIT](https://opensource.org/licenses/MIT)

Copyright (c) 2020-present, Yang xiaoming