@ribajs/shopify
Advanced tools
Comparing version 2.0.0-alpha.16 to 2.0.0-beta.1
{ | ||
"name": "@ribajs/shopify", | ||
"description": "Shopify extension for Riba.js", | ||
"version": "2.0.0-alpha.16", | ||
"version": "2.0.0-beta.1", | ||
"type": "module", | ||
@@ -40,4 +40,4 @@ "engines": { | ||
"lint": "eslint ./src --ext .js,.jsx,.ts,.tsx,.cts,.mts --fix && tsc --noEmit", | ||
"build": "npm run lint && tsc", | ||
"test": "npm run lint && jest --config=jest.config.cjs", | ||
"build": "yarn run lint && tsc", | ||
"test": "yarn run lint && jest --config=jest.config.cjs", | ||
"clean": "rm -rf ./dist ./lib" | ||
@@ -52,3 +52,3 @@ }, | ||
"@babel/cli": "^7.19.3", | ||
"@babel/core": "^7.20.2", | ||
"@babel/core": "^7.20.5", | ||
"@babel/plugin-proposal-class-properties": "^7.18.6", | ||
@@ -59,48 +59,44 @@ "@babel/plugin-proposal-object-rest-spread": "^7.20.2", | ||
"@babel/preset-typescript": "^7.18.6", | ||
"@babel/runtime": "^7.20.1", | ||
"@babel/runtime-corejs3": "^7.20.1", | ||
"@ribajs/eslint-config": "^2.0.0-alpha.16", | ||
"@ribajs/npm-package": "^2.0.0-alpha.16", | ||
"@ribajs/tsconfig": "^2.0.0-alpha.16", | ||
"@babel/runtime": "^7.20.6", | ||
"@babel/runtime-corejs3": "^7.20.6", | ||
"@ribajs/eslint-config": "^2.0.0-beta.1", | ||
"@ribajs/npm-package": "^2.0.0-beta.1", | ||
"@ribajs/tsconfig": "^2.0.0-beta.1", | ||
"@tsconfig/node14": "^1.0.3", | ||
"@types/debug": "^4.1.7", | ||
"@types/jest": "^28.1.8", | ||
"@types/lodash": "^4.14.189", | ||
"@types/node": "^18.11.9", | ||
"@types/jest": "^29.2.4", | ||
"@types/lodash": "^4.14.191", | ||
"@types/node": "^18.11.11", | ||
"@types/open": "^6.2.1", | ||
"@types/prettier": "^2.7.1", | ||
"@typescript-eslint/eslint-plugin": "^5.43.0", | ||
"@typescript-eslint/parser": "^5.43.0", | ||
"babel-loader": "^8.3.0", | ||
"@typescript-eslint/eslint-plugin": "^5.45.1", | ||
"@typescript-eslint/parser": "^5.45.1", | ||
"babel-loader": "^9.1.0", | ||
"babel-plugin-array-includes": "^2.0.3", | ||
"core-js": "^3.26.1", | ||
"debug": "^4.3.4", | ||
"eslint": "^8.27.0", | ||
"eslint": "^8.29.0", | ||
"eslint-config-prettier": "^8.5.0", | ||
"eslint-plugin-prettier": "^4.2.1", | ||
"graceful-fs": "^4.2.10", | ||
"jest": "^28.1.3", | ||
"jest-extended": "^2.0.0", | ||
"prettier": "^2.7.1", | ||
"terser": "^5.15.1", | ||
"ts-jest": "^28.0.8", | ||
"jest": "^29.3.1", | ||
"jest-extended": "^3.2.0", | ||
"prettier": "^2.8.0", | ||
"terser": "^5.16.1", | ||
"ts-jest": "^29.0.3", | ||
"typescript": "4.9.3" | ||
}, | ||
"optionalDependencies": { | ||
"@ribajs/shopify-tda": "^2.0.0-alpha.16" | ||
"@ribajs/shopify-tda": "^2.0.0-beta.1" | ||
}, | ||
"dependencies": { | ||
"@ribajs/cache": "^2.0.0-alpha.16", | ||
"@ribajs/core": "^2.0.0-alpha.16", | ||
"@ribajs/events": "^2.0.0-alpha.16", | ||
"@ribajs/i18n": "^2.0.0-alpha.16", | ||
"@ribajs/router": "^2.0.0-alpha.16", | ||
"@ribajs/utils": "^2.0.0-alpha.16", | ||
"bitbucket": "^2.9.0", | ||
"form-data": "^4.0.0", | ||
"got": "^11.8.5", | ||
"gulp-print": "^5.0.2", | ||
"@ribajs/cache": "^2.0.0-beta.1", | ||
"@ribajs/core": "^2.0.0-beta.1", | ||
"@ribajs/events": "^2.0.0-beta.1", | ||
"@ribajs/i18n": "^2.0.0-beta.1", | ||
"@ribajs/router": "^2.0.0-beta.1", | ||
"@ribajs/utils": "^2.0.0-beta.1", | ||
"webpack": "^5.75.0", | ||
"webpack-cli": "^4.10.0" | ||
"webpack-cli": "^5.0.1" | ||
} | ||
} |
143
README.md
@@ -64,145 +64,2 @@ # Shopify Module | ||
``` | ||
## Gulp | ||
Add a gulp file to your theme project like this | ||
```js | ||
/** | ||
* For this reason the slate is depricated this is a own gulpfile like the original gulpfile used in slate but with some customisations | ||
* @see https://github.com/Shopify/slate/blob/0.x/packages/slate-tools/src/gulpfile.js | ||
*/ | ||
require('source-map-support').install(); // Used to inspect the code for debugging | ||
const path = require("path"); | ||
const gutil = require("gulp-util"); | ||
const argv = require("yargs").argv; | ||
const requireDir = require("require-dir"); | ||
// Gets the gulp tasks path of @ribajs/shopify | ||
const ribaShopifyTaskDir = path.resolve( | ||
path.dirname(require.resolve("@ribajs/shopify-gulp")), | ||
"tasks" | ||
); | ||
if (argv.environment && argv.environment !== "undefined") { | ||
console.log(`setting tkEnvironments to ${argv.environment}`); | ||
gutil.env.environments = argv.environment; | ||
} | ||
// imports gulp tasks from the @ribajs/shopify's `build-system/dist/tasks` directory | ||
requireDir(ribaShopifyTaskDir, { extensions: [".js", ".cjs"] }); | ||
``` | ||
### Gulp tasks | ||
#### Generate config.deploy.yml | ||
After you have create a basic `config.deploy.yml` you can run the command below to insert the latest created themes (which are usually the next release themes) in your `config.deploy.yml`. | ||
```bash | ||
gulp generate:config:deploy | ||
``` | ||
#### Get a list of the youngest / next release themes | ||
To make it easier to publish the current preview links of the release themes in the chat you can use the following command: | ||
```bash | ||
gulp themes:list:youngest | ||
``` | ||
Example output: | ||
```text | ||
... | ||
====== UK ====== | ||
Name: release/1.3.17 | New variant switcher | ||
ID: 81177935933 | ||
Store: my-store.myshopify.com | ||
Created: Today at 9:10 AM | ||
Updated: Today at 10:03 AM | ||
Edit settings: https://my-store.myshopify.com/admin/themes/81177935933/editor | ||
Edit code: https://my-store.myshopify.com/admin/themes/81177935933 | ||
Preview: https://my-store.myshopify.com/?_ab=0&_fd=0&_sc=1&preview_theme_id=81177935933 | ||
... | ||
``` | ||
### Config files | ||
`config.deploy.yml`: | ||
```yaml | ||
# Rename this file to config.deploy.yml to use it with `npm run deploy` | ||
staging: | ||
password: | ||
theme_id: 80030728250 # release/april-21-2020 | ||
store: my-store-staging.myshopify.com | ||
ignore_files: | ||
- config/settings_data.json | ||
- locales/* | ||
de: | ||
password: | ||
theme_id: 79757934703 # release/april-21-2020 | ||
store: my-store-de.myshopify.com | ||
ignore_files: | ||
- config/settings_data.json | ||
- locales/* | ||
eu: | ||
password: | ||
theme_id: 81227481159 # release/april-21-2020 | ||
store: my-store-au.myshopify.com | ||
ignore_files: | ||
- config/settings_data.json | ||
- locales/* | ||
fr: | ||
password: | ||
theme_id: 79767437399 # release/april-21-2020 | ||
store: my-store-fr.myshopify.com | ||
ignore_files: | ||
- config/settings_data.json | ||
- locales/* | ||
uk: | ||
password: | ||
theme_id: 79777366077 # release/april-21-2020 | ||
store: my-store-uk.myshopify.com | ||
ignore_files: | ||
- config/settings_data.json | ||
- locales/* | ||
us: | ||
password: | ||
theme_id: 80021160036 # release/april-21-2020 | ||
store: my-store-us.myshopify.com | ||
ignore_files: | ||
- config/settings_data.json | ||
- locales/* | ||
``` | ||
`release.yml`: | ||
```yaml | ||
bitbucket: | ||
username: # your bitbucket userbame | ||
password: # your bitbucket password | ||
workspace: # ee.g. rfd | ||
repo_slug: # e.g. my-store | ||
``` | ||
## Deploy | ||
To deploy this branch to all shops just create a `config.deploy.yml` with an environment for each shop like in the `config-sample.deploy.yml` and run | ||
```bash | ||
gulp deploy | ||
``` | ||
You can pass a custom config.yml file name like this: | ||
```bash | ||
gulp deploy:prod -- --config="config.deploy.yml" | ||
gulp watch:dev -- --config="config.staging.yml" | ||
``` | ||
## Build @ribajs/shopify | ||
@@ -209,0 +66,0 @@ |
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
486014
9
82
+ Addedsafe-buffer@5.2.1(transitive)
- Removedbitbucket@^2.9.0
- Removedform-data@^4.0.0
- Removedgot@^11.8.5
- Removedgulp-print@^5.0.2
- Removed@sindresorhus/is@4.6.0(transitive)
- Removed@szmarczak/http-timer@4.0.6(transitive)
- Removed@types/cacheable-request@6.0.3(transitive)
- Removed@types/http-cache-semantics@4.0.4(transitive)
- Removed@types/keyv@3.1.4(transitive)
- Removed@types/responselike@1.0.3(transitive)
- Removed@webpack-cli/configtest@1.2.0(transitive)
- Removed@webpack-cli/info@1.5.0(transitive)
- Removed@webpack-cli/serve@1.7.0(transitive)
- Removedansi-colors@3.2.4(transitive)
- Removedansi-gray@0.1.1(transitive)
- Removedansi-wrap@0.1.0(transitive)
- Removedasynckit@0.4.0(transitive)
- Removedbefore-after-hook@2.2.3(transitive)
- Removedbitbucket@2.12.0(transitive)
- Removedcacheable-lookup@5.0.4(transitive)
- Removedcacheable-request@7.0.4(transitive)
- Removedclone@2.1.2(transitive)
- Removedclone-buffer@1.0.0(transitive)
- Removedclone-response@1.0.3(transitive)
- Removedclone-stats@1.0.0(transitive)
- Removedcloneable-readable@1.1.3(transitive)
- Removedcolor-support@1.1.3(transitive)
- Removedcombined-stream@1.0.8(transitive)
- Removedcommander@7.2.0(transitive)
- Removedcore-util-is@1.0.3(transitive)
- Removeddecompress-response@6.0.0(transitive)
- Removeddeepmerge@4.3.1(transitive)
- Removeddefer-to-connect@2.0.1(transitive)
- Removeddelayed-stream@1.0.0(transitive)
- Removedend-of-stream@1.4.4(transitive)
- Removedfancy-log@1.3.3(transitive)
- Removedform-data@4.0.0(transitive)
- Removedget-stream@5.2.0(transitive)
- Removedgot@11.8.6(transitive)
- Removedgulp-print@5.0.2(transitive)
- Removedhttp-cache-semantics@4.1.1(transitive)
- Removedhttp2-wrapper@1.0.3(transitive)
- Removedinherits@2.0.4(transitive)
- Removedinterpret@2.2.0(transitive)
- Removedis-plain-object@3.0.1(transitive)
- Removedisarray@1.0.0(transitive)
- Removedjson-buffer@3.0.1(transitive)
- Removedkeyv@4.5.4(transitive)
- Removedlowercase-keys@2.0.0(transitive)
- Removedmap-stream@0.0.7(transitive)
- Removedmimic-response@1.0.13.1.0(transitive)
- Removednode-fetch@2.7.0(transitive)
- Removednormalize-url@6.1.0(transitive)
- Removedonce@1.4.0(transitive)
- Removedp-cancelable@2.1.1(transitive)
- Removedparse-node-version@1.0.1(transitive)
- Removedprocess-nextick-args@2.0.1(transitive)
- Removedpump@3.0.2(transitive)
- Removedquick-lru@5.1.1(transitive)
- Removedreadable-stream@2.3.8(transitive)
- Removedrechoir@0.7.1(transitive)
- Removedremove-trailing-separator@1.1.0(transitive)
- Removedreplace-ext@1.0.1(transitive)
- Removedresolve-alpn@1.2.1(transitive)
- Removedresponselike@2.0.1(transitive)
- Removedsafe-buffer@5.1.2(transitive)
- Removedstring_decoder@1.1.1(transitive)
- Removedtime-stamp@1.1.0(transitive)
- Removedtr46@0.0.3(transitive)
- Removedurl-template@2.0.8(transitive)
- Removedutil-deprecate@1.0.2(transitive)
- Removedvinyl@2.2.1(transitive)
- Removedwebidl-conversions@3.0.1(transitive)
- Removedwebpack-cli@4.10.0(transitive)
- Removedwhatwg-url@5.0.0(transitive)
- Removedwrappy@1.0.2(transitive)
Updated@ribajs/cache@^2.0.0-beta.1
Updated@ribajs/core@^2.0.0-beta.1
Updated@ribajs/events@^2.0.0-beta.1
Updated@ribajs/i18n@^2.0.0-beta.1
Updated@ribajs/router@^2.0.0-beta.1
Updated@ribajs/utils@^2.0.0-beta.1
Updatedwebpack-cli@^5.0.1