Skip to content

Commit

Permalink
skpm create sketch-wt-elevation --name "WtElevation" --template=skpm/…
Browse files Browse the repository at this point in the history
…with-prettier
  • Loading branch information
luvtechno committed Aug 2, 2018
0 parents commit d38cfd9
Show file tree
Hide file tree
Showing 9 changed files with 7,282 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .eslintrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
root: true
extends:
- airbnb-base
- plugin:import/errors
- prettier
plugins:
- no-not-accumulator-reassign
- prettier
env:
node: true
rules:
no-not-accumulator-reassign/no-not-accumulator-reassign: [2, ['reduce'], {props: true}]
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# build artefacts
plugin.sketchplugin/Contents/Sketch
plugin.sketchplugin/Contents/Resources/_webpack_resources

# npm
node_modules
.npm
npm-debug.log

# mac
.DS_Store
56 changes: 56 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# WtElevation

_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)._

## CLI Commands

``` bash
# build with hot reload
npm run watch

# build for production
npm run build
```

## 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 - wether 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:
* Open `Console.app` and look for the sketch logs
* Use Safari's web inspector to debug your plugin's javascript context
* Look at the `~/Library/Logs/com.bohemiancoding.sketch3/Plugin Output.log` file

Skpm provides a convenient way to do the latter:

```bash
skpm log
```

The `-f` option 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

Loading

0 comments on commit d38cfd9

Please sign in to comment.