Skip to content

Commit

Permalink
readme and manifest
Browse files Browse the repository at this point in the history
updates
  • Loading branch information
A SMN committed Jul 24, 2024
1 parent 9e6dddd commit 9d826ec
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 91 deletions.
Binary file modified .DS_Store
Binary file not shown.
97 changes: 15 additions & 82 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,92 +1,25 @@
# killswitch
# Kill Switch

## Installation
Kill Switch is a simple, but powerful plugin for Sketch that disables overrides for selected Symbols. This functionality enables a blank-slate approach to Symbol creation and override management that greatly improves adoption and usage.

#### Requirements

- macOS
- Sketch App

#### Installation

- [Download](../../releases/latest/download/killswitch.sketchplugin.zip) the latest release of the plugin
- Un-zip
- Double-click on killswitch.sketchplugin

## Development Guide

_This plugin was created using `skpm`. For a detailed explanation on how things work, checkout the [skpm Readme](https://github.com/skpm/skpm/blob/master/README.md)._

### Usage

Install the dependencies

```bash
npm install
```

Once the installation is done, you can run some commands inside the project folder:

```bash
npm run build
```

To watch for changes:

```bash
npm run watch
```

Additionally, if you wish to run the plugin every time it is built:

```bash
npm run start
```

### Custom Configuration

#### Babel

To customize Babel, you have two options:

- You may create a [`.babelrc`](https://babeljs.io/docs/usage/babelrc) file in your project's root directory. Any settings you define here will overwrite matching config-keys within skpm preset. For example, if you pass a "presets" object, it will replace & reset all Babel presets that skpm defaults to.

- If you'd like to modify or add to the existing Babel config, you must use a `webpack.skpm.config.js` file. Visit the [Webpack](#webpack) section for more info.

#### Webpack

To customize webpack create `webpack.skpm.config.js` file which exports function that will change webpack's config.

```js
/**
* Function that mutates original webpack config.
* Supports asynchronous changes when promise is returned.
*
* @param {object} config - original webpack config.
* @param {boolean} isPluginCommand - whether the config is for a plugin command or a resource
**/
module.exports = function(config, isPluginCommand) {
/** you can change config here **/
}
```

### Debugging

To view the output of your `console.log`, you have a few different options:

- Use the [`sketch-dev-tools`](https://github.com/skpm/sketch-dev-tools)
- Run `skpm log` in your Terminal, with the optional `-f` argument (`skpm log -f`) which causes `skpm log` to not stop when the end of logs is reached, but rather to wait for additional data to be appended to the input

### Publishing your plugin

```bash
skpm publish <bump>
```

(where `bump` can be `patch`, `minor` or `major`)

`skpm publish` will create a new release on your GitHub repository and create an appcast file in order for Sketch users to be notified of the update.
- In Sketch, select a Symbol
- Press `cmd` + `K` to open the Command Bar
- Begin typing `Kill Switch` (also look for the icon) and select "Kill Overrides"
- Alternatively, select from the application menu bar `Plugins > Kill Switch > Kill Overrides`

You will need to specify a `repository` in the `package.json`:
#### Credits

```diff
...
+ "repository" : {
+ "type": "git",
+ "url": "git+https://github.com/ORG/NAME.git"
+ }
...
```
This plugin was inspired by the Sketch Overrides Manager plugin by [ozgurgunes](https://github.com/ozgurgunes/Sketch-Overrides-Manager) and is made possible by instrumental contributions and feedback from [flavormingo](https://github.com/flavormingo). Learn more about Snacks Studio at [madebysnacks.com](https://www.madebysnacks.com).
9 changes: 5 additions & 4 deletions killswitch.sketchplugin/Contents/Sketch/manifest.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
{
"$schema": "https://raw.githubusercontent.com/sketch-hq/SketchAPI/develop/docs/sketch-plugin-manifest-schema.json",
"name": "Kill Switch",
"description": "A simple plugin to kill all overrides of selected Symbols",
"homepage": "https://github.com/madebysnacks/killswitch",
"version": "1.0.0",
"icon": "icon.png",
"commands": [
{
"name": "Kill",
"name": "Kill Overrides",
"identifier": "killswitch.kill",
"script": "__script.js"
}
Expand All @@ -14,9 +18,6 @@
"killswitch.kill"
]
},
"version": "0.1.0",
"description": "a simple sketch plugin for killing symbol overrides",
"name": "killswitch",
"identifier": "killswitch",
"disableCocoaScriptPreprocessor": true,
"appcast": "https://raw.githubusercontent.com/alexschemagin/killswitch/master/.appcast.xml"
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "killswitch",
"description": "A simple Sketch plugin that disables Symbol overrides.",
"version": "0.1.1",
"version": "1.0.0",
"repository": {
"type": "git",
"url": "https://github.com/alexschemagin/killswitch"
Expand Down
4 changes: 4 additions & 0 deletions src/manifest.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
{
"$schema": "https://raw.githubusercontent.com/sketch-hq/SketchAPI/develop/docs/sketch-plugin-manifest-schema.json",
"name": "Kill Switch",
"description": "A simple plugin to kill all overrides of selected Symbols",
"homepage": "https://github.com/madebysnacks/killswitch",
"version": "1.0.0",
"icon": "icon.png",
"commands": [
{
Expand Down

0 comments on commit 9d826ec

Please sign in to comment.