Giter VIP home page Giter VIP logo

ps-cli's Introduction

Brief

Refactored Shopify Slate 0.14.0, replace the deploy method with Shopify Theme Kit and update the dependencies. So you can use the latest version of Node.js and NPM.

Table of contents

Installation

# npm
>npm i @leocxy/ps-cli
# yarn
>yarn add @leocxy/ps-cli

Usage

Command Usage
migrate slate migrate [--options]
watch/w slate watch [--options]
build/b slate build [--options]
deploy/d slate deploy [--options]
theme/t slate theme [--options]
pull/p slate pull [--options]

migrate

# npm
>npm slate migrate
# yarn
>yarn slate migrate

Converts an existing theme to work with Slate Structure.

watch

# npm
>npm slate watch [--options]
>npm slate w [--options]
# yarn
>yarn slate watch [--options]
>yarn slate w [--options]

Sets up the watchers for all theme assets and deploys the compiled versions to your shop.

build

# npm
>npm slate build
>npm slate b
# yarn
>yarn slate build
>yarn slate b

Compiles your theme files and assets into a Shopify theme, found in the dist folder. No files will be uploaded to your shop.

deploy

# npm
>npm slate deploy [--options]
>npm slate d [--options]
# yarn
>yarn slate deploy [--options]
>yarn slate d [--options]

Performs a fresh build followed by a full deploy; replacing existing files on the remote server and replacing them with the full set of build files, and removing remote files that are no longer in use.

theme

# npm
>npm slate theme [--options]
>npm slate t [--options]
# yarn
>yarn slate theme [--options]
>yarn slate t [--options]

List all themes in your store.

pull

# npm
>npm slate pull [--options]
>npm slate p [--options]
# yarn
>yarn slate pull [--options]
>yarn slate p [--options]

Pull specific theme from your store to your local machine.

Tests

For some reason, you might want to fork this project and refactor it. You can test it with the following command.

# at the root folder
>node ./src/index.js

# test the bin with build file
>node ./dist/index.js

# enable debug message
>DEBUG=1 node ./src/index.js

Common Issues

Mac M1/M2 Chip

The Shopify ThemeKit is not natively support the Apple M1/M2 chip. You might need to turn on Rosetta mode to run the ThemeKit.

fsevents

You might see this error message when you install the package. It is not impacted the package. Because I an not using the fsevents in this package.

warning Error running install script for optional dependency: "/xx/xxx/node_modules/gulp/node_modules/fsevents: Command failed.

Change Logs

0.16.8 → Updated dependencies, and update the README.md

0.16.7 → live will not consider as a valid theme_id anymore. (config.yml)

0.16.6 → Fixed “scripts/vendor.js” does not exist will raise an error issue

0.16.5 → Add “download” command

0.16.4 → Fixed SASS warning message

0.16.3 → Fixed SASS compiled as CSS, file extension issue

0.16.1 → All “styles/.{sass,sass.liquid}” will compiled as “assets/.{css,css.liquid}”

0.15.9 → Fixed JS configuration issue

0.15.8 → Support Section Group “sections/*.json”

0.15.7 → Fixed SVG file compiled issue, removed source map for JS JS will not “uglify” Include all JS before “Babel” it

0.15.6 → Fixed “includes” issue

0.15.5 → Fixed “build” and “deploy” processes, and added “vendor.js” to the processes.

0.15.4 → Tidy up the overwrite method

ps-cli's People

Contributors

leocxy avatar ps-leocxy avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.