You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 23, 2024. It is now read-only.

These are shared components used in WooCommerce blocks, and may be used in the store front end (shopper experience) as well as the editor or admin dashboard.
3
+
These are shared components used in WooCommerce blocks, and may be used in the store front end (shopper experience) as well as the editor or admin dashboard.
4
4
5
-
See [_Components & Storybook_](docs/contributors/storybook.md) doc for more information.
5
+
See [_Components & Storybook_](../../../../docs/contributors/contributing/storybook-and-components.md) doc for more information.
Copy file name to clipboardExpand all lines: assets/js/editor-components/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ These are shared components used in WooCommerce blocks for the editor (Gutenberg
4
4
5
5
Many of our blocks need rich, smart components to provide an interface for selecting or configuring blocks with WooCommerce data. Often there are multiple blocks that need such components. Components in this collection are used in multiple blocks, and may include logic for working with Woo data specifically (e.g. products, shipping methods, product categories).
6
6
7
-
See [Storybook & Components](docs/contributors/storybook.md) doc for more information.
7
+
See [Storybook & Components](../../../docs/contributors/contributing/storybook-and-components.md) doc for more information.
Copy file name to clipboardExpand all lines: docs/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -146,7 +146,7 @@ The following tutorials from [developer.woocommerce.com](https://developer.wooco
146
146
147
147
[We're hiring!](https://woocommerce.com/careers/) Come work with us!
148
148
149
-
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/readme.md)
149
+
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/README.md)
Copy file name to clipboardExpand all lines: docs/contributors/components.md
+5-7Lines changed: 5 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,17 +2,15 @@
2
2
3
3
This repo includes [Storybook](https://storybook.js.org) tooling so we can test and develop components in isolation.
4
4
5
-
The storybook is automatically built and published to [GitHub pages](https://woocommerce.github.io/woocommerce-gutenberg-products-block/) on every push to the main branch. See [travis.yml](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/trunk/.travis.yml) for details.
The storybook is automatically built and published to [GitHub pages](https://woocommerce.github.io/woocommerce-blocks/) on every push to the main branch.
8
6
9
7
## Where are our components?
10
8
11
9
We have components in a few folders, for different contexts.
**`assets/js/base/components`** are used in front-end code, as well as editor & admin.
18
16
These components help us build consistent interfaces across the front end (shopper) experience and elsewhere.
@@ -27,7 +25,7 @@ They allow us to build a consistent and powerful UI for merchants for authoring
27
25
28
26
**`assets/js/icons`** is a suite of icons and SVG images that we use in our interfaces.
29
27
30
-
For more info about individual components, refer to [Storybook](https://woocommerce.github.io/woocommerce-gutenberg-products-block/) or individual readme files.
28
+
For more info about individual components, refer to [Storybook](https://woocommerce.github.io/woocommerce-blocks/) or individual readme files.
31
29
32
30
## How to run Storybook locally and test components
-[Building the plugin files](#building-the-plugin-files)
9
+
-[Legacy builds](#legacy-builds)
10
+
-[Create a plugin package in ZIP format](#create-a-plugin-package-in-zip-format)
11
+
-[Linting](#linting)
12
+
-[Running the Blocks plugin](#running-the-blocks-plugin)
13
+
-[Developer Tools (Visual Studio Code)](#developer-tools-visual-studio-code)
14
+
-[EditorConfig](#editorconfig)
15
+
-[ESLint](#eslint)
16
+
-[Prettier](#prettier)
17
+
-[Testing](#testing)
18
18
19
19
Before you can begin contributing to the Blocks plugin there are several steps and tools required to setup your local development environment.
20
20
@@ -52,7 +52,7 @@ To install dependencies, you will need the following tools installed on your mac
52
52
-[`npm` and `node.js`](https://nodejs.org)
53
53
-[`composer`](https://getcomposer.org)
54
54
55
-
See [`package.json``engines`](../../package.json) for details of required versions.
55
+
See [`package.json``engines`](../../../package.json) for details of required versions.
56
56
57
57
Once you have `node` and `composer` setup, install the dependencies from the command line:
58
58
@@ -79,7 +79,7 @@ This plugin supports two type of builds:
79
79
80
80
The legacy builds are loaded in a site environment where the WordPress version doesn't meet minimum requirements for a component used in a set build.
81
81
82
-
You can read more about legacy builds in the [this doc](./assets/js/legacy/README.md).
82
+
You can read more about legacy builds in the [this doc](../../../assets/js/legacy/README.md).
83
83
84
84
## Create a plugin package in ZIP format
85
85
@@ -96,9 +96,9 @@ Run `$ npm run lint` to check code against our linting rules.
96
96
97
97
This script runs 3 sub-commands: `lint:php`, `lint:css`, `lint:js`. Use these to run linters across the codebase (linters check for valid syntax).
98
98
99
-
-`lint:php` runs phpcs via composer, which uses the [phpcs.xml](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/trunk/phpcs.xml) rule set.
100
-
-`lint:css` runs stylelint over all the scss code in `assets/css`, using the rules in [.stylelintrc.json.](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/trunk/.stylelintrc.json)
101
-
-`lint:js` runs eslint over all the JavaScript, using the rules in [.eslintrc.js.](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/trunk/.eslintrc.js)
99
+
-`lint:php` runs phpcs via composer, which uses the [phpcs.xml](../../../phpcs.xml) rule set.
100
+
-`lint:css` runs stylelint over all the scss code in `assets/css`, using the rules in [.stylelintrc.json.](../../../.stylelintrc.json)
101
+
-`lint:js` runs eslint over all the JavaScript, using the rules in [.eslintrc.js.](../../../.eslintrc.js)
102
102
103
103
Note; linters are also ran before commits via Git. If there are any violations, you will not be able to commit your changes until they are fixed, unless you add the `--no-verify` flag to your commit command.
104
104
@@ -148,7 +148,7 @@ You’ll find a handful of scripts in `package.json` that performs the automated
148
148
- JS tests: `npm run test`
149
149
- Run `npm run wp-env` command to setup the development environment in Docker.
150
150
151
-
To find out more about how to run automated JavaScript tests, check out the documentation on [JavaScript Testing](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/trunk/docs/contributors/javascript-testing.md).
151
+
To find out more about how to run automated JavaScript tests, check out the documentation on [JavaScript Testing](../../contributors/contributing/javascript-testing.md).
0 commit comments