aboutsummaryrefslogtreecommitdiff
path: root/SPEC.md
diff options
context:
space:
mode:
authorjgmdev <jgmdev@gmail.com>2023-05-23 17:02:57 -0400
committerjgmdev <jgmdev@gmail.com>2024-03-13 15:04:16 -0400
commit1b804dca9db26013d1522a27b24fdb58c6e14b75 (patch)
tree61cf31b7df179b20cda18d9eee04952bcde6e88a /SPEC.md
parentf677376167b401b2c8f9154ac30fcd21b8aff238 (diff)
downloadpragtical-plugin-manager-1.2.4.tar.gz
pragtical-plugin-manager-1.2.4.zip
Project rebrandingv1.2.4stable
Diffstat (limited to 'SPEC.md')
-rw-r--r--SPEC.md43
1 files changed, 21 insertions, 22 deletions
diff --git a/SPEC.md b/SPEC.md
index c6b2c57..699f3c3 100644
--- a/SPEC.md
+++ b/SPEC.md
@@ -1,17 +1,17 @@
# Manifest Specification
-A lite-xl manifest is a JSON file containing three different keys:
+A pragtical manifest is a JSON file containing three different keys:
* Remotes
* Addons
-* Lite-XLs
+* Pragticals
## Remotes
A simple array of string repository identifiers. A repository identifier takes
the form of a git remote url, i.e. `<url>:<ref>`. An example would be:
-`https://github.com/lite-xl/lite-xl-plugin-manager.git:latest`
+`https://github.com/pragtical/plugin-manager.git:latest`
## Addons
@@ -107,7 +107,7 @@ can also optionally contain the `arch` and `path` keys.
* `checksum` is the sha256hex checksum for the file. If `"SKIP"` is specified, the
check is skipped. This is fine for development purposes, but any publically
accessible manifest, should specify a checksum.
-* `arch` is the lite-xl/clang architecture tuple that the file is relevant for.
+* `arch` is the pragtical/clang architecture tuple that the file is relevant for.
if omitted, file is to be assumed to be valid for all arhcitectures. Can be an array.
* `path` is the location to install this file inside the addon's directory.
* `optional` is a boolean that determines whether the file is an optional addition;
@@ -116,20 +116,20 @@ can also optionally contain the `arch` and `path` keys.
If a file is an archive, of either `.zip`, `.gz` or `.tar.gz`, it will automatically
be extracted inside the addon's directory.
-## Lite-XLs
+## Pragticals
-Lite-XLs represent different version of lite-xl that are registered in this
-repository. Lite-XLs has the following metadata, as well as a `files` array.
+Pragticals represent different version of pragtical that are registered in this
+repository. Pragticals has the following metadata, as well as a `files` array.
* `version`: A version specifier. Must take the form of x.x(.x)(-suffix).
- Suffixes can be used to denote different flavours of lite-xl.
+ Suffixes can be used to denote different flavours of pragtical.
* `mod_version`: The modversion the binary corresponds to.
### Files
The files array is identical to that of the `files` array under `addons`.
Conventionally, there should be a single file per architecture that is a
-`.tar.gz` or `.zip` containing all necessary files for `lite-xl` to run.
+`.tar.gz` or `.zip` containing all necessary files for `pragtical` to run.
## Version Specifiers
@@ -145,7 +145,7 @@ that any version greater than `0.1` can be used.
{
"id": "plugin_manager", # Unique name, used to reference the plugin.
"version": "0.1", # Semantic version.
- "description": "A GUI interface to the Adam's lite plugin manager.", # English description of the plugin.
+ "description": "A GUI interface to the Adam's pragtical plugin manager.", # English description of the plugin.
"path": "plugins/plugin_manager", # The path to the plugin in this repository.
"mod_version": "3", # The mod_version this plugin corresponds to.
"provides": [ # A list of small strings that represent functionalities this plugin provides.
@@ -153,12 +153,12 @@ that any version greater than `0.1` can be used.
],
"files": [ # A list of files (usually binaries) this plugin requires to function.
{
- "url": "https://github.com/adamharrison/lite-xl-plugin-manager/releases/download/v0.1/lpm.x86_64-linux", # A publically accessible URL to download from.
- "arch": "x86_64-linux", # The lite-xl/clang target tuple that represents the architecture this file is for.
+ "url": "https://github.com/pragtical/plugin-manager/releases/download/v0.1/ppm.x86_64-linux", # A publically accessible URL to download from.
+ "arch": "x86_64-linux", # The pragtical/clang target tuple that represents the architecture this file is for.
"checksum": "d27f03c850bacdf808436722cd16e2d7649683e017fe6267934eeeedbcd21096" # the sha256hex checksum that corresponds to this file.
},
{
- "url": "https://github.com/adamharrison/lite-xl-plugin-manager/releases/download/v0.1/lpm.x86_64-windows.exe",
+ "url": "https://github.com/pragtical/plugin-manager/releases/download/v0.1/ppm.x86_64-windows.exe",
"arch": "x86_64-windows",
"checksum": "2ed993ed4376e1840b0824d7619f2d3447891d3aa234459378fcf9387c4e4680"
}
@@ -195,7 +195,7 @@ that any version greater than `0.1` can be used.
"description": "Syntax for .gitignore, .dockerignore and some other `.*ignore` files",
"version": "1.0",
"mod_version": "3",
- "remote": "https://github.com/anthonyaxenov/lite-xl-ignore-syntax:2ed993ed4376e1840b0824d7619f2d3447891d3aa234459378fcf9387c4e4680", # The remote to be used for this plugin.
+ "remote": "https://github.com/anthonyaxenov/pragtical-ignore-syntax:2ed993ed4376e1840b0824d7619f2d3447891d3aa234459378fcf9387c4e4680", # The remote to be used for this plugin.
"id": "language_ignore",
"post": {"x86-linux":"cp language_ignore.lua /tmp/somewhere-else", "x86-windows":"COPY language_ignore.lua C:\\Users\\Someone\\ignore.lua"} # Post download steps to run to fully set up the plugin. Does not run by default, requires --post.
},
@@ -212,26 +212,26 @@ that any version greater than `0.1` can be used.
},
{
"description": "Syntax for Kaitai struct files",
- "url": "https://raw.githubusercontent.com/whiteh0le/lite-plugins/main/plugins/language_ksy.lua?raw=1", # URL directly to the singleton plugin file.
+ "url": "https://raw.githubusercontent.com/whiteh0le/pragtical-plugins/main/plugins/language_ksy.lua?raw=1", # URL directly to the singleton plugin file.
"id": "language_ksy",
"version": "1.0",
"mod_version": "3",
"checksum": "08a9f8635b09a98cec9dfca8bb65f24fd7b6585c7e8308773e7ddff9a3e5a60f", # Checksum for this particular URL.
}
],
- "lite-xls": [ # An array of lite-xl releases.
+ "pragticals": [ # An array of pragtical releases.
{
"version": "2.1-simplified", # The version, followed by a release suffix defining the release flavour. The only releases that are permitted to not have suffixes are official relases.
"mod_version": "3", # The mod_version this release corresponds to.
"files": [ # Identical to `files` under `addons`, although these are usually simply archives to be extracted.
{
"arch": "x86_64-linux",
- "url": "https://github.com/adamharrison/lite-xl-simplified/releases/download/v2.1/lite-xl-2.1.0-simplified-x86_64-linux.tar.gz",
+ "url": "https://github.com/adamharrison/lite-xl-simplified/releases/download/v2.1/pragtical-2.1.0-simplified-x86_64-linux.tar.gz",
"checksum": "b5087bd03fb491c9424485ba5cb16fe3bb0a6473fdc801704e43f82cdf960448"
},
{
"arch": "x86_64-windows",
- "url": "https://github.com/adamharrison/lite-xl-simplified/releases/download/v2.1/lite-xl-2.1.0-simplified-x86_64-windows.zip",
+ "url": "https://github.com/adamharrison/lite-xl-simplified/releases/download/v2.1/pragtical-2.1.0-simplified-x86_64-windows.zip",
"checksum": "f12cc1c172299dd25575ae1b7473599a21431f9c4e14e73b271ff1429913275d"
}
]
@@ -242,21 +242,20 @@ that any version greater than `0.1` can be used.
"files": [
{
"arch": "x86_64-linux",
- "url": "https://github.com/adamharrison/lite-xl-simplified/releases/download/v2.1/lite-xl-2.1.0-simplified-x86_64-linux-enhanced.tar.gz",
+ "url": "https://github.com/adamharrison/lite-xl-simplified/releases/download/v2.1/pragtical-2.1.0-simplified-x86_64-linux-enhanced.tar.gz",
"checksum": "4625c7aac70a2834ef5ce5ba501af2d72d203441303e56147dcf8bcc4b889e40"
},
{
"arch": "x86_64-windows",
- "url": "https://github.com/adamharrison/lite-xl-simplified/releases/download/v2.1/lite-xl-2.1.0-simplified-x86_64-windows-enhanced.zip",
+ "url": "https://github.com/adamharrison/lite-xl-simplified/releases/download/v2.1/pragtical-2.1.0-simplified-x86_64-windows-enhanced.zip",
"checksum": "5ac009e3d5a5c99ca7fbd4f6b5bd4e25612909bf59c0925eddb41fe294ce28a4"
}
]
}
],
"remotes": [ # A list of remote specifiers. The plugin manager will pull these in and add them as additional repositories if specified to do so with a flag.
- "https://github.com/lite-xl/lite-xl-plugins.git:2.1",
+ "https://github.com/pragtical/plugins.git:2.1",
"https://github.com/adamharrison/lite-xl-simplified.git:v2.1"
]
}
```
-