Skip to content
This repository has been archived by the owner on Oct 11, 2018. It is now read-only.
Florian Bürger edited this page May 29, 2014 · 5 revisions

Spec Format Proposal

{
    "name": "Name for the plugin", // required
    "short-description": "A short description", // required
    "description": "A longer description displayed that can contain Markdown.",
    "version": "1.0.2", // required
    "sketch-version": 3.0, // minimum required sketch version
    "homepage": "http://github.com/", //optional
    "repository": { // required
        "type": "git",
        "url": "https://github.com/shahruz/Sketch-Toolbox/"
    },
    "license": { // required
        "type": "MIT",
        "url": "https://github.com/shahruz/Sketch-Toolbox/LICENSE-MIT"
    },
    "authors": [{ // required
        "name": "Samlad Bunce",
        "url": "http://CPADirectories.com",
        "social": [{
            "googleplus": "https://plus.google.com/+SamladBunce"
        }]
    }, {
        "name": "Linda Twofoot",
        "url": "http://author-b.com",
        "social": [{
            "twitter": "http://twitter.com/@lindatwofoot"
        }]

    }],
    "image": "http://www.reactiongifs.com/r/lk.gif", //optional
    "categories": [ //optional
        "generator",
        "grid",
        "data"
    ]
}

Central Spec Repo Variant 1

Maybe we can do something similar to the (old) CocoaPods way. The root directory contains a directory for every plugins. Inside the plugin folder are the available versions and their spec file.

.
├── android-assets
│   └── 0.3.2
│       └── android-assets.json
├── auto-export-assets
│   ├── 0.4.0
│   │   └── auto-export-assets.json
│   └── 0.4.1
│       └── auto-export-assets.json
├── content-generator
│   ├── 0.4.0
│   │   └── content-generator.json
│   └── 0.5.0
│       └── content-generator.json
└── day-player
    ├── 0.9.0
    │   └── day-player.json
    ├── 1.0.0
    │   └── day-player.json
    └── 1.0.1
        └── day-player.json

Central Spec Repo Variant 2

A simpler approach: Just put all plugins intro one JSON array. Maybe we don’t need to keep every version.

[{
    "name": "Name for the plugin", // required
    "short-description": "A short description", // required
    "description": "A longer description displayed that can contain Markdown.",
    "version": "1.0.2", // required
    "sketch-version": 3.0, // minimum required sketch version
    "homepage": "http://github.com/", //optional
    "repository": { // required
        "type": "git",
        "url": "https://github.com/shahruz/Sketch-Toolbox/"
    },
    "license": { // required
        "type": "MIT",
        "url": "https://github.com/shahruz/Sketch-Toolbox/LICENSE-MIT"
    },
    "authors": [{ // required
        "name": "Samlad Bunce",
        "url": "http://CPADirectories.com",
        "social": [{
            "googleplus": "https://plus.google.com/+SamladBunce"
        }]
    }, {
        "name": "Linda Twofoot",
        "url": "http://author-b.com",
        "social": [{
            "twitter": "http://twitter.com/@lindatwofoot"
        }]

    }],
    "image": "http://www.reactiongifs.com/r/lk.gif", //optional
    "categories": [ //optional
        "generator",
        "grid",
        "data"
    ]
},
{
    "name": "Name for the plugin", // required
    "short-description": "A short description", // required
    "description": "A longer description displayed that can contain Markdown.",
    "version": "1.0.2", // required
    "sketch-version": 3.0, // minimum required sketch version
    "homepage": "http://github.com/", //optional
    "repository": { // required
        "type": "git",
        "url": "https://github.com/shahruz/Sketch-Toolbox/"
    },
    "license": { // required
        "type": "MIT",
        "url": "https://github.com/shahruz/Sketch-Toolbox/LICENSE-MIT"
    },
    "authors": [{ // required
        "name": "Samlad Bunce",
        "url": "http://CPADirectories.com",
        "social": [{
            "googleplus": "https://plus.google.com/+SamladBunce"
        }]
    }, {
        "name": "Linda Twofoot",
        "url": "http://author-b.com",
        "social": [{
            "twitter": "http://twitter.com/@lindatwofoot"
        }]

    }],
    "image": "http://www.reactiongifs.com/r/lk.gif", //optional
    "categories": [ //optional
        "generator",
        "grid",
        "data"
    ]
}]
Clone this wiki locally