Node Themekit

Theme asset interaction library and management tools written in Node.js
Alternatives To Node Themekit
Project NameStarsDownloadsRepos Using ThisPackages Using ThisMost Recent CommitTotal ReleasesLatest ReleaseOpen IssuesLicenseLanguage
Ohmyzsh159,450132 days ago1December 07, 2014616mitShell
🙃 A delightful community-driven (with 2,100+ contributors) framework for managing your zsh configuration. Includes 300+ optional plugins (rails, git, macOS, hub, docker, homebrew, node, php, python, etc), 140+ themes to spice up your morning, and an auto-update tool so that makes it easy to keep up with the latest updates from the community.
.tmux19,096
25 days ago34mit
🇫🇷 Oh my tmux! My self-contained, pretty & versatile tmux configuration made with ❤️
Fx16,2831116a month ago47September 15, 202022mitGo
Terminal JSON viewer
Terminalizer14,104688 days ago35September 07, 2022107mitJavaScript
🦄 Record your terminal and generate animated gif images or share a web player
Prezto13,400
14 days ago179mitShell
The configuration framework for Zsh
Rtv4,597
73 months ago51June 03, 2019103mitPython
Browse Reddit from your terminal
Resume Cli4,29393343 months ago106April 20, 202298mitJavaScript
CLI tool to easily setup a new resume 📑
Reapp3,511317 years ago79May 13, 201539mitJavaScript
[deprecated!] Make hybrid mobile apps with power
Doitlive3,283
82 months ago27April 07, 201921mitPython
Because sometimes you need to do it live
Mancy2,654
4 years ago55mitJavaScript
>_ Electron based NodeJS REPL :see_no_evil:
Alternatives To Node Themekit
Select To Compare


Alternative Project Comparisons
Readme

npm version

@shopify/themekit

Node wrapper for Theme Kit.

Table Of Contents

Installation

$ npm install @shopify/themekit

Usage

const themeKit = require('@shopify/themekit');

await themeKit.command('version');
//=> ThemeKit 0.8.1 darwin/amd64

Examples

Run commands

This wrapper exposes a single function in its API which allows it to run any command available in the original Theme Kit CLI. Here are a collection of examples to run Theme Kit commands.

For a complete list of commands and args: shopify.github.io/themekit/commands.

Example 1

Remove specific files from development environment.

const themeKit = require('@shopify/themekit');

await themeKit.command('remove', {
  env: 'development',
  files: ['snippets/pagination.liquid', 'snippets/date.liquid']
});

Example 3

Deploy all files to staging environment.

const themeKit = require('@shopify/themekit');

themeKit.command('deploy', {
  env: 'staging'
});

Example 4

Deploy theme to production via NPM scripts.

Warning: This example will overwrite the theme based on your config.yml.

"dependencies": {
  "@shopify/themekit": "1.0.0"
},
"scripts": {
  "deploy": "shopify-themekit replace --env production"
}

API

command(command[, flags][, options)

Executes command with arguments using the Theme Kit binary.

  • command <String>

    Theme Kit command to run.

  • flags <Object>

    Flags to pass into the command.

    All flags specified in the Theme Kit documentation are available, but in camelCase rather than in --flagform.

    {
      noIgnore: true, // --no-ignore
      env: 'development' // --env=development
    }
    

    Additional flags:

    • files: Specify an array of target files to upload.
    • ignoredFiles: Like ignoredFile, but takes in an array of files to ignore.
  • options <Object>

    {
      cwd: <String>,      // Hard-code a working directory to run the binary from
      logLevel: <String> // Set level additional output info | 'silent', 'error', 'all', 'silly'
    }
    

For a complete list of commands and flags, see the Theme Kit documentation.

CLI

$ shopify-themekit <args>

This CLI component of this package is intended to be used with NPM scripts. It functions exactly the same as the original Theme Kit binary. If you plan on using the command line interface heavily, please refer to the original Theme Kit repository.

Contributing

Releases

This information is for project maintainers:

Instructions

  • Use npm version <major|minor|patch> to update the version in package.json and package-lock.json.
  • Push the changes and the tag with git push --follow-tags
  • Open new PR corresponding to the new release, and merge once approved.
  • Release to npmjs.com by triggering a Shipit deploy of the master branch.
  • Visit https://www.npmjs.com/package/@shopify/themekit to confirm the new version is listed.
  • Create a release on GitHub.

License

MIT, see LICENSE.md for details.

Popular Theme Projects
Popular Command Line Projects
Popular User Interface Categories
Related Searches

Get A Weekly Email With Trending Projects For These Categories
No Spam. Unsubscribe easily at any time.
Javascript
Cli
Theme
Kit
Flags
Npm Scripts