# @skpm/internal-utils
> A set of functions used across skpm
Latest version **0.1.17** (published 2023-10-10) · MIT license · 0 weekly downloads
## Install
```sh
npm install @skpm/internal-utils
pnpm add @skpm/internal-utils
yarn add @skpm/internal-utils
bun add @skpm/internal-utils
```
## Health
**Score 25/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned.
## Facts
| | |
|---|---|
| Version | 0.1.17 |
| Published | 2023-10-10 |
| First published | 2018-04-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6 |
| Dependencies | 4 |
| Unpacked size | 9.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 963 |
| Author | Mathieu Dutour |
| Maintainers | mathieudutour, sketchbot |
| Keywords | sketch, cocoascript, javascript, babel, skpm |
## Links
- npm: https://www.npmjs.com/package/@skpm/internal-utils
- Repository: https://github.com/skpm/skpm
- Homepage: https://github.com/skpm/skpm#readme
- Issues: https://github.com/skpm/skpm/issues
- npm.io page: https://npm.io/package/@skpm/internal-utils
## Dependencies (4)
- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [yesno](https://npm.io/package/yesno.md) 0.2.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.13.1
- [object-assign](https://npm.io/package/object-assign.md) ^4.1.1
## Alternatives
- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads
## Recent versions
- 0.1.17 (latest) — 2023-10-10
- 0.1.16 — 2019-07-31
- 0.1.15 — 2019-07-17
- 0.1.14 — 2019-04-10
- 0.1.13 — 2018-11-14
- 0.1.12 — 2018-11-08
- 0.1.11 — 2018-10-05
- 0.1.10 — 2018-07-22
- 0.1.9 — 2018-06-25
- 0.1.8 — 2018-04-10
- 0.1.7 — 2018-04-06
- 0.1.6 — 2018-04-06
## README
skpm - Sketch Plugin Manager
A utility to create, build and publish sketch plugins.
## Installation
> Important: [Node.js](https://nodejs.org/en/download/) > V6.x is a minimum requirement. You also need the [command line tools](http://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/) installed.
```bash
npm install -g skpm
```
## Usage
```bash
skpm create my-plugin
```
The above command pulls the template from [skpm/skpm](https://github.com/skpm/skpm/tree/master/template), prompts for some information, and generates the project at ./my-plugin/.
* [Create a new plugin](#create-a-new-plugin)
* [Build the plugin](#build-the-plugin)
* [View the plugin's log](#view-the-plugins-log)
* [Publish the plugin on the registry](#publish-the-plugin-on-the-registry)
#### Create a new plugin
```bash
skpm create
--name The plugin display name.
--cwd A directory to use instead of $PWD.
--force Force option to create the directory for the new app. [boolean] [default: false]
--template The repository hosting the template to start from. [string] [default: skpm/skpm]
--git Initialize version control using git. [boolean] [default: true]
--install Installs dependencies. [boolean] [default: true]
```
> ##### A note on templates
>
> The purpose of official skpm plugin templates are to provide opinionated development tooling setups so that users can get started with actual plugin code as fast as possible. However, these templates are un-opinionated in terms of how you structure your plugin code and what libraries you use in addition to skpm.
>
> Current available official templates include:
>
> * [`skpm/skpm`](https://github.com/skpm/skpm/tree/master/template) - The simplest possible plugin setup. (_default_)
> * [`skpm/with-prettier`](https://github.com/skpm/with-prettier) - A plugin setup featuring linting with ESLint and code formatting with Prettier.
> * [`skpm/with-datasupplier`](https://github.com/skpm/with-datasupplier) - A template to create DataSupplier plugins (check [our blog](https://blog.sketchapp.com/do-more-with-data-2b765e870e4f) for more info)
> * [`skpm/with-webview`](https://github.com/skpm/with-webview) - A template to create plugins displaying some rich UI in a WebView (check [sketch-module-web-view](https://github.com/skpm/sketch-module-web-view) for more info)
> * [`skpm/with-actions`](https://github.com/skpm/with-actions) - A template to create plugins using the [Actions API](https://developer.sketch.com/plugins/actions).
>
> > 💁 Tip: Any Github repo with a 'template' folder can be used as a custom template:
> > `skpm create --template=/`
#### Build the plugin
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
```
#### View the plugin's log
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)
* Open `Console.app` and look for the sketch logs
* Look at the `~/Library/Logs/com.bohemiancoding.sketch3/Plugin Output.log` file
Skpm provides a convenient way to do the latter:
```bash
skpm log
-f, -F The `-f` option causes tail to not stop when end of file is
reached, but rather to wait for additional data to be appended
to the input. [boolean] [default: "false"]
--number, -n Shows `number` lines of the logs. [number]
```
#### Publish the plugin on the registry
To publish a new version of the plugin to the registry:
```bash
skpm publish | major | minor | patch | premajor | preminor | prepatch | prerelease
--repo-url Specify the repository URL (default to the one specified
in package.json). [string]
--skip-release Do not create a release on GitHub.com. [boolean]
--open-release, -o Open the newly created release on GitHub.com. [boolean]
--skip-registry Do not publish to the plugins registry if not already
present. [boolean]
--download-url Specify the new version's download URL (default to the
asset of the release created on GitHub.com). [string]
```
The exact order of execution (without options) is as follows:
* Run the `preversion` script
* Bump `version` in package.json as requested (`patch`, `minor`, `major`, etc).
* Run the `version` script
* Commit and tag
* Run the `postversion` script.
* Run the `prepublish` or `build` script
* Zip the folder specified in the `main` field
* Create a draft release on GitHub
* Upload the zip to GitHub
* Publish the release
* Remove the zip
* Check the [sketchplugins/plugin-directory](https://github.com/sketchplugins/plugin-directory) repo to see if the plugin is already there. If not, open a PR to add it.
## License
[MIT](https://tldrlegal.com/license/mit-license)
---
_Source: https://npm.io/package/@skpm/internal-utils · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
