acode-plugin
To create plugin for Acode editor use this template. To use this template create a github repository and add https://github.com/deadlyjack/acode-plugin as template.
Required Files
-
plugin.json - contains information about the plugin.
-
id - plugin should have unique id. E.g. com.example.my-plugin
-
name - plugin name.
-
version - plugin version, if changes an update notificaiton will be sent to users.
-
main - plugins main js file.
-
icon - plugin icon.
-
readme - readme file.
-
files - list of all files that are required by the plugin.
-
author - author of the plugin
- name - name of the author
- email - email of the author
- github - github username of the author
-
-
icon.png - icon for the plugin
Transpile your javascript file using babel so that your plugin can work on older android devices. This template already has all the configuration that is required to tranpile your javascipt file and scss file. You need to run yarn build command to bundle your code. To build for production run yarn build --mode production.
Add your plugin to Acode
To add your plugin, fork this repository, clone it, add your plugin information to list.json and make a pull request.
To initialize your plugin, use acode.setPluginInit method. This method requires two arguments.
-
plugin id
-
callback funtion, callback function will receive three arguments.
-
baseUrl, it contains the location of the plugin files. To get plugin files from the device, concat baseUrl and file name. E.G.
baseUrl + 'script.js'. -
$page, a page that your plugin can use to show output if required.
-
cacheFile, an Object that contains url and fs for cacheFile
- cachefile, use this write and read from cache file specially for this plugin.
- cacheFileUrl, url of the cache file.
-
You also need to set an unmount function, this is called when user choose to uninstall the plugin. acode.setPluginUnmount method can be used to set unmount function. This method requires two arguments.
- plugin id
- callback function
Plugin Development
You can take reference from already available plugins acode-plugin-python and acode-plugin-prettier.
Testing
-
To test your plugin clone Acode repository.
-
Change your local IP in this file.
-
Add your local plugin here.
-
Run app using
yarn startcommand. -
Add install your local plugin from
Settings > Plugins > "Your plugin" > Install
Requirement
To test your plugin clone Acode repository. Add your local IPV4 to res/network_security_config.xml file. Use VS Code live server to serve your plugin files via localhost or use any other server to host your local plugin. Add your local plugin to src/pages/plugins/plugins.include.js file. This will load your local plugin in settings -> plugins.
Global API
The global variables that you can use them directly in your plugin.
editorManager
-
editor: AceAjax.EditorAce editor -
addNewFile(filename?:string, options?): voidadd a new file in workspace.-
options: ObjectOptional object that you can pass.text: stringfile content.isUnsaved: booleanis file unsaved.render: booleanswitch to this file.id: stringunique id of tile.uri: stringfile uri, location of file.record: RecorddeletedFile: booleanis file deleted.readOnly: booleanis file readonly.mode: stringSAF (Storage access framework) mode, (TREE | SINGLE).type: stringfile type, (regular | git | gist).encoding: stringfile encoding.onsave(): voidcallback function called when file is saved.
-
-
getFile(test: any, type: string)gets files from opened files.test: anyfile id, uri, repo, gist to find the file.type: stringtype of test (uri | id | name | git | gist).
-
switchFile(id: string): voidswitch tab to given file id. -
activeFile: Filecurrent file. -
hasUnsavedFiles(): numberget the number of unsaved files. -
files: Array<File>list of all files. -
setSubText(file: File): voidsets sub text of the header i.e. location of the file. -
container: HTMLDivElementcontainer of the editor. -
state: stringeditor is blured or focused. -
on(event: string, listener(): void): voidadds a listener. -
off(event: string, listener(): void): voidremoves a listener. -
emit(event: string, ...args: ...any)emits an event.-
List of events
switch-filerename-filesave-filefile-content-changedupdate
-
acode
exec(command: string, value: any)setPluginInit(id: string, initfuntion(): void)setPluginUnmount(id: string, unmountFunction(): void)registerFormatter(id: string, externsions: Array<string>, format():Promise<void>)fsOperation(file: string): FsOperation
actionStack
-
push(action: Object): voidPushes a callback function to actionStack. When use tap on physical/virtual back button, the given callback function is triggered.- action
idaction():void
- action
-
pop(): Actionpops top item from the stack -
remove(id: string):voidremoves an item from stack -
length: numberlength of the stack -
setMark(): voidsets a marker to current length of stack -
clearfromMark(): voidclears all the items from stack form the marker.
appSettings
valueall settings.on(event: string, listener(setting: any): void): voidattaches event listener.off(event: string, listener(setting: any): void): voidremoves event listener.update(settings: Object, showToast: Boolean): voidupdate settings.reset(setting: Object): voidreset settings.get(setting: string): Objectgets settings value.
Events
- update:<setting name>
Show toast
Function window.toast(msg: string, milliSecond: number): void will show a toast message for specified time.
Data storage
window.DATA_STORAGE stores the url of data directory.
Cache storage
window.CACHE_STORAGE stores the url of cache storage.
Native APIs
To access native features and method of device use these plugins. For example to open a file using SAF
sdCard.openDocumentFile(async (uri) => {
const fs = acode.fsOperation(uri);
const stat = await fs.stat();
const text = await fs.readFile('utf8');
editorManager.addNewFile(stat.name, {
uri,
text,
render: true
});
})
To get more info api provided by these plugins see there js files in www directory.
FsOperation
lsDir(): Promise<Array<Entry>>readFile(encoding: string | ArrayBuffer): Promise<string | ArrayBuffer>createFile(name: string, content?: string): Promise<string>writeFile(content: string | ArrayBuffer): Promise<void>createDirectory(name: string): Promise<string>delete(): Promise<void>copyTo(destination: string): Promise<string>moveTo(destination: string): Promise<string>renameTo(newName: string): Promise<string>exists(): Promise<Boolean>stat(): Promise<Stat>
WcPage
See for more info.
show()hide()
3 May 18, 2022
4 May 3, 2022
14 Jan 3, 2023
3 Nov 26, 2022
10 Aug 10, 2022
8 Nov 23, 2022
12.2k Dec 30, 2022
1.1k Dec 20, 2022
4 Aug 6, 2022
2 Apr 11, 2022